1070 Commits

Author SHA1 Message Date
Sebastian Huber
03fc1d6514 c-user: Generate dual-ported memory manager docs
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-04-21 19:47:34 +02:00
Sebastian Huber
a99562097a c-user: Generate multiprocessing manager docs
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-04-21 19:47:34 +02:00
Sebastian Huber
d946f307e9 c-user: Generate fatal error manager docs
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-04-21 19:47:34 +02:00
Sebastian Huber
5a3cb76d38 c-user: Generate initialization manager docs
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-04-21 19:47:34 +02:00
Sebastian Huber
dae5338019 c-user: Add user extensions glossary terms 2021-04-21 19:43:54 +02:00
Sebastian Huber
86b48fb09e c-user: Split up multiprocessing manager
This makes it easier to automatically generate parts of the module
documentation in the future.

Update #3993.
2021-04-21 09:35:58 +02:00
Sebastian Huber
62ca9c1bc3 c-user: Split up fatal error manager
This makes it easier to automatically generate parts of the module
documentation in the future.

Update #3993.
2021-04-21 09:35:58 +02:00
Sebastian Huber
f3262d4074 c-user: Split up initialization manager
This makes it easier to automatically generate parts of the module
documentation in the future.

Update #3993.
2021-04-21 09:35:58 +02:00
Sebastian Huber
9bf0184a3e c-user: Document rtems_semaphore_obtain() errors
Update #3993.
2021-04-19 07:17:44 +02:00
Sebastian Huber
14c9029afe c-user: Add scheduler glossary terms
Add glossary terms which characterize the relationship of a scheduler to
a task.
2021-04-14 06:42:13 +02:00
Joel Sherrill
ad03db323a posix-compliance: Use constant name for API spreadsheet.
README-cvs.txt will need to be updated each time the spreadsheet is updated.
The spreadsheet is managed and maintained externally and has a version in
the name. We do not want that in the repository because a diff of the CSV
should always be much smaller than a "delete old/add new" patch.
2021-04-07 15:30:21 -05:00
Joel Sherrill
b43fe709af posix-compliance: Update tracking spreadsheet to v12
The new version of the API tracking spreadsheet includes FACE
Technical Standard, Edition 3.1 as well as a few additions to
what RTEMS supports. The generation script and discussion of
standards was updated to reflect the inclusion of a new Edition
of the FACE Technical Standard.

Closes #4380.
2021-04-07 13:57:57 -05:00
Sebastian Huber
241cd068d3 c-user: Fix rtems_semaphore_release() docs
The directive returns RTEMS_UNSATISFIED if the semaphore's count already
had the maximum value of UINT32_MAX.
2021-04-07 07:12:32 +02:00
Joel Sherrill
1f7be22f4f tools/boot-image.rst: Master Boot Record is MBR not MRB 2021-04-05 11:02:29 -05:00
Christian Mauderer
20893c5cfd user/bsps: Add STM32H7 SDMMC driver
Update #4372
2021-04-01 09:06:40 +02:00
Vijay Kumar Banerjee
998f8755e0 common/latex.py: use distro module for python3.5 and up 2021-03-30 09:28:59 -06:00
Vijay Kumar Banerjee
22d213c484 networking: Rename to legacy networking 2021-03-30 09:28:59 -06:00
Christian Mauderer
656326246d User/BSPs/Beagle: Add JTAG debugger section 2021-03-30 09:20:55 +02:00
Gedare Bloom
357287c554 start: provide more version guidance for gsoc 2021-03-25 09:18:10 -06:00
Ida Delphine
cd7318c802 start: Console output example updates 2021-03-25 08:41:11 -06:00
Ida Delphine
1472f30f95 app: Update command to configure app 2021-03-25 08:41:11 -06:00
Ida Delphine
492cbeafac bsp-build: Update manual bsp build command 2021-03-25 08:41:11 -06:00
Ida Delphine
ce493324e2 tools: Update command to install toolsuite 2021-03-25 08:41:11 -06:00
Ida Delphine
0a9288cb65 sourses: Update source download command 2021-03-25 08:41:11 -06:00
Ida Delphine
ae11bc72c1 prefixes: Update installation prefix 2021-03-25 08:41:11 -06:00
Sebastian Huber
4476290486 eng: Add example to action requirements how-to
Update #3715.
2021-03-19 08:20:16 +01:00
Sebastian Huber
b40e043190 eng: Document expressions in action requirements
Update #3715.
2021-03-19 08:20:16 +01:00
Sebastian Huber
b580a6da14 eng: Add build/appl config clauses to how-to
Update #3715.
2021-03-19 08:20:16 +01:00
Sebastian Huber
239644be82 eng: Update EARS syntax
The document used the EARS syntax from 2009 which slightly changed in
2016, see "Listens Learned (8 Lessons Learned Applying EARS)".  The
optional pre-conditions moved to the state-driven pattern.  This refined
syntax fits better to the action requirements.

