[RTEMS Project] #2986: Convert Coding Style to Sphinx Document

[RTEMS trac]

#2986: Convert Coding Style to Sphinx Document
---------------------------+-------------------------
 Reporter:  Joel Sherrill  |       Owner:  chrisj@…
     Type:  enhancement    |      Status:  reopened
 Priority:  normal         |   Milestone:  Indefinite
Component:  doc            |     Version:  5
 Severity:  normal         |  Resolution:
 Keywords:                 |  Blocked By:
 Blocking:                 |
---------------------------+-------------------------
Description changed by Joel Sherrill:

Old description:

> The RTEMS Coding Style should be in a Sphinx document so it is included
> in the formal documentation set. This is a document expected for
> certification and qualification efforts.
>
> There are still various pages in the wiki which can be found by using
> this search URL which require merging into the Software Engineering Guide
> or otherwise updating.
>
> https://devel.rtems.org/search?q=Developer%2FCoding&noquickjump=1&wiki=on
>
> All Doxygen guidance should be in the Guide. GCI instructions may remain
> in the wiki.
> Was at wiki Developer Coding Conventions. Now at
> https://docs.rtems.org/branches/master/eng/coding-conventions.html

New description:

 The RTEMS Coding Style should be in a Sphinx document so it is included in
 the formal documentation set. This is a document expected for
 certification and qualification efforts.

 There are still various pages in the wiki which can be found by using this
 search URL which require merging into the Software Engineering Guide or
 otherwise updating.

 https://devel.rtems.org/search?q=Developer%2FCoding&noquickjump=1&wiki=on

 All Doxygen guidance should be in the Guide. GCI instructions may remain
 in the wiki.
 Was at wiki Developer Coding Conventions. Now at
 https://docs.rtems.org/branches/master/eng/coding-conventions.html

 As a specific starting point,
 https://devel.rtems.org/wiki/Developer/Coding/Doxygen needs further review
  against the Doxygen Guidelines at
  https://docs.rtems.org/branches/master/eng/coding-doxygen.html#.

--

--
Ticket URL: <http://devel.rtems.org/ticket/2986#comment:7>
RTEMS Project <http://www.rtems.org/>
RTEMS Project