Opened on 10/23/20 at 12:37:13

Closed on 05/24/21 at 14:16:01

#4163 closed defect (fixed)

Error in documentation regarding C/C++ large comment styles

Reported by: Andrew Butterfield Owned by: Andrew Butterfield
Priority: normal Milestone:
Component: doc Version: 5
Severity: normal Keywords:
Cc: Blocked By:
Blocking:

Description

In the RTEMS Software Engineering manual, Sec 6.3.2.1

​https://docs.rtems.org/branches/master/eng/coding-80cols.html#breaking-long-lines

it recommends excessively long comments be broken as follows:

/* first line
 * second line
 * third, and in this case last line */

After a discussion on the devel mailing list at

​https://lists.rtems.org/pipermail/devel/2020-October/062906.html

it was agreed that it should be

/*
 * first line
 * second line
 * third line (no longer matters that it is last)
 */

Change History (2)

comment:1 Changed on 10/23/20 at 12:38:55 by Andrew Butterfield

Owner: set to Andrew Butterfield
Status: new → accepted

comment:2 Changed on 05/24/21 at 14:16:01 by Andrew Butterfield

Resolution: → fixed
Status: accepted → closed

Was fixed by Sebastian Huber when he tidied up the documentation.

There has also been a filename change:

See ​https://docs.rtems.org/branches/master/eng/coding-formatting.html

Note: See TracTickets for help on using tickets.