1005 Commits

Author SHA1 Message Date
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
Sebastian Huber
dc345cf7fd eng: Clarify "Source Documentation" section 2020-11-11 07:43:38 +01:00
Sebastian Huber
c694df1330 eng: Add header file conventions 2020-11-11 07:43:38 +01:00
Sebastian Huber
3c896b996c eng: Remove "Generating a Tools Patch"
This section is probably some left over stuff from CVS times.  The topic
is already covered by the "Software Development (Git Users)" section.
2020-11-11 07:43:38 +01:00
Sebastian Huber
51a5138bfe c-user: Add "Generated from ..." comments 2020-11-09 15:04:34 +01:00
Sebastian Huber
f6102914eb eng: Add function attributes
Update #3715.
2020-11-09 15:04:34 +01:00
Sebastian Huber
8fe0da2198 user: Add arm/stm32h7
Close #3910.
2020-10-27 07:51:16 +01:00
Sebastian Huber
1736aea563 user: Rename files to match the chapter index 2020-10-27 07:49:40 +01:00
Sebastian Huber
abc9c4498d eng: Replace spec2doc.py with spec2modules.py
Update #3715.
2020-10-24 12:15:15 +02:00
Chris Johns
25525dc3ac user/beagle: Add debug hardware mod 2020-10-19 14:27:19 +11:00
Sebastian Huber
4aae24d5b5 c-user: Generate I/O 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-10-11 15:26:38 +02:00
Sebastian Huber
bcf4a95ae3 eng: Add placement link role
Update #3715.
2020-10-11 15:19:19 +02:00
Sebastian Huber
c18215c8e8 eng: Move index-entries to all interfaces
Update #3715.
2020-10-11 15:19:19 +02:00
Sebastian Huber
dd97e25faf Improve file header comment in generated files 2020-10-11 15:19:19 +02:00
Sebastian Huber
400d51300f eng: Remove explicit figure class
This makes the legend left justified.
2020-10-09 07:59:47 +02:00
Sebastian Huber
708a5a4ba6 images: Fix bld-deps.png size 2020-10-08 08:10:56 +02:00
Sebastian Huber
8c6414a795 eng: Add proper figure titles
The first paragraph of a figure directive block is the figure title.
2020-10-08 08:07:10 +02:00
Sebastian Huber
9555e7cca7 user: Fix RTEMS release URLs 2020-10-06 11:10:11 +02:00
Kinsey Moore
281be0c1eb Add AArch64 documentation 2020-10-05 16:14:47 -05:00
Kinsey Moore
d75b31f1e2 cpu-supplement: Fix formatting and missing words 2020-10-05 16:14:47 -05:00
Sebastian Huber
9628dfde43 eng: Clarify stlib build attribute
Update #4107.
2020-10-01 07:37:04 +02:00
Sebastian Huber
e70aebd4d9 eng: Fix typo 2020-09-28 09:12:32 +02:00
Sebastian Huber
647bfdd728 c-user: Fix use of getchark() and rtems_putc() 2020-09-28 09:12:32 +02:00
Sebastian Huber
2fb86e27ce user: Add migration hints from old build system
Update #3818.
2020-09-25 18:56:28 +02:00
Gedare Bloom
5a206711c0 i386: tweak grammar and style 2020-09-21 11:41:20 -06:00