First cut

24 files changed, 275 insertions, 15 deletions

diff --git a/software-engineering-handbook/README b/eng/README
index 5897350..5897350 100644
--- a/software-engineering-handbook/README
+++ b/eng/README
diff --git a/eng/appendix-a.rst b/eng/appendix-a.rst
new file mode 100644
index 0000000..dfc141f
--- /dev/null
+++ b/eng/appendix-a.rst
@@ -0,0 +1,83 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT (c) 2018.
+.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+
+
+Appendix: Core Qualification Artifacts/Documents
+************************************************
+
+An effort at NASA has been performed to suggest a core set of artifacts
+(as defined by BOTH NASA NPR 7150.2B and DO-178B) that can be utilized
+by a mission as a baselined starting point for “pre-qualification”
+for (open-source) software that is intended to be utilized for flight
+purposes.  This effort analyzed the overlap between NPR 7150.2B
+and DO-178B and highlighted a core set of artifacts to serve as a
+starting point for any open-source project.  These artifacts were also
+cross-referenced with similar activities for other NASA flight software
+qualification efforts, such as the open-source Core Flight System (cFS).
+Along with the specific artifact, the intent of the artifact was also
+captured; in some cases open-source projects, such as RTEMS, are already
+meeting the intent of the artifacts with information simply needing
+organized and formalized.  The table below lists the general category,
+artifact name, and its intent.  Please note that this table does NOT
+represent all the required artifacts for qualification per the standards;
+instead, this table represents a subset of the most basic/core artifacts
+that form a strong foundation for a software engineering qualification
+effort.
+
+TBD convert to a table; see original PDF for guidance on desired look
+
+=============================================
+Table 1. Core Qualification Artifacts
+
+Category	Artifact	Intent
+Requirements	Software Requirements Specification (SRS)
+
+Requirements Management	The project shall document the software requirements.
+ 
+The project shall collect and manage changes to the software requirements.
+ 
+The project shall identify, initiate corrective actions, and track until closure inconsistencies among requirements, project plans, and software products.
+	Requirements Test and Traceability Matrix	The project shall perform, document, and maintain bidirectional traceability between the software requirement and the higher-level requirement.
+	Validation	The project shall perform requirements validation to ensure that the software will perform as intended in the customer environment.
+ 
+ 	 	 
+Design and Implementation	Software Development or Management Plan	A plan for how you will develop the software that you are intent upon developing and delivering.
+ 
+The Software Development Plan includes the objectives, standards and life cycle(s) to be used in the software development process. This plan should include: Standards: Identification of the Software Requirements Standards, Software Design Standards, and Software Code Standards for the project.
+ 
+	Software Configuration Management Plan	To identify and control major software changes, ensure that change is being properly implemented, and report changes to any other personnel or clients who may have an interest.
+ 
+	Implementation	The project shall implement the software design into software code.
+ 
+Executable Code to applicable tested software.
+ 
+	Coding Standards Report	The project shall ensure that software coding methods, standards, and/or criteria are adhered to and verified.
+	Version Description Document (VDD)	The project shall provide a Software Version Description document for each software release.
+ 	 	 
+Testing and Software Assurance Activities	Software Test Plan	Document describing the testing scope and activities.
+	Software Assurance/Testing Procedures
+ 	To define the techniques, procedures, and methodologies that will be used.
+ 
+	Software Change Report / Problem Report	The project shall regularly hold reviews of software activities, status, and results with the project stakeholders and track issues to resolution.
+ 
+	Software Schedule	Milestones have schedule and schedule is updated accordingly.
+ 
+	Software Test Report / Verification Results	The project shall record, address, and track to closure the results of software verification activities.
+ 
+Problem report - Describes the process non-compliance with plans, output deficiency, or software anomalous behavior, and the corrective action taken.
+ 
+The project shall ensure that the software code is unit tested per the plans for software testing.
+ 
+ 	 	 
+Usability	Software User’s Manual	The Software User Manual defines user instructions for the software.
+=============================================
+
+In an effort to remain lightweight and sustainable for open-source
+projects, Table 1 above was condensed into a single artifact outline
+that encompasses the artifacts’ intents.  The idea is that this living
+qualification document will reside under RTEMS source control and be
+updated with additional detail accordingly.  The artifact outline is
+as follows:
+
diff --git a/software-engineering-handbook/change-management.rst b/eng/change-management.rst
index ff04675..add8d00 100644
--- a/software-engineering-handbook/change-management.rst
+++ b/eng/change-management.rst
@@ -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 - ???
+TBD - ??? what in the Wiki
diff --git a/eng/change-reports.rst b/eng/change-reports.rst
new file mode 100644
index 0000000..bffb9ae
--- /dev/null
+++ b/eng/change-reports.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
+
+
+Software Change Report Generation
+*********************************
+
+– Review process, workflows, etc
+TBD convert from https://devel.rtems.org/wiki/Release
diff --git a/software-engineering-handbook/coding-standards.rst b/eng/coding.rst
index 0af9c78..0af9c78 100644
--- a/software-engineering-handbook/coding-standards.rst
+++ b/eng/coding.rst
diff --git a/software-engineering-handbook/conf.py b/eng/conf.py
index a4da3ff..a4da3ff 100644
--- a/software-engineering-handbook/conf.py
+++ b/eng/conf.py
diff --git a/software-engineering-handbook/index.rst b/eng/index.rst
index 224e46a..5fe93d4 100644
--- a/software-engineering-handbook/index.rst
+++ b/eng/index.rst
@@ -49,7 +49,11 @@ to the Community Project hosted at http://www.rtems.org/.
 	preface
         prequalification
         stakeholders
