diff options
author | Joel Sherrill <joel@rtems.org> | 2018-11-29 15:49:13 -0600 |
---|---|---|
committer | Joel Sherrill <joel@rtems.org> | 2018-12-09 17:06:04 -0600 |
commit | f2fef3f309915ae389d75f835ade86db05bd78ec (patch) | |
tree | 163c1d08ed82ac72de769ad4cd620b2ef598451e | |
parent | f1a5c56f4b05a86cc3df30fa997adbf38363271c (diff) |
More updates to reflect GCI tasks
-rw-r--r-- | eng/change-management.rst | 4 | ||||
-rw-r--r-- | eng/change-reports.rst | 3 | ||||
-rw-r--r-- | eng/coding-80cols.rst | 10 | ||||
-rw-r--r-- | eng/coding-conventions.rst | 11 | ||||
-rw-r--r-- | eng/coding-deprecating.rst | 11 | ||||
-rw-r--r-- | eng/coding-doxygen-bsp.rst | 10 | ||||
-rw-r--r-- | eng/coding-doxygen.rst | 10 | ||||
-rw-r--r-- | eng/coding-file-hdr.rst | 10 | ||||
-rw-r--r-- | eng/coding-gen-patch.rst | 10 | ||||
-rw-r--r-- | eng/coding-naming.rst | 10 | ||||
-rw-r--r-- | eng/coding.rst | 16 | ||||
-rw-r--r-- | eng/issue-tracking.rst | 9 | ||||
-rw-r--r-- | eng/license-requirements.rst | 11 | ||||
-rw-r--r-- | eng/management.rst | 3 | ||||
-rw-r--r-- | eng/stakeholders.rst | 10 | ||||
-rw-r--r-- | eng/test-plan.rst | 2 | ||||
-rw-r--r-- | eng/test-suites.rst | 3 | ||||
-rw-r--r-- | eng/tester.rst | 2 | ||||
-rw-r--r-- | eng/vdd-generation.rst | 6 |
19 files changed, 133 insertions, 18 deletions
diff --git a/eng/change-management.rst b/eng/change-management.rst index add8d00..3e6d30a 100644 --- a/eng/change-management.rst +++ b/eng/change-management.rst @@ -3,7 +3,7 @@ .. COMMENT: COPYRIGHT (c) 2018. .. COMMENT: RTEMS Foundation, The RTEMS Documentation Project -Change Manaegment +Change Management ***************** Major decisions about RTEMS are made by the core developers in concert @@ -11,4 +11,4 @@ with the user community, guided by the Mission Statement. We provide access to our development sources via a Git Repository (see these Instructions for details). -TBD - ??? what in the Wiki +TBD - ??? what in the Wiki could go here diff --git a/eng/change-reports.rst b/eng/change-reports.rst index bffb9ae..841bd04 100644 --- a/eng/change-reports.rst +++ b/eng/change-reports.rst @@ -7,5 +7,4 @@ Software Change Report Generation ********************************* -– Review process, workflows, etc -TBD convert from https://devel.rtems.org/wiki/Release +TBD - What goes here? diff --git a/eng/coding-80cols.rst b/eng/coding-80cols.rst new file mode 100644 index 0000000..442a9e0 --- /dev/null +++ b/eng/coding-80cols.rst @@ -0,0 +1,10 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +Eighty Character Line Limit +*************************** + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/80_characters_per_line diff --git a/eng/coding-conventions.rst b/eng/coding-conventions.rst new file mode 100644 index 0000000..654b5bb --- /dev/null +++ b/eng/coding-conventions.rst @@ -0,0 +1,11 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +Coding Conventions +****************** + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/Conventions + diff --git a/eng/coding-deprecating.rst b/eng/coding-deprecating.rst new file mode 100644 index 0000000..4ca4c7c --- /dev/null +++ b/eng/coding-deprecating.rst @@ -0,0 +1,11 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +Deprectating Interfaces +*********************** + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/Deprecating + diff --git a/eng/coding-doxygen-bsp.rst b/eng/coding-doxygen-bsp.rst new file mode 100644 index 0000000..e6f73d0 --- /dev/null +++ b/eng/coding-doxygen-bsp.rst @@ -0,0 +1,10 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +BSP Doxygen Recommentations +=========================== + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/Doxygen_for_BSPs diff --git a/eng/coding-doxygen.rst b/eng/coding-doxygen.rst new file mode 100644 index 0000000..5aafde0 --- /dev/null +++ b/eng/coding-doxygen.rst @@ -0,0 +1,10 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +General Doxygen Recommentations +=============================== + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/Doxygen diff --git a/eng/coding-file-hdr.rst b/eng/coding-file-hdr.rst new file mode 100644 index 0000000..67c177f --- /dev/null +++ b/eng/coding-file-hdr.rst @@ -0,0 +1,10 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +Boilerplate File Header +*********************** + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header diff --git a/eng/coding-gen-patch.rst b/eng/coding-gen-patch.rst new file mode 100644 index 0000000..d4e05da --- /dev/null +++ b/eng/coding-gen-patch.rst @@ -0,0 +1,10 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +Generating a Tools Patch +************************ + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/GenerateAPatch diff --git a/eng/coding-naming.rst b/eng/coding-naming.rst new file mode 100644 index 0000000..054dd5d --- /dev/null +++ b/eng/coding-naming.rst @@ -0,0 +1,10 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 2018. +.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project + +Naming Rules +************ + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/NamingRules diff --git a/eng/coding.rst b/eng/coding.rst index 0af9c78..14223ba 100644 --- a/eng/coding.rst +++ b/eng/coding.rst @@ -6,6 +6,16 @@ Coding Standards **************** -TBD - Convert the following to Rest and insert into this file -TBD - https://devel.rtems.org/wiki/Developer/Coding/Conventions -TBD - https://devel.rtems.org/wiki/Developer/Coding +TBD - Write introduction, re-order, identify missing content + +.. COMMENT: Subsections +.. toctree:: + + coding-conventions + coding-80cols + coding-deprecating + coding-doxygen-bsp + coding-doxygen + coding-file-hdr + coding-gen-patch + coding-naming diff --git a/eng/issue-tracking.rst b/eng/issue-tracking.rst index 680d7bd..83c76c8 100644 --- a/eng/issue-tracking.rst +++ b/eng/issue-tracking.rst @@ -6,8 +6,17 @@ Issue Tracking ************** +TBD Review process, workflows, etc + TBD - This covers Issue Tracking and Trac usage Need instructions which weave useful URLs including ones like these https://devel.rtems.org/query https://devel.rtems.org/wiki/NewTicket +Filing a Change Request or Problem Report +========================================= + +The RTEMS Project uses Trac to manage all change requests and problem reports +and refers to either as a ticket. Ticket may be filed or viewed at +https://devel.rtems.org/wiki/Release + diff --git a/eng/license-requirements.rst b/eng/license-requirements.rst index 06934b1..90a5409 100644 --- a/eng/license-requirements.rst +++ b/eng/license-requirements.rst @@ -11,6 +11,13 @@ All artifacts shall adhere to RTEMS Project licensing requirements. Currently, the preferred licenses are CC-BY-SA-4.0 license for documentation and “Two Paragraph BSD” for source code. -• https://devel.rtems.org/wiki/Developer/Coding/Conventions#Licenses +Historically, RTEMS has been licensed under the GPL v2 with linking +exception (https://www.rtems.org/license). It is preferred that new +submissions be under one of the two preferred licenses. If you have +previously submitted code to RTEMS under a historical license, please +grant the project permission to relicense. See +https://devel.rtems.org/ticket/3053 for details. + +TBD - Convert the following to Rest and insert into this file +TBD - https://devel.rtems.org/wiki/Developer/Coding/Conventions#Licenses -• https://www.rtems.org/license diff --git a/eng/management.rst b/eng/management.rst index 6494819..2b03dee 100644 --- a/eng/management.rst +++ b/eng/management.rst @@ -10,9 +10,6 @@ Software Development Management TBD - Convert https://devel.rtems.org/wiki/TBR/Website/WhyContribute to Rest TBD - and insert here - - - .. COMMENT: Subsections .. toctree:: diff --git a/eng/stakeholders.rst b/eng/stakeholders.rst index 5046269..51bd125 100644 --- a/eng/stakeholders.rst +++ b/eng/stakeholders.rst @@ -3,8 +3,16 @@ .. COMMENT: COPYRIGHT (c) 2018. .. COMMENT: RTEMS Foundation, The RTEMS Documentation Project +RTEMS Stakeholders +****************** + +RTEMS is a community based open source project. All users are treated +as stakeholders. It is hoped that as stakeholders, users will contribute +to the project, sponsor core developers, and help fund the infrastructure +required to host and manage the project. + Qualification - Stakeholder Involvement -*************************************** +======================================= Qualification of RTEMS is a specialized activity and only specific users of RTEMS will complete a formal qualification activity. The RTEMS Project diff --git a/eng/test-plan.rst b/eng/test-plan.rst index 43ec69f..d1320a6 100644 --- a/eng/test-plan.rst +++ b/eng/test-plan.rst @@ -35,8 +35,6 @@ RTEMS Tools Project: https://github.com/RTEMS/rtems-tools Scope, Procedures, Methodologies, Tools TBD - Write content - - .. COMMENT: Subsections .. toctree:: diff --git a/eng/test-suites.rst b/eng/test-suites.rst index a076fbe..1380ee8 100644 --- a/eng/test-suites.rst +++ b/eng/test-suites.rst @@ -6,5 +6,8 @@ Test Suites *********** +TBD - Convert the following to Rest and insert into this file TBD from https://devel.rtems.org/wiki/Developer/Testing/TestSuites +TBD also update list of tests based on rtems/testsuites + diff --git a/eng/tester.rst b/eng/tester.rst index 5f12802..97893aa 100644 --- a/eng/tester.rst +++ b/eng/tester.rst @@ -6,5 +6,7 @@ RTEMS Tester ************ +TBD - Convert the following to Rest and insert into this file TBD https://devel.rtems.org/wiki/Testing/Tester +TBD - Above file is horribly out of date. Find new docs and refer to them diff --git a/eng/vdd-generation.rst b/eng/vdd-generation.rst index 28b891c..905554b 100644 --- a/eng/vdd-generation.rst +++ b/eng/vdd-generation.rst @@ -7,7 +7,7 @@ Version Description Document (VDD) Generation ********************************************* -TBD - probably Dannie's project +TBD - discuss how generated. Preferably Dannie's project -This URL may be of use but it probably Trac auto-generated and not -useful for this purpose: https://devel.rtems.org/wiki/TracChangeLog +This URL may be of use but it probably Trac auto-generated and can +only be referenced: https://devel.rtems.org/wiki/TracChangeLog |