rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 02:16:41 +08:00
Code Issues Packages Projects Releases Wiki Activity
823 Commits 3 Branches 7 Tags
Commit Graph

51 Commits

Author SHA1 Message Date
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
zehata
cd6ac10478 Converted Doxygen Best Practices Documentation to Rest format (GCI 2018) 2018-12-17 18:45:50 -06:00
Pritish Jain
edde29e203 coding-naming: Convert TBD to Rest format (GCI 2018) 2018-12-17 18:45:50 -06:00
Marçal Comajoan Cara
7e91a8f0fc eng/vc-users: Convert wiki page to Rest (GCI 2018) 
Converted https://devel.rtems.org/wiki/Developer/Git/Users
to Rest, and TBDs and wiki TODOs into comments. Also changed http
links to https (the ones that are possible), corrected typos, updated
learning resources links and added formattings.

This work was part of GCI 2018.
 2018-12-17 18:45:49 -06:00
Marçal Comajoan Cara
f4782c99b8 eng/vc-authors: Convert wiki page to Rest (GCI 2018) 
Converted https://devel.rtems.org/wiki/Developer/Git/Committers
to Rest, and TBDs and wiki TODOs into comments. Also changed http
links to https (the ones that are possible), corrected some typos,
created a folder for eng images and added some formatting.

This work was part of GCI 2018.
 2018-12-17 18:45:49 -06:00
Pritiah Jain
32a4a0aded management: Convert TBD to rest Format (GCI 2018) 2018-12-17 18:45:49 -06:00
Marçal Comajoan Cara
4ff378782e eng/conf.py: Use new short name of SW Eng Handbook 2018-12-17 18:45:49 -06:00
Joel Sherrill
ccbaea6d80 eng/license-requirements.rst: Add a TBD for BSD info 2018-12-17 18:45:49 -06:00
Joel Sherrill
9c755172c2 coding-doxygen-bsp.rst, coding-file-hdr.rst: Fix formatting 2018-12-17 18:45:49 -06:00
Pritish Jain
e55248d229 coding-file-hdr: Convert TBD to Rest Format (GCI 2018) 2018-12-17 18:45:49 -06:00
Pritish Jain
0184167233 coding-doxygen-bsp: Convert TBD to rest Format(GCI 2018) 2018-12-17 18:45:49 -06:00
Pritish Jain
65476b44a5 coding-gen-patch:Convert TBD to rest Format(GCI 2018) 2018-12-17 18:45:49 -06:00
Marçal Comajoan Cara
8059b68d21 eng/coding-80cols: Convert wiki page to Rest 
Converted https://devel.rtems.org/wiki/Developer/Coding/80_characters_per_line
to Rest, and TBDs into comments.

This work was part of GCI 2018.
 2018-12-17 18:34:58 -06:00
Marçal Comajoan Cara
49453ecc1c eng/appendix-a: convert to a table 
Convert text to a table, TBDs into comments and add missing
formatting.

This work was part of GCI 2018.
 2018-12-17 18:34:58 -06:00
Joel Sherrill
602561f87e eng/test-suites.rst: Update to reflect current reality 2018-12-17 18:34:58 -06:00
Pritish Jain
b0646e43d7 test-suites:Convert TBD to rest Format(GCI 2018) 2018-12-17 18:34:53 -06:00