![[RTEMS Logo]](/images/logo.png){kind=logo}
Opened on 04/07/17 at 15:17:30
Last modified on 06/18/21 at 09:24:45
#2986 reopened enhancement
Convert Coding Style to Sphinx Document
| Reported by: | Joel Sherrill | Owned by: | chrisj@… |
|---|---|---|---|
| Priority: | normal | Milestone: | Indefinite |
| Component: | doc | Version: | 5 |
| Severity: | normal | Keywords: | small, tasks, qualification |
| Cc: | Blocked By: | ||
| Blocking: |
Description (last modified by Joel Sherrill)
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#.
Change History (9)
comment:1 Changed on 04/09/17 at 00:22:44 by Chris Johns
| Milestone: | 4.12 → 4.12.0 |
|---|
comment:2 Changed on 06/08/17 at 07:49:06 by Sebastian Huber
| Milestone: | 4.12.0 → Indefinite |
|---|
comment:3 Changed on 10/10/17 at 06:06:29 by Sebastian Huber
| Component: | Documentation → doc |
|---|
comment:4 Changed on 04/30/20 at 22:05:19 by Joel Sherrill
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
The text in the Wiki page is now in the Software Engineering Guide. See https://docs.rtems.org/branches/master/eng/coding-conventions.html
comment:5 Changed on 04/30/20 at 22:07:12 by Joel Sherrill
| Description: | modified (diff) |
|---|
comment:6 Changed on 05/01/20 at 13:05:12 by Joel Sherrill
| Description: | modified (diff) |
|---|---|
| Resolution: | fixed |
| Status: | closed → reopened |
Reopening since more Doxygen advice/guidance found.
comment:7 Changed on 05/01/20 at 13:06:22 by Joel Sherrill
| Description: | modified (diff) |
|---|
comment:8 Changed on 05/01/20 at 13:07:02 by Joel Sherrill
| Keywords: | small tasks added |
|---|
comment:9 Changed on 06/18/21 at 09:24:45 by Sebastian Huber
| Keywords: | qualification added |
|---|
I think we need a document that contains all the processes and procedures for the project. There are a number of elements we have that need to be formalised and documented.
What should we call this document, "RTEMS Project Development Procedures"?