11 Commits

Author SHA1 Message Date
Kinsey Moore
981ba2de41 c-user: Update references to rtems_task_wake_after
rtems_task_wake_after takes a parameter in terms of a count of clock
ticks and not a measure in a subunit of seconds. This updates
documentation to reflect that. This also makes obvious the caveat about
the first tick wait not being a whole tick and points the user at a
replacement for better accuracy.

Updates #4772
2023-07-06 13:55:37 -05:00
Sebastian Huber
bbb8b7aa81 Update company name
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
2023-05-20 11:12:29 +02:00
Sebastian Huber
e33eae15a7 c-user: Generate API type documentation
Close #4901.
2023-05-09 14:06:01 +02: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
5fdc744dce c-user: Clarify task priorities 2021-09-15 07:54:43 +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
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
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
4e09c0958c c-user: Add labels to the manager chapters
Update #3993.
2021-02-10 16:53:32 +01: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