-        software-development-management
+        management
+        release-mgmt
+        users-manuals
+        license-requirements
+        appendix-a
 	function_and_variable
 	concept
 
diff --git a/software-engineering-handbook/issue-tracking.rst b/eng/issue-tracking.rst
index 47ec03a..680d7bd 100644
--- a/software-engineering-handbook/issue-tracking.rst
+++ b/eng/issue-tracking.rst
@@ -6,13 +6,8 @@
 Issue Tracking
 **************
 
-This section discussions Trac usage and tickets.
-
-Related URLs to review for conversion to this document
-
+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
-https://devel.rtems.org/wiki/Developer/Bug_Reporting
 
-Querying existing tickets (keep as a link)
-
-https://devel.rtems.org/query
diff --git a/eng/license-requirements.rst b/eng/license-requirements.rst
new file mode 100644
index 0000000..06934b1
--- /dev/null
+++ b/eng/license-requirements.rst
@@ -0,0 +1,16 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT (c) 2018.
+.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+
+
+Licensing Requirements
+**********************
+
+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
+
+•	https://www.rtems.org/license
diff --git a/software-engineering-handbook/software-development-management.rst b/eng/management.rst
index f10349a..3ed36d4 100644
--- a/software-engineering-handbook/software-development-management.rst
+++ b/eng/management.rst
@@ -16,7 +16,8 @@ TBD - and insert here
 .. COMMENT: Subsections
 .. toctree::
 
-    software-development-git-users
-    coding-standards
+    vc-users
+    vc-writers
+    coding
     change-management
     issue-tracking
diff --git a/software-engineering-handbook/preface.rst b/eng/preface.rst
index 81b16df..562f61f 100644
--- a/software-engineering-handbook/preface.rst
+++ b/eng/preface.rst
@@ -23,4 +23,7 @@ languages.
   and ease porting other packages to the RTEMS environment. Source:
   https://devel.rtems.org/wiki/Mission_Statement
 
-The RTEMS development effort uses an open development environment in which all users collaborate to improve RTEMS. The RTEMS cross development toolset is based upon the free GNU tools and the open source C Library newlib. RTEMS supports many host platforms and target architectures.
+The RTEMS development effort uses an open development environment in
+which all users collaborate to improve RTEMS. The RTEMS cross development
+toolset is based upon the free GNU tools and the open source C Library
+newlib. RTEMS supports many host platforms and target architectures.
diff --git a/software-engineering-handbook/prequalification.rst b/eng/prequalification.rst
index 5234dbf..4055f70 100644
--- a/software-engineering-handbook/prequalification.rst
+++ b/eng/prequalification.rst
@@ -46,7 +46,19 @@ will provide the services required to tailor the master information,
 perform testing on specific system hardware, and to guide end users in
 using the master technical data in the context of a particular standard.
 
-The RTEMS Qualification Project will broadly address two areas. The first area is suggesting areas of improvement for automated project infrastructure and the master technical data that has traditionally been provided by the RTEMS Project. For example, the RTEMS Qualification could suggest specific improvements to code coverage reports. The teams focused on qualification should be able to provide resources for improving the automated project infrastructure and master technical data for RTEMS. The term “resources” is often used by open source projects to refer to volunteer code contributions or funding. Although code contributions in this area are important and always welcome, funding is also important. At a minimum, ongoing funding is needed for maintenance and upgrades of the RTEMS Project server infrastructure, addition of services to those servers, and core contributors to review submissions
+The RTEMS Qualification Project will broadly address two areas. The
+first area is suggesting areas of improvement for automated project
+infrastructure and the master technical data that has traditionally been
+provided by the RTEMS Project. For example, the RTEMS Qualification could
+suggest specific improvements to code coverage reports. The teams focused
+on qualification should be able to provide resources for improving the
+automated project infrastructure and master technical data for RTEMS. The
+term “resources” is often used by open source projects to refer to
+volunteer code contributions or funding. Although code contributions in
+this area are important and always welcome, funding is also important. At
+a minimum, ongoing funding is needed for maintenance and upgrades of
+the RTEMS Project server infrastructure, addition of services to those
+servers, and core contributors to review submissions
 
 The second area is the creation and maintenance of master technical
 data that has traditionally not been owned or maintained by the RTEMS
