1043 Commits

Author SHA1 Message Date
Sebastian Huber
b580a6da14 eng: Add build/appl config clauses to how-to
Update #3715.
2021-03-19 08:20:16 +01:00
Sebastian Huber
239644be82 eng: Update EARS syntax
The document used the EARS syntax from 2009 which slightly changed in
2016, see "Listens Learned (8 Lessons Learned Applying EARS)".  The
optional pre-conditions moved to the state-driven pattern.  This refined
syntax fits better to the action requirements.

Update #3715.
2021-03-19 08:20:16 +01:00
Sebastian Huber
66591316dc c-user: Remove obsolete constraint 2021-03-17 14:01:03 +01:00
Sebastian Huber
f2bbea69af c-user: Update semaphore example
Update #4346.
2021-03-17 14:00:59 +01:00
Meh Mbeh Ida Delphine
a4755f6ee5 eng/vc-users: Set up patch message with repo name
Added instructions on how to set up a patch message with a repo name.

Author:    Meh Mbeh Ida Delphine <idadelm@gmail.com>
Date:      Tue Mar 16 19:11:23 2021 +0100
2021-03-16 13:06:30 -06:00
Jan Sommer
2c2c7de35f user/bsps: Mention fixed console baud rate for zynq 2021-03-16 13:50:08 +01:00
Sebastian Huber
bc0a85723c eng: Clarify how-to for action requirements
Bring how-to in line with current action requirements.

Update #3715.
2021-03-11 07:53:24 +01:00
Sebastian Huber
0518d94f30 eng: Clarify how-to for action requirements
Update #3715.
2021-03-11 06:56:12 +01:00
Sebastian Huber
e05df28643 eng: Clarify how-to for action requirements
Update #3715.
2021-03-08 10:19:34 +01:00
Sebastian Huber
a4b3019d99 eng: Add how-to for action requirements
Update #3715.
2021-03-08 08:28:54 +01:00
Sebastian Huber
7918ef8df8 c-user: Clarify constraints 2021-03-08 08:28:54 +01:00
Kinsey Moore
084a564ba8 user: Update ZynqMP QEMU BSP name
The ZynqMP QEMU BSPs have had _qemu added to their names to better
identify them as QEMU BSPs similar to other BSPs which are meant to run
exclusively on QEMU and not hardware.
2021-03-05 10:46:10 -06:00
Sebastian Huber
fcac22e5b7 eng: Fix typo
Update #3715.
2021-03-02 08:28:48 +01:00
Sebastian Huber
c87d8c2af3 c-user: Generate signal 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-19 07:06:00 +01:00
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