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

41 Commits

Author SHA1 Message Date
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
efb8e7c6c3 c-user: Add "Kernel Character I/O Support" chapter 
Close #4482.
 2021-08-03 10:39:49 +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
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
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
a526872600 c-user: Split up configuring_a_system.rst 
Introduce an index file for this chapter.  This helps to generate some
sections from the specification in the future.  Start with moving
"Introduction" up to "Unlimited Objects" to a new file.

Update #3836.
 2020-03-11 12:30:39 +01:00
Sebastian Huber
a4b23d9ba8 c-user: Document new linker set macros 
Adjust copyright.  Linker sets were introduced in 2015.

Update #2408.
Close #3865.
 2020-02-06 15:18:23 +01:00
Chris Johns
fb72a002a3 Add unicode support for commonly used characters like copyright. 
- This change makes the copyright character easier to see on editors
  lacking good unicode rendering support, ie terminals.
 2019-02-28 10:22:54 +11:00
Chris Johns
f7384cc2e2 Use pathto() on the genindex URL to make it relative. 2019-02-15 09:40:50 +11:00
Sebastian Huber
fa5a960a1f Add copyright notices 2019-02-08 09:43:16 +01:00
Sebastian Huber
b5014fe0c8 Reformat and update copyright and license notices 
For everything before 2015 an OAR copyright is assumed.  Later copyright
notices are based on Git commits on a best effort basis.

The copyright notices of the "RTEMS Software Engineering Handbook" and
the "RTEMS CPU Architecture Supplement" are incomplete.
 2019-01-14 07:15:27 +01:00
Sebastian Huber
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01:00
Chris Johns
969e60e596 Update the copyright year. 2018-10-19 14:42:12 +11:00
Joel Sherrill
d40e66b2e9 c-user/index.rst: Reorder linker sets and directive status codes 2018-10-11 12:02:46 -05:00
Chris Johns
5ce8e43506 build: Fix indexing so it works on HTML and PDF. 
- Remove all genindex.rst files, these are generated and should not
  exist in our source.
- Fix the HTML templates so the local specialisation works.
- Add a index link to the sidebar for HTML.

Note, there is no TOC entry for the index in the PDF output and I
cannot figure out how to add one.

Closes #3503
 2018-08-21 13:47:40 +10:00
Sebastian Huber
1472f8411b c-user: Add self-contained objects chapter 
Update #2843.
 2018-02-05 09:35:53 +01:00
Chris Johns
42d50d760e Add indexes to all documents. 
Update #3229.
 2017-11-12 10:32:39 +11:00
Chris Johns
efc29ff31b Update copyright notices. 2017-08-11 13:45:52 +10:00
Sebastian Huber
97e1553c06 c-user: Add support for references via bibtex 
https://sphinxcontrib-bibtex.readthedocs.io/en/latest/index.html

Update #2871.
 2017-01-18 11:31:46 +01:00
Joel Sherrill
7d78d31a52 c-user: Add Ada support chapter 
closes #2589.
 2017-01-17 18:28:05 -06:00
Joel Sherrill
7193f09294 Update document titles for consistency 2017-01-11 19:01:20 -06:00
Chris Johns
53bb72e996 c-user: Format the directives as descriptions. 
This change combined with the element list change in latex generates
a much better looking PDF.

Add a page break before each directive to like th previous versions of the
manuals.
 2016-11-08 15:28:32 +11:00
Chris Johns
72a62ad88f Rename all manuals with an _ to have a -. It helps released naming of files. 2016-11-03 16:58:08 +11:00