1029 Commits

Author SHA1 Message Date
Robin Mueller
3afdebda9a STM32H7 doc update 2021-02-18 13:03:58 -07:00
Gedare Bloom
20323829cf common/waf: fix some typos 2021-02-18 13:03:34 -07:00
Gedare Bloom
4563bb6a8b common: use bibtex_bibfiles for newer bibtex
Closes #4229.
2021-02-18 13:03:34 -07:00
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
174444f655 eng: Update test case item
Update #3715.
2021-02-08 15:02:36 +01:00
G S Niteesh Babu
3e1ac91d6d user: remove old build system cmd 2021-02-03 10:33:00 -07: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
Gedare Bloom
221b61a9d3 user: add guidance on version numbers to GSoC guide. 2021-02-01 13:28:36 -07:00
Sebastian Huber
ba633eca2d Improve file header comment in generated files 2021-01-25 06:58:10 +01:00
Sebastian Huber
a08e672abf eng: Add design group requirement item type
Update #3715.
2021-01-15 06:39:18 +01:00
Kinsey Moore
c3b4e18ab6 user: Update aarch64/xilinx-zynqmp Qemu command
The Xilinx ZynqMP BSP has been updated to use the second UART in the
memory map as the primary UART since this is how both the hardware and
Qemu use them.
2021-01-14 13:25:09 -06:00
Sebastian Huber
58bf83ea4b user: Mention use of LLVM 2021-01-04 06:10:24 +01:00
Christian Mauderer
2cf3076320 user/bsp/imxrt: Information for custom FDT
Update #4180
2020-12-14 12:53:02 +01:00
Christian Mauderer
171bbe096f shell: Document i2c and spi commands. 2020-12-14 10:48:19 +01:00
Kinsey Moore
265bee75ec user: Add aarch64/xilinx-zynqmp 2020-12-11 17:16:01 -06:00
Kinsey Moore
94abaa3ab2 user: Add A53 Qemu run instructions 2020-12-11 17:16:01 -06:00
Kinsey Moore
9c407619c7 aarch64: Update interrupt details 2020-12-11 17:16:01 -06: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
4b03ff7fb5 eng: Add performance specification items
Add items to specify runtime performance requirements.

Update #3715.
2020-11-27 09:16:00 +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
Christian Mauderer
f5016828f3 user/bsps: Fix list in bsps-arm
Seems that some filenames haven't been added correctly.
2020-11-20 09:04:05 +01:00
Christian Mauderer
e95d992e3c user/bsps: Add imxrt
Update #4180
2020-11-20 09:03:56 +01:00
Sebastian Huber
9291bbbdd7 c-user: Update internal error list 2020-11-20 07:50:35 +01:00
Sebastian Huber
238789d8fa eng: Rework and clarify Doxygen Guidelines 2020-11-20 07:50:30 +01:00
Sebastian Huber
bbd8d4a56f eng: Fix typo
Update #3715.
2020-11-19 11:23:23 +01:00
Sebastian Huber
0454ad786d eng: Simplify "Load" environment reporting
Report all runtime measurement environments with a name only and encode
the worker count of the "Load" environment in the name.

Update #3199.
2020-11-13 09:06:46 +01:00
Sebastian Huber
cdbd72d896 eng: Rename ValidCache environment in FullCache
This name better reflects the execution envirnoment in which the cache
is fully loaded with valid data unrelated to the body request handler.

Update #3199.
2020-11-13 09:06:46 +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
64323c3827 eng: Move code formatting rules into one section
Clarify the 80 character limit.  Change the line continuation indent
level.
2020-11-11 07:43:38 +01:00
Sebastian Huber
b0b6c0cdd5 eng: Clarify "Coding Conventions" introduction 2020-11-11 07:43:38 +01:00