407 Commits

Author SHA1 Message Date
Sebastian Huber
162925edd0 c-user: Use document internal links 2022-01-11 09:26:52 +01:00
Sebastian Huber
e77e04d2dc c-user: Clarify Clock Manager dependencies
Update #4572.
2022-01-11 09:26:52 +01:00
Sebastian Huber
786b89ac86 c-user: Clarify time formats
Update #4572.
2021-12-16 15:44:06 +01:00
Sebastian Huber
732d8bca8f c-user: Fix Clock Manager parameter descriptions
Update #4572.
2021-12-16 07:44:49 +01:00
Sebastian Huber
838b78ad5c c-user: Replace "precision" with "resolution"
Resolution is the right term for the documented property.
2021-11-23 15:21:00 +01:00
Sebastian Huber
513b90d7a4 c-user: rtems_scheduler_remove_processor()
Update error status description.

Close #4544.
2021-11-19 08:49:53 +01:00
Sebastian Huber
38ec48d292 c-user: Document new clock manager directives
Add new clock manager directives to get all times provided by the
timehands.

Close #4527.
2021-11-19 08:49:46 +01:00
Sebastian Huber
61410dad2a c-user: Use RTEMS_WHO_AM_I for rtems_task_ident() 2021-11-19 08:47:00 +01:00
Sebastian Huber
1c8ce332e2 c-user: Use rubric for configuration options
Clear the page for each configuration options similar to the directives.

Use a rubric instead of a definition list for the application
configuration options similar to the directive documentation pages.  For
direcives and application configuration options use the same rubric
order.

Generalize value constraints to constraints.

This patch does not change hand written content.
2021-11-17 09:08:53 +01:00
Sebastian Huber
1badb5f479 c-user: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS
Fix default value description.
2021-11-16 08:00:03 +01:00
Kinsey Moore
a0bf79c39a c-user: Update for application CONFIGURE option
This adds the documentation for the application configuration option
CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING.
2021-11-03 08:25:36 -05:00
Sebastian Huber
feb4687558 c-user: rtems_rate_monotonic_get_status()
Mention that resetting the processor usage time of tasks has no impact
on the period status and statistics.

Remove no longer relevant RTEMS_NOT_DEFINED error status.

Close #4528.
2021-10-25 08:13:47 +02:00
Sebastian Huber
46dbb6dd7f c-user: Regenerate for IDLE task allocator option
Update #4524.
2021-10-25 08:13:47 +02:00
Joel Sherrill
df5be4c97a task-stack-alloc.rst: Add CONFIGURE_TASK_STACK_FROM_ALLOCATOR
Updates #4524.
2021-10-12 13:46:11 -05:00
Sebastian Huber
887b8d3dd6 glossary: Add terms 2021-09-30 07:42:19 +02:00
Sebastian Huber
0ca7adf983 glossary: Add OMIP 2021-09-28 10:54:27 +02:00
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