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

1300 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Sebastian Huber
7158449cc5 eng: Update application configuration how-to 
Change paths to be in line with the actual specification.  Fix group
membership link role.

Update #3715.
 2023-05-04 15:53:12 +02:00
Sebastian Huber
77e8b566b7 eng: Add optional floating-point number type 
Update #3715.
 2023-05-04 15:52:43 +02:00
Sebastian Huber
98172bc9a4 eng: Use type refinement for validation method 
Update #3715.
 2023-05-04 15:51:36 +02:00
Sebastian Huber
c81a24418a eng: Add conditional build dependencies 
Update #3715.
 2023-05-04 15:51:32 +02:00
Sebastian Huber
5928d04c84 eng: Generalize external references 
Use a common subtype for external references of interfaces and
requirements.  Add specializations for document and file references.

Update #3715.
 2023-05-04 15:50:54 +02:00
Sebastian Huber
6dc190beea eng: Rework performance meansurement items 
Use links to specify runtime performance limits in target-specific
items.  Clarify wording.

Update #3715.
 2023-05-04 15:50:54 +02:00
Utkarsh Verma
6baa2d628b bsp-howto: Fix grammar and improve coherence. 2023-04-14 08:36:55 -06:00
Alan Cudmore
cbeaec94e1 docs/user: add docs for riscv/kendrytek210 BSP variant 
This patch adds the documentation for building and running RTEMS on the Kendryte K210 RISC-V SoC.
The generic riscv introducion was re-arranged to list the multilib variants then the specific
hardware targets. In addition a couple of errors were fixed for the generic QEMU commands.

V2 corrected a typo, expanded K210 Console UART parameters, and addded a hyperlink to renode.io install
instructions.

V3 clarified the multilib variant description, clarified the multilib variant reference platform, and
corrected capitalization on SiFive.

V4 improves the instructions for running the K210 BSP on the Renode.io simulator.

V5 cleaned up the text to be no more than 80 characters per line.

V6 applied word wrap to paragraphs and replaced hard coded RTEMS major versions with macros.

Closes #4876
 2023-04-11 16:03:27 -05:00
Joel Sherrill
1ac52ce798 user/bsps/bsps-riscv.rst: Revert v2 of patch 2023-04-11 16:03:24 -05:00
Alan Cudmore
e38a900842 docs/user: add docs for riscv/kendrytek210 BSP variant 
This patch adds the documentation for building and running RTEMS on the Kendryte K210
RISC-V SoC. The generic riscv introducion was re-arranged to list the multilib variants
then the specific hardware targets. In addition a couple of errors were fixed for the
generic QEMU commands.

V2 corrected a typo, expanded K210 Console UART parameters, and addded a hyperlink
to renode.io install instructions.

Closes #4876
 2023-04-11 13:28:23 -05:00
Kinsey Moore
e2d2d4a124 c-user/smp: Fix item rendering 2023-03-28 09:23:12 -05:00
Kinsey Moore
44bf1ac13b user/zynqmp: Fix SDHCI wording 2023-03-28 09:23:12 -05:00
Kinsey Moore
3b33dd3cd9 eng/vc-users.rst: Fix markup for subjectprefix 
This was missing a line and causing the code block to not appear in the
rendered document.
 2023-03-23 10:34:38 -05:00
Ruturaj Nanoti
cdb6208dfc user/bsps/arm: Fix a typo in the stm32h7 BSP documentation 2023-03-15 10:17:43 +01:00
Kinsey Moore
fd6d862033 c-user/chains: Correct iteration example code 
Casting the node returned by rtems_chain_head is incorrect. That node is
owned by the control structure and use of it post-cast could cause
memory corruption. Instead, use rtems_chain_first which returns the
node after the head node. This also corrects node->next to
rtems_chain_next(node) which makes better use of the API.
 2023-03-09 09:16:12 -06:00
Joel Sherrill
2f7ebf719d waf: Update to waf 2.0.25 
Updates #4860
 2023-02-20 11:56:46 -06:00
Sebastian Huber
3bda7ddbfa eng: Remove test-suite-name attribute 2023-02-16 08:44:33 +01:00
Sebastian Huber
248168db70 c-user: Use configuration option references 2023-02-14 16:14:47 +01:00
Sebastian Huber
79d05f58d7 c-user: Document CONFIGURE_INIT 2023-02-14 16:14:47 +01:00
Sebastian Huber
e9603bfb7c c-user: Fix header file path 2023-02-14 16:14:47 +01:00
Sebastian Huber
ee8e1fe7ac c-user: Harmonize header file references 2023-02-14 16:14:47 +01:00
Sebastian Huber
63e175f65c c-user: Remove obsolete config section 
This commit already clarified that the defines of the removed section
are optional BSP provided default values and not application
configuration options:

commit cf9f2121577b11f8eab5e49c48173c46cf09c627
Author: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date:   Wed Nov 17 08:46:56 2021 +0100

    c-user: Clarify BSP related configuration settings
 2023-02-14 16:14:47 +01:00
Kinsey Moore
cb375249c5 eng: Add ObjectsItem details 
This adds a section on adding ObjectsItems.
 2023-02-09 08:52:36 +01:00
Joel Sherrill
68a44b2524 user/hosts/posix.rst: Update Ubuntu instructions to 22.x 
Closes #4821.
 2023-01-24 18:08:09 -06:00
Martin Erik Werner
c4df72c2f1 c-user/message/directives.rst: byes->bytes typo 2023-01-23 08:54:41 +01:00
Sebastian Huber
0b0dd797fa eng: Use a recommendation for requirement texts 
Update #3715.
 2023-01-23 07:53:19 +01:00
Sebastian Huber
f690480e21 eng: Add reason to test program state 2023-01-23 07:53:19 +01:00
Sebastian Huber
f3811f29a8 eng: Improve build option default values 
Merge "default" and "default-by-variant" attributes.  Use an enabled-by
expression to select the default value.
 2023-01-23 07:53:19 +01:00
Sebastian Huber
dc2ea301ea eng: Add more flags to build group item 2023-01-23 07:53:19 +01:00
Joel Sherrill
f48f79dcad c-user/rate-monotonic/background.rst: Correct logically inverted statement 
Also corrected a spot of formatting.

Closes #4781.
 2023-01-13 08:44:26 -06:00
Sebastian Huber
1030fea8ed riscv: Resurrect RISCV_ENABLE_HTIF_SUPPORT 
Updates #4779.
 2023-01-12 08:21:46 +01:00
Hesham Almatary
8c6f631229 RISC-V: Update docs on running on QEMU and Spike 2023-01-09 18:23:37 +00:00
Hesham Almatary
763c97df20 RISC-V: Remove the RISCV_ENABLE_HTIF_SUPPORT option 
Closes #4779
 2023-01-09 18:23:31 +00:00
Hesham Almatary
6794f0166c Docs: RISC-V Update rv64* BSPs to medany and 0x80000000 start address 
Closes #4775
 2023-01-09 18:23:24 +00:00
Joel Sherrill
a3d7dd1b88 eng/vc-users.rst: Add commit message guidance 
Closes #4274.
 2022-12-14 16:48:37 -06:00
Joel Sherrill
32de9ff259 c-user: Add Local vs Global to Key Concepts Chapter 
Add multiple new index entries and cite them where RTEMS_LOCAL
and RTEMS_GLOBAL are cited.

Closes #4453.
 2022-12-07 12:35:19 -06:00
Chris Johns
8f5f371b3d waf: Handle the enable options for singlehtml and ditaa/puml 
Close #4756
 2022-12-07 08:33:41 +11:00
Sebastian Huber
47e1f6e06b Document CONFIGURE_RECORD_INTERRUPTS_ENABLED 
Close #4769.
 2022-12-02 10:27:30 +01:00
Joel Sherrill
5a548472ea user/hosts/windows.rst: flex needs to be installed for msys2 
Closes #4382.
 2022-11-30 17:39:29 -06:00
Joel Sherrill
aaba6e5826 c-user/*: Add trailing parentheses on methods in index which were missing it 
Closes #4766.
 2022-11-30 09:59:20 -06:00
Kinsey Moore
82b3a44cfd user/zynqmp: Add information about CFC-400X 
Add a list of known working hardware and commentary about bitstream
loading for specific hardware.
 2022-11-23 17:34:56 -06:00
Daniel Cederman
0f7e3a6c2f user: Add documentation for leon2 and leon3 BSP 2022-11-15 18:22:37 +01:00
Daniel Cederman
34c40383ab user: Add documentation for NOEL-V BSP 2022-11-15 16:01:41 +01:00
Gedare Bloom
9ef41e4ebd eng, user: update bsp_list to bsplist 2022-11-11 11:58:25 -07:00
Gedare Bloom
168ed2701e eng, user: update bsp_defaults to bspdefaults 2022-11-11 11:58:25 -07:00
Sebastian Huber
0213597d46 c-user: Adjust URL for struct timespec 2022-11-08 07:39:06 +01:00
Matt Joyce
a382919ba6 c-user/clock: Fix typo 2022-11-08 06:59:24 +01:00
Matt Joyce
c881d1e7d8 eng: Fix typos 2022-11-08 06:59:24 +01:00
Matt Joyce
355a65f21f bsp-howto: Specify name of clock driver init func 2022-11-08 06:59:24 +01:00
Sebastian Huber
31199e3a69 Update build system related sections for RTEMS 6 
Update sections which contained the word "bsp_specs".
 2022-11-08 06:59:24 +01:00