rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-17 05:11:56 +08:00
Code Issues Packages Projects Releases Wiki Activity
880 Commits 3 Branches 7 Tags
Commit Graph

66 Commits

Author SHA1 Message Date
Sebastian Huber
87a9478da6 eng: Clarify action requirement specification 
Update #3715.
 2020-06-17 09:10:52 +02:00
Sebastian Huber
db3892b5b8 eng: Update action requirement specification 
Update #3715.
 2020-06-10 10:12:00 +02:00
Sebastian Huber
ca2f5e6384 eng: Update specification how-to section 
Update #3715.
 2020-06-08 08:53:02 +02:00
Sebastian Huber
0213e8efab eng: Add a specification type for actions 
Add support to specify functional requirements for actions (functions or
macros) via a transition map of pre-conditions to post-conditions.  This
will be the work horse for functional requirements.  Generation of
corresponding validation tests is supported.

Update #3715.
 2020-06-08 08:52:50 +02:00
Sebastian Huber
0c43c520c8 eng: Add generic attribute key types 
Update #3715.
 2020-06-04 15:06:12 +02:00
Sebastian Huber
f54798854f eng: Simplify wording for specification items 
Update #3715.
 2020-06-04 15:06:12 +02:00
Sebastian Huber
b35f3ef44a Use a complete sentence for acronym definitions 2020-06-04 15:06:12 +02:00
Sebastian Huber
9b269adc6c eng: Add interface specification how-to 
Update #3715.
 2020-06-01 13:00:41 +02:00
Sebastian Huber
459326c2b9 eng: Update requirements tooling section 
Update #3715.
 2020-05-29 17:47:21 +02:00
Sebastian Huber
23ab40d3e6 eng: Add generated documentation of spec items 
The documentation of the specification items is generated by an RTEMS
qualification tool from a specification of specification items.

Move non-generated content to "req-for-req.rst".

Update #3715.
 2020-05-29 08:21:03 +02:00
Sebastian Huber
59312aa965 eng: Split up requirements engineering chapter 
This allows to more easily generate the specification item section with
a script using specification items.

Update #3715.
 2020-05-29 07:14:53 +02:00
Sebastian Huber
d4ba908e42 eng: Update requirements engineering chapter 
Update requirements engineering chapter due to the removal of Doorstop
as the requirements management tool.

Update the application configuration related specification items.

Update #3715.
 2020-05-05 07:03:40 +02:00
Joel Sherrill
2d22d7453d Rework RTEMS licensing discussions. 
This now captures historical rationale along with cross-linking
code templates with license guidelines.

Closes #3962.
 2020-05-01 11:11:31 -05:00
Sebastian Huber
7e08133aff eng: Adjust config.h include 
Use variant used by most source files.
 2020-04-15 16:50:35 +02:00
Chris Johns
ec9457f604 Add a release procedure section. 2020-04-04 10:14:11 +11:00
Sebastian Huber
2c7cd341a0 eng: Add documentation guidelines 
Start with templates for the application configuration options.

Remove "Format to be followed for making changes in this file" from
c-user.

Update #3910.
 2020-04-02 10:23:36 +02:00
Sebastian Huber
6f0bc56893 eng: Add glossary terms 
Define the following terms:

* assembler language
* C language
* ELF
* interrupt service
* software component
* software unit

Clarify:

* task

Update #3715.
 2020-04-01 07:49:15 +02:00
Sebastian Huber
aceadb15d6 eng: Add Python development guidelines 2020-03-19 07:41:30 +01:00
Sebastian Huber
7d05a3d801 eng: Add glossary 
Update #3853.
 2020-03-02 08:11:42 +01:00
Sebastian Huber
ca1a9e6677 eng: Fix typo 2020-02-25 12:43:18 +01:00
Sebastian Huber
d27e6304d0 eng: Rework file template section 
Update #3053.
 2020-02-24 08:13:54 +01:00
Sebastian Huber
76b3aead1b eng: Grammar fix 
Update #3199.
 2020-02-10 13:48:49 +01:00
Sebastian Huber
b6c61e38ab eng: Mention test framework buffer configuration 
Update #3199.
 2020-02-10 07:36:01 +01:00
Sebastian Huber
45a0f65798 eng: Document test framework formatted output 
Update #3199.
 2020-02-10 07:35:58 +01:00
