366 Commits

Author SHA1 Message Date
Sebastian Huber
35cbb42a42 c-user: Generate region 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-04-28 09:03:49 +02:00
Sebastian Huber
2ae3364b10 c-user: Generate task 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-04-28 09:03:49 +02:00
Sebastian Huber
bc66c95900 c-user: Fix typo "cod" -> "code" 2021-04-28 09:03:49 +02:00
Sebastian Huber
ad16b373f3 c-user: Clarify constraints 2021-04-28 09:03:49 +02:00
Sebastian Huber
4a3259f161 c-user: Generate scheduling concepts 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-04-28 09:03:49 +02:00
Sebastian Huber
f6b433727c c-user: Generate interrupt 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-04-28 09:03:49 +02:00
Sebastian Huber
de8fe65f57 c-user: Constify timer fire when directives
Update #4392.
2021-04-28 09:03:23 +02:00
Sebastian Huber
b5fe4f0e32 c-user: Fix wording for "home scheduler" 2021-04-27 09:45:00 +02:00
Sebastian Huber
6ee9317ee9 c-user: Use glossary term 2021-04-27 09:44:51 +02:00
Sebastian Huber
63a9e0c55c c-user: Generate message 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-04-23 08:32:22 +02:00
Sebastian Huber
61cbbd2e23 c-user: Generate rate-monotonic 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-23 08:32:22 +02:00
Gedare Bloom
f6f3fdcd09 c-user: fix broken definition in rate-monotonic background. 2021-04-22 17:37:19 +02:00
Sebastian Huber
eb45e220ac c-user: Mention timer server fire directives
A timer may be also reinitiated by the timer server fire directives.
2021-04-22 15:55:59 +02:00
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
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
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
Sebastian Huber
7918ef8df8 c-user: Clarify constraints 2021-03-08 08:28:54 +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
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
Sebastian Huber
4e09c0958c c-user: Add labels to the manager chapters
Update #3993.
2021-02-10 16:53:32 +01:00
Sebastian Huber
261491f4ad c-user: Clarify object services documentation
Unify the wording across similar directives of other managers.

Update #3993.
2021-02-10 16:46:25 +01:00
Sebastian Huber
e357ccf65b c-user: Clarify IO manager documentation
Unify the wording across similar directives of other managers.

Update #3993.
2021-02-10 16:46:25 +01:00
Sebastian Huber
45d3811480 c-user: Clarify partition manager documentation 2021-02-10 16:42:52 +01:00
Sebastian Huber
775380c557 c-user: Clarify event manager documentation
Unify the wording across similar directives of other managers.  Add
"CONSTRAINTS" section.

Update #3993.
2021-02-10 16:42:52 +01:00
Sebastian Huber
4d9b0b4a10 c-user: Clarify timer manager documentation
Unify the wording across similar directives of other managers.  Add
"CONSTRAINTS" section.

Update #3993.
2021-02-10 16:42:52 +01:00
Sebastian Huber
66c9808db0 c-user: Clarify partition manager documentation
Unify the wording across similar directives of other managers.  Add
"CONSTRAINTS" section.

Update #3993.
2021-02-03 06:19:20 +01:00
Sebastian Huber
95e2f933cb c-user: Clarify object services
Add a "Constraints" paragraph to the documentation.  Use function
prototypes for the directives.

Update #3993.
2021-02-03 06:19:20 +01:00
Sebastian Huber
ba633eca2d Improve file header comment in generated files 2021-01-25 06:58:10 +01:00
Sebastian Huber
d716c79070 c-user: Generate Timer 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.
2020-12-09 09:17:37 +01:00
Sebastian Huber
dad89ce7a9 c-user: Generate Object Services 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.
2020-12-02 09:12:47 +01:00
Sebastian Huber
66bcecfd28 c-user: Clarify invalid identifier descriptions
Update #3993.
2020-12-02 08:31:15 +01:00
Sebastian Huber
346bbe698d c-user: Clarify rtems_partition_delete()
Move the PTCB sentence to the notes to be in line with
rtems_partition_create().

Update #3993.
2020-12-02 08:18:53 +01:00
Sebastian Huber
29e6caa311 c-user: Clarify rtems_partition_create()
The rtems_partition_create() returns an object identifier and not just a
partition identifier.

Update #3993.
2020-12-02 08:18:53 +01:00
Sebastian Huber
284e8d0421 c-user: Fix format in Partition Manager
Update #3993.
2020-12-01 14:44:17 +01:00
Sebastian Huber
00b3444afd c-user: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
Document new configuration option
CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE.

Close #4181.
2020-11-25 18:38:23 +01:00