Update #3715.
2021-03-19 08:20:16 +01:00
Sebastian Huber
66591316dc c-user: Remove obsolete constraint 2021-03-17 14:01:03 +01:00
Sebastian Huber
f2bbea69af c-user: Update semaphore example
Update #4346.
2021-03-17 14:00:59 +01:00
Meh Mbeh Ida Delphine
a4755f6ee5 eng/vc-users: Set up patch message with repo name
Added instructions on how to set up a patch message with a repo name.

Author:    Meh Mbeh Ida Delphine <idadelm@gmail.com>
Date:      Tue Mar 16 19:11:23 2021 +0100
2021-03-16 13:06:30 -06:00
Jan Sommer
2c2c7de35f user/bsps: Mention fixed console baud rate for zynq 2021-03-16 13:50:08 +01:00
Sebastian Huber
bc0a85723c eng: Clarify how-to for action requirements
Bring how-to in line with current action requirements.

Update #3715.
2021-03-11 07:53:24 +01:00
Sebastian Huber
0518d94f30 eng: Clarify how-to for action requirements
Update #3715.
2021-03-11 06:56:12 +01:00
Sebastian Huber
e05df28643 eng: Clarify how-to for action requirements
Update #3715.
2021-03-08 10:19:34 +01:00
Sebastian Huber
a4b3019d99 eng: Add how-to for action requirements
Update #3715.
2021-03-08 08:28:54 +01:00
Sebastian Huber
7918ef8df8 c-user: Clarify constraints 2021-03-08 08:28:54 +01:00
Kinsey Moore
084a564ba8 user: Update ZynqMP QEMU BSP name
The ZynqMP QEMU BSPs have had _qemu added to their names to better
identify them as QEMU BSPs similar to other BSPs which are meant to run
exclusively on QEMU and not hardware.
2021-03-05 10:46:10 -06:00
Sebastian Huber
fcac22e5b7 eng: Fix typo
Update #3715.
2021-03-02 08:28:48 +01:00
Sebastian Huber
c87d8c2af3 c-user: Generate signal manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-02-19 07:06:00 +01:00
Robin Mueller
3afdebda9a STM32H7 doc update 2021-02-18 13:03:58 -07:00
Gedare Bloom
20323829cf common/waf: fix some typos 2021-02-18 13:03:34 -07:00
Gedare Bloom
4563bb6a8b common: use bibtex_bibfiles for newer bibtex
Closes #4229.
2021-02-18 13:03:34 -07:00
Sebastian Huber
a60c5b4b3e c-user: Generate clock manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-02-17 18:34:58 +01:00
Sebastian Huber
4aead847d2 c-user: Generate user extensions manager docs
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-02-10 17:19:00 +01:00
Sebastian Huber
62718adaa8 c-user: Generate barrier manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-02-10 17:19:00 +01:00
Sebastian Huber
fd56f7e469 c-user: Generate semaphore manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2021-02-10 17:19:00 +01:00
Sebastian Huber
698580033b c-user: Move deprecated/removed directives
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
2021-02-10 16:53:38 +01:00
Sebastian Huber
a1c5d680b9 c-user: Add control block acronyms
Update #3993.
2021-02-10 16:53:37 +01:00