Sebastian Huber
d9d9c700a2 Revert "common: Add URLs to manuals" 
This reverts commit 1fdd3cf83d154af66ad0edf5094d93075063c7e0 and some
follow up changes.
 2020-02-04 05:45:02 +01:00
Sebastian Huber
d412c5bf2a eng: Add Software Requirements Engineering chapter 
Update #3715.
 2020-01-07 07:45:49 +01:00
Sebastian Huber
1ff876aa59 eng: Rework stakeholder chapter 2020-01-07 07:20:19 +01:00
Sebastian Huber
b44feffacb eng: Rework preface and add mission statement 
Add mission statement based on the wiki page:

https://devel.rtems.org/wiki/Mission_Statement

Do format changes and some rewording.
 2020-01-07 07:19:50 +01:00
Sebastian Huber
1d3114dbb2 Move contributing content from eng to user 2019-10-30 14:03:12 +01:00
Sebastian Huber
c91db32c7d eng: Update issue tracking section 2019-10-30 14:03:12 +01:00
Sebastian Huber
735bcd765a eng: Add bibliography 2019-07-24 15:42:29 +02:00
Sebastian Huber
ef1911298e eng: Rework Doxygen guidelines 
Update #3704.
 2019-04-05 09:36:06 +02:00
Sebastian Huber
1d48fb5a00 bsp-howto: Move BSP Doxygen recommendations 
Update #3704.
 2019-04-04 07:40:18 +02:00
Sebastian Huber
c2e582db32 eng: Add software test framework chapter 
Update #3199.
 2019-03-27 07:33:56 +01:00
Sebastian Huber
bb564b7fc3 eng: Change title to RTEMS Software Engineering 
Use a shorter title so that the PDF page header fits into one line.
 2019-03-27 07:30:35 +01:00
Sebastian Huber
588b9b2112 eng: Reformat 2019-03-13 10:46:22 +01:00
Chris Johns
fb72a002a3 Add unicode support for commonly used characters like copyright. 
- This change makes the copyright character easier to see on editors
  lacking good unicode rendering support, ie terminals.
 2019-02-28 10:22:54 +11:00
Chris Johns
f7384cc2e2 Use pathto() on the genindex URL to make it relative. 2019-02-15 09:40:50 +11:00
Chris Johns
5d8b0ddd0a waf: Remove as many sys path hacks as we can. 
There are still sys.path hacks in the conf.py files. They cannot
be removed because the instance of python running the sphinx-build
command does not see our top level path hacks. I looked at using
PYTHONPATH but I could not figure out how to set a process environ
var for a waf build instance.
 2019-02-13 10:18:43 +11:00
Sebastian Huber
6f110ccf6b build: Prepend project common path 
This avoids conflicts with standard packages such as PIL (Python Imaging
Library).
 2019-02-08 09:43:16 +01:00
Sebastian Huber
b5014fe0c8 Reformat and update copyright and license notices 
For everything before 2015 an OAR copyright is assumed.  Later copyright
notices are based on Git commits on a best effort basis.

The copyright notices of the "RTEMS Software Engineering Handbook" and
the "RTEMS CPU Architecture Supplement" are incomplete.
 2019-01-14 07:15:27 +01:00
Sebastian Huber
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
4886d60aa8 Use standard format for copyright lines 2019-01-11 07:18:16 +01:00
Sebastian Huber
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01:00
Joel Sherrill
6682434bf2 Eliminate UTF-8 characters except superscripted 2 in i2c 2018-12-20 09:17:09 -06:00
Sebastian Huber
e24c5e9682 eng: Unicode char (U+200B) 2018-12-20 08:20:05 +01:00
Pritish Jain
75f24638b3 eng/coding-conventions.rst: Convert TBD to Rest Format (GCI 2018) 2018-12-17 18:45:50 -06:00
Marçal Comajoan Cara
cc826d74f3 eng/coding-doxygen: Fix errors 
This work was part of GCI 2018.
 2018-12-17 18:45:50 -06:00
Sal
b8b4f14973 eng/coding-file-hdr.rst: Fix file formatting (GCI 2018) 2018-12-17 18:45:50 -06:00
Joel Sherrill
f5c20a6ad8 eng/coding-doxygen.rst: Clean up and make subsubsections 2018-12-17 18:45:50 -06:00