diff --git a/eng/release-mgmt.rst b/eng/release-mgmt.rst
new file mode 100644
index 0000000..276440c
--- /dev/null
+++ b/eng/release-mgmt.rst
@@ -0,0 +1,17 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT (c) 2018.
+.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+
+
+Software Release Management
+***************************
+
+TBD write content
+
+
+.. COMMENT: Subsections
+.. toctree::
+
+    change-reports
+    vdd-generation
diff --git a/software-engineering-handbook/stakeholders.rst b/eng/stakeholders.rst
index 5046269..5046269 100644
--- a/software-engineering-handbook/stakeholders.rst
+++ b/eng/stakeholders.rst
diff --git a/eng/test-plan.rst b/eng/test-plan.rst
new file mode 100644
index 0000000..43ec69f
--- /dev/null
+++ b/eng/test-plan.rst
@@ -0,0 +1,44 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT (c) 2018.
+.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+
+
+Software Test Plan Assurance and Procedures
+********************************************
+
+Testing and Coverage
+====================
+
+Testing to verify that requirements are implemented is a critical part of
+the high integrity processes. Similarly, measuring and reporting source
+and decision path coverage of source code is critical.
+
+Needed improvements to the RTEMS testing infrastructure should be done
+as part of the open project. Similarly, improvements in RTEMS coverage
+reporting should be done as part of the open project. Both of these
+capabilities are part of the RTEMS Tester toolset.
+
+Assuming that a requirements focused test suite is added to the open
+RTEMS, tools will be needed to assist in verifying that requirements are
+“fully tested.” A fully tested requirement is one which is implemented
+and tested with associated logical tracing. Tools automating this analysis
+and generating reporting and alerts will be a critical part of ensuring
+the master technical data does not bit rot.
+
+Must use tools from: 
+
+TBD - Change URL to git.rtems.org and list support tools
+RTEMS Tools Project: https://github.com/RTEMS/rtems-tools
+
+
+Scope, Procedures, Methodologies, Tools
+TBD - Write content
+
+
+
+.. COMMENT: Subsections
+.. toctree::
+
+    test-suites
+    tester
diff --git a/eng/test-suites.rst b/eng/test-suites.rst
new file mode 100644
index 0000000..a076fbe
--- /dev/null
+++ b/eng/test-suites.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
+
+Test Suites
+***********
+
+TBD  from https://devel.rtems.org/wiki/Developer/Testing/TestSuites
+
diff --git a/eng/tester.rst b/eng/tester.rst
new file mode 100644
index 0000000..5f12802
--- /dev/null
+++ b/eng/tester.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
+
+RTEMS Tester
+************
+
+TBD  https://devel.rtems.org/wiki/Testing/Tester
+
diff --git a/eng/users-manuals.rst b/eng/users-manuals.rst
new file mode 100644
index 0000000..e6c5dfa
--- /dev/null
+++ b/eng/users-manuals.rst
@@ -0,0 +1,30 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT (c) 2018.
+.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+
+
+User's Manuals
+*********************************
+
+TBD - write and link to useful documentation, potential URLs:
+
+Reference the RTEMS C User’s Manual
+
+* https://docs.rtems.org/doc-current/share/rtems/pdf/c_user.pdf
+
+Reference any other existing user documentation
+
+* https://docs.rtems.org/doxygen/cpukit/html/index.html
+
+* https://devel.rtems.org/
+
+* http://www.rtems.com/
+
+* https://www.rtems.org/onlinedocs.html
+
+* https://devel.rtems.org/wiki/Developer/Contributing
+
+* https://docs.rtems.org/releases/rtemsdocs-4.10.1/share/rtems/html/
+
+
diff --git a/eng/vc-authors.rst b/eng/vc-authors.rst
new file mode 100644
index 0000000..68f28e3
--- /dev/null
+++ b/eng/vc-authors.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
+
+
+Software Development (Git Writers)
+**********************************
+
+TBD - Convert https://devel.rtems.org/wiki/Developer/Git/Committers
+TBD - and insert here.
diff --git a/software-engineering-handbook/software-development-git-users.rst b/eng/vc-users.rst
index ebd79bb..ebd79bb 100644
--- a/software-engineering-handbook/software-development-git-users.rst
+++ b/eng/vc-users.rst
diff --git a/eng/vdd-generation.rst b/eng/vdd-generation.rst
new file mode 100644
index 0000000..28b891c
--- /dev/null
+++ b/eng/vdd-generation.rst
@@ -0,0 +1,13 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT (c) 2018.
+.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+
+
+Version Description Document (VDD) Generation 
+*********************************************
+
+TBD - probably 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
diff --git a/software-engineering-handbook/wscript b/eng/wscript
index 26ab0ca..26ab0ca 100644
--- a/software-engineering-handbook/wscript
+++ b/eng/wscript
diff --git a/software-engineering-handbook/RTEMS-Engineering-Standards-v3.docx b/software-engineering-handbook/RTEMS-Engineering-Standards-v3.docx
deleted file mode 100755
index 7fbfb9e..0000000
--- a/software-engineering-handbook/RTEMS-Engineering-Standards-v3.docx
+++ /dev/null
diff --git a/wscript b/wscript
index 41a1e9e..82d5eaa 100644
--- a/wscript
+++ b/wscript
@@ -17,7 +17,7 @@ build_all = ['user',
              'bsp-howto',
              'posix-users',
              'posix-compliance',
-             'software-engineering-handbook',
+             'eng',
              'filesystem',
              'networking',
              'shell',