#2562 closed defect (fixed)

RSB Docs Quick Start version number

Reported by: Gedare Bloom Owned by: Gedare Bloom
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 11/18/18 at 14:21:31.
0001-Added-version-nembers-guidelines-and-output-to-comma.patch (9.8 KB) - added by shashvat jain on 11/21/18 at 17:00:26.
New patch
0001-Closes-Ticket-2562.patch (9.8 KB) - added by shashvat jain on 11/21/18 at 17:43:30.
docs: add version number guidelines and quick start output , this patch closes this ticket.

Download all attachments as: .zip

Change History (11)

comment:1 Changed on 05/11/17 at 07:31:02 by Sebastian Huber

Milestone: 4.124.12.0

comment:2 Changed on 11/09/17 at 06:27:14 by Sebastian Huber

Milestone: 4.12.05.1

Milestone renamed

comment:3 Changed on 10/14/18 at 00:50:11 by Chris Johns

Owner: changed from Chris Johns to Gedare Bloom
Status: newassigned

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

comment:4 Changed on 11/18/18 at 14:04:04 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 11/18/18 at 14:23:22 by shashvat jain (previous) (diff)

comment:5 Changed on 11/18/18 at 21:36:07 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 11/21/18 at 08:59:13 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 11/21/18 at 17:43:30 by shashvat jain

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

comment:7 Changed on 12/13/19 at 15:36:10 by Chris Johns

Is this in the documentation? I cannot see it in the user of eng manuals.

comment:8 Changed on 04/02/20 at 15:36:38 by Gedare Bloom <gedare@…>

Resolution: fixed
Status: assignedclosed

In 7a0834d/rtems-docs:

start/user: describe version numbers and releases

Closes #2562.

Note: See TracTickets for help on using tickets.