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

338 Commits

Author SHA1 Message Date
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
Sebastian Huber
05f06aa7e7 c-user: Split up object services 
This makes it easier to automatically generate parts of the module
documentation in the future.

Update #3993.
 2020-11-20 14:25:59 +01:00
Sebastian Huber
9291bbbdd7 c-user: Update internal error list 2020-11-20 07:50:35 +01:00
Sebastian Huber
530bc2b0e3 c-user: Generate Partition Manager documentation 
The manager 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.  This
header file was generated from the items by a script.

Update #3993.
 2020-11-12 07:42:45 +01:00
Sebastian Huber
ec4dcc0098 c-user: Generate Event Manager documentation 
The manager 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.  This
header file was generated from the items by a script.

Update #3993.
 2020-11-12 07:42:45 +01:00
Sebastian Huber
ad64ea0bc7 Improve automatically generated warning 2020-11-12 07:42:45 +01:00
Sebastian Huber
51a5138bfe c-user: Add "Generated from ..." comments 2020-11-09 15:04:34 +01:00
Sebastian Huber
4aae24d5b5 c-user: Generate I/O Manager documentation 
The manager 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.  This
header file was generated from the items by a script.

Update #3993.
 2020-10-11 15:26:38 +02:00
Sebastian Huber
dd97e25faf Improve file header comment in generated files 2020-10-11 15:19:19 +02:00
Sebastian Huber
647bfdd728 c-user: Fix use of getchark() and rtems_putc() 2020-09-28 09:12:32 +02:00
Sebastian Huber
28db97275b c-user: CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE 
Document this application configuration option.

Update #3959.
 2020-09-17 18:14:23 +02:00
Sebastian Huber
a5fe9aad19 c-user: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE 
Document this application configuration option.

Close #4074.
 2020-09-17 18:14:23 +02:00
Sebastian Huber
ba9dfcf92c c-user: Split up scheduling concepts 
Introduce a background section.

This makes it easier to automatically generate parts of the scheduling
concepts documentation in the future.

Update #3993.
 2020-09-02 17:59:31 +02:00
Sebastian Huber
80df4d6a47 c-user: Split up user extensions manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:59:05 +02:00
Sebastian Huber
a99bbaec5f c-user: Split up timer manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:58:31 +02:00
Sebastian Huber
ccb384b623 c-user: Split up task manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:58:03 +02:00
Sebastian Huber
e3523ed062 c-user: Split up signal manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:57:38 +02:00
Sebastian Huber
aebb6fd7c7 c-user: Split up region manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:57:10 +02:00
Sebastian Huber
082054b63d c-user: Split up rate-monotonic manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:56:25 +02:00
Sebastian Huber
a4119a9f1c c-user: Split up partition manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:55:31 +02:00
Sebastian Huber
c75ded25ea c-user: Split up message manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:55:06 +02:00
Sebastian Huber
980734f1cd c-user: Split up IO manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:55:00 +02:00
Sebastian Huber
72295d47f6 c-user: Split up interrupt manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:54:43 +02:00
Sebastian Huber
623a9a11e8 c-user: Split up dual-ported memory manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:54:21 +02:00
Sebastian Huber
86c39ef2c4 c-user: Split up clock manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:53:57 +02:00
Sebastian Huber
91f0f97698 c-user: Split up barrier manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:53:55 +02:00
Sebastian Huber
ba6825ca63 c-user: Split up event manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:53:32 +02:00
Sebastian Huber
16ee8cf45b c-user: Split up semaphore manager 
This makes it easier to automatically generate parts of the manager
documentation in the future.

Update #3993.
 2020-09-02 17:53:30 +02:00
Sebastian Huber
63764a6d27 c-user: Add automatically generated warning 
Update #3994.
 2020-08-07 07:15:09 +02:00