441 Commits

Author SHA1 Message Date
Sebastian Huber
7afc7a0f31 rtems: Fix message manager documentation
Correct the description of the ``count`` parameter of
rtems_message_queue_flush().

Close #4508.
2021-09-16 09:39:20 +02:00
Sebastian Huber
28188d4652 c-user: Fix use of lower and higher priority 2021-09-15 17:45:29 +02:00
Sebastian Huber
5fdc744dce c-user: Clarify task priorities 2021-09-15 07:54:43 +02:00
Sebastian Huber
c81e148179 c-user: Define lower and higher priority 2021-09-15 07:54:43 +02:00
Sebastian Huber
6198c49c24 c-user: Fix message manager documentation
Remove bogus return status from rtems_message_queue_receive().  Clarify
rtems_message_queue_flush().

Close #4508.
2021-09-15 07:54:43 +02:00
Sebastian Huber
0bc62eee95 c-user: Clarify rtems_extension_create() 2021-09-15 07:54:43 +02:00
Sebastian Huber
023f60936c c-user: Add "Cache Manager" chapter
The Cache Manager directives are available via <rtems.h>.  Document most
of them in the Classic API Guide.

Not documented are the following directive since the API is not yet
stable:

* rtems_cache_coherent_allocate()
* rtems_cache_coherent_free()
* rtems_cache_coherent_add_area()

Not documented are the following directive since the directives are not
implemented on maintained platforms:

* rtems_cache_freeze_data()
* rtems_cache_freeze_instruction()
* rtems_cache_unfreeze_data()
* rtems_cache_unfreeze_instruction()

Close #4513.
2021-09-13 08:28:16 +02:00
Sebastian Huber
081ec5d5e9 c-user: Document time of day constraints
Close #4338.
2021-09-06 12:28:05 +02:00
Sebastian Huber
dc6b917dc3 c-user: Add LIFO to glossary 2021-09-02 11:17:58 +02:00
Sebastian Huber
efb8e7c6c3 c-user: Add "Kernel Character I/O Support" chapter
Close #4482.
2021-08-03 10:39:49 +02:00
Sebastian Huber
18746fb259 c-user: Remove _Internal_errors_What_happened
This global object no longer exists.
2021-07-28 08:46:33 +02:00
Sebastian Huber
056886f171 c-user: Document interrupt manager extensions
Close #3269.
2021-07-27 07:50:15 +02:00
Sebastian Huber
c70715baea c-user: Use a common phrase for pointer parameters
Mention the type of the pointer in the parameter description.  Use the
more general term "object" instead of "variable".

Update #3993.
2021-06-15 07:47:38 +02:00
Christian Mauderer
b05cecc7da c-users: Add rtems_*mutex_try_lock
Closes #4440.
2021-05-28 08:27:08 +02:00
Sebastian Huber
2509b62106 c-user: Document new rtems_task_delete() error
Close #4414.
2021-05-27 07:08:41 +02:00
Sebastian Huber
2588e8bf35 c-user: Constify rtems_task_wake_when()
Update #4406.
2021-05-12 21:32:12 +02:00
Sebastian Huber
fa98f8df66 c-user: Clarify rtems_task_get_priority() 2021-05-12 21:07:00 +02:00
Sebastian Huber
7ded5943e4 c-user: Document rtems_task_set_scheduler() errors 2021-05-12 21:07:00 +02:00
Sebastian Huber
dcd0085a0e c-user: Add task priority glossary terms 2021-05-12 21:07:00 +02:00
Sebastian Huber
ee5718a00a c-user: Change format of external function refs 2021-05-08 10:27:29 +02:00
Sebastian Huber
e8cd4d3bec c-user: rtems_scheduler_get_processor_set()
Document changed error status.

Update #4401.
2021-05-07 08:19:10 +02:00
Sebastian Huber
605cd1fc47 c-user: rtems_scheduler_ident_by_processor_set()
Document new error status.
2021-05-07 08:19:02 +02:00
Sebastian Huber
4565256f24 c-user: Reformat configuration option constraints
If only one constraint is present, then use a single sentence, otherwise
use a list for the constraints.  Format the constraints so that the line
length limit is maintained.
2021-04-29 21:00:43 +02:00
Sebastian Huber
8f1daf7c82 c-user: CONFIGURE_BSP_PREREQUISITE_DRIVERS
Replace copy and paste with a proper description.
2021-04-29 15:02:46 +02:00
Sebastian Huber
33836869da c-user: Add missing "the" 2021-04-29 15:01:46 +02:00
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