#2562 assigned defect

RSB Docs Quick Start version number

Reported by: Gedare Owned by: Gedare
Priority: normal Milestone: 5.1
Component: tool/rsb Version: 5
Severity: normal Keywords: documentation
Cc: Blocked By:
Blocking:

Description

The quick start in the RSB docs only refers to version 4.11 in the examples. It may be worth a brief paragraph about RTEMS version numbers here to help orient new users since, if they follow these directions, they will not be able to build the master.

Attachments (3)

0001-version-number-notation-Ticket-2562-GCI-2018.patch (11.3 KB) - added by shashvat jain on Nov 18, 2018 at 2:21:31 PM.
0001-Added-version-nembers-guidelines-and-output-to-comma.patch (9.8 KB) - added by shashvat jain on Nov 21, 2018 at 5:00:26 PM.
New patch
0001-Closes-Ticket-2562.patch (9.8 KB) - added by shashvat jain on Nov 21, 2018 at 5:43:30 PM.
docs: add version number guidelines and quick start output , this patch closes this ticket.

Download all attachments as: .zip

Change History (9)

comment:1 Changed on May 11, 2017 at 7:31:02 AM by Sebastian Huber

Milestone: 4.124.12.0

comment:2 Changed on Nov 9, 2017 at 6:27:14 AM by Sebastian Huber

Milestone: 4.12.05.1

Milestone renamed

comment:3 Changed on Oct 14, 2018 at 12:50:11 AM by Chris Johns

Owner: changed from Chris Johns to Gedare
Status: newassigned

That would be nice to have. Please update once Joel pushes his changes to the Quick Start. Thanks.

comment:4 Changed on Nov 18, 2018 at 2:04:04 PM by shashvat jain

I generalized the release version of RTEMS with "urversion" in rtems-docs/rsb
and rtems-docs/user ,and specified a paragraph regarding the same below the commands.
I also made a table in the Quick Start and rsb/project-sets page which displays the
released versions and their status.
here is the details of the table

release notes status
5 development
4.11 current release
4.10 previous release

here is what the note says

"In the above commands and all commands on this page, urversion gives the version
of RTEMS you are building or want to build. Replace it with reference to release version table on *projects sets* page ."

The patch with all changes made has been added to the attachments

Last edited on Nov 18, 2018 at 2:23:22 PM by shashvat jain (previous) (diff)

comment:5 Changed on Nov 18, 2018 at 9:36:07 PM by Chris Johns

The user manual is for a single release. I think it would be confusing to mention others releases or to make the manual appear suitable for other releases. For example the manual has command lines for tools which vary between releases and so it will not be correct for at least one release.

May I suggest you run the commands listed and update the output for RTEMS 5.

comment:6 Changed on Nov 21, 2018 at 8:59:13 AM by shashvat jain

I have added a paragraph about version numbers in the quick start and updated the outputs of the commands at quick start
I am unable to give the patch file because of spam message,please help me with this.

Changed on Nov 21, 2018 at 5:43:30 PM by shashvat jain

docs: add version number guidelines and quick start output , this patch closes this ticket.

Note: See TracTickets for help on using tickets.