85 Commits

Author SHA1 Message Date
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
Sebastian Huber
47e1f6e06b Document CONFIGURE_RECORD_INTERRUPTS_ENABLED
Close #4769.
2022-12-02 10:27:30 +01:00
Sebastian Huber
5eae93cbd1 c-user: Add CONFIGURE_IDLE_TASK_STORAGE_SIZE 2022-10-14 15:04:35 +02:00
Sebastian Huber
bd6ccadea0 c-user: Fix references 2022-10-06 13:16:09 +02:00
Sebastian Huber
2afb8219db c-user: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
Move CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE to the general configuration
options.
2022-10-06 09:20:40 +02:00
Sebastian Huber
0fc5c0336d c-user: Add application config info directives
Close #4267.
Close #4269.
2022-10-04 10:26:38 +02:00
Joel Sherrill
4f9e9e522f c-user/config/face.rst: New file -- add CONFIGURE_POSIX_TIMERS_FACE_BEHAVIOR
Closes #4691.
2022-09-05 09:02:06 +02:00
Sebastian Huber
cf9f212157 c-user: Clarify BSP related configuration settings 2022-08-31 11:38:37 +02:00
Sebastian Huber
657f7440f7 c-user: Update OAR copyright and reformat
These files are generated by a script.
2022-08-11 08:26:30 +02:00
Joel Sherrill
9ba26e7cb2 c-user: Update references to --enable-* configure options.
Also updated list of SMP architectures and added enough lead in
to let users know the source code was the definitive answer.
2022-05-20 08:45:16 -05:00
Sebastian Huber
2f8be4b627 c-user: Document CONFIGURE_SCHEDULER_TABLE_ENTRIES
Update #4524.
2022-02-22 15:09:26 +01:00
Sebastian Huber
1c8ce332e2 c-user: Use rubric for configuration options
Clear the page for each configuration options similar to the directives.

Use a rubric instead of a definition list for the application
configuration options similar to the directive documentation pages.  For
direcives and application configuration options use the same rubric
order.

Generalize value constraints to constraints.

This patch does not change hand written content.
2021-11-17 09:08:53 +01:00
Sebastian Huber
1badb5f479 c-user: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS
Fix default value description.
2021-11-16 08:00:03 +01:00
Kinsey Moore
a0bf79c39a c-user: Update for application CONFIGURE option
This adds the documentation for the application configuration option
CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING.
2021-11-03 08:25:36 -05:00
Sebastian Huber
46dbb6dd7f c-user: Regenerate for IDLE task allocator option
Update #4524.
2021-10-25 08:13:47 +02:00
Joel Sherrill
df5be4c97a task-stack-alloc.rst: Add CONFIGURE_TASK_STACK_FROM_ALLOCATOR
Updates #4524.
2021-10-12 13:46:11 -05:00
Sebastian Huber
ee5718a00a c-user: Change format of external function refs 2021-05-08 10:27:29 +02:00
Sebastian Huber
4565256f24 c-user: Reformat configuration option constraints
If only one constraint is present, then use a single sentence, otherwise
use a list for the constraints.  Format the constraints so that the line
length limit is maintained.
2021-04-29 21:00:43 +02:00
Sebastian Huber
8f1daf7c82 c-user: CONFIGURE_BSP_PREREQUISITE_DRIVERS
Replace copy and paste with a proper description.
2021-04-29 15:02:46 +02:00
Sebastian Huber
33836869da c-user: Add missing "the" 2021-04-29 15:01:46 +02:00
Sebastian Huber
7918ef8df8 c-user: Clarify constraints 2021-03-08 08:28:54 +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
ba633eca2d Improve file header comment in generated files 2021-01-25 06:58:10 +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
ad64ea0bc7 Improve automatically generated warning 2020-11-12 07:42:45 +01:00
Sebastian Huber
51a5138bfe c-user: Add "Generated from ..." comments 2020-11-09 15:04:34 +01:00
Sebastian Huber
dd97e25faf Improve file header comment in generated files 2020-10-11 15:19:19 +02:00
Sebastian Huber
647bfdd728 c-user: Fix use of getchark() and rtems_putc() 2020-09-28 09:12:32 +02:00
Sebastian Huber
28db97275b c-user: CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE
Document this application configuration option.

Update #3959.
2020-09-17 18:14:23 +02:00
Sebastian Huber
a5fe9aad19 c-user: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
Document this application configuration option.

Close #4074.
2020-09-17 18:14:23 +02:00
Sebastian Huber
63764a6d27 c-user: Add automatically generated warning
Update #3994.
2020-08-07 07:15:09 +02:00
Sebastian Huber
db22500e84 c-user: Improve refs and formatting in appl config
The formatting is generated through references within the specification.

Update #3994.
2020-08-07 07:15:09 +02:00
Sebastian Huber
cbb49c602a c-user: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
Improve formatting.
2020-08-07 07:15:09 +02:00
Sebastian Huber
7ee5a7b43d c-user: Unify references in appl config chapter
This is a prepration step to allow the generation of the application
configuration options in Doxygen markup.
2020-07-23 10:10:08 +02:00
Sebastian Huber
5a412bd35f c-user: Fix CONFIGURE_MAXIMUM_PROCESSORS minimum 2020-07-07 13:04:41 +02:00
Sebastian Huber
4c58162d0b c-user: Fix appl config option references 2020-07-06 12:11:00 +02:00
Sebastian Huber
d2d60c54e9 c-user: Sort appl config options by name 2020-07-06 10:06:09 +02:00
Sebastian Huber
a517a09856 c-user: Use * for list items 2020-06-17 16:06:38 +02:00
Sebastian Huber
7b7efb2ed0 c-user: Fix RTEMS_SCHEDULER_EDF_SMP()
Update #3815.
2020-04-15 16:51:09 +02:00
Sebastian Huber
2c7cd341a0 eng: Add documentation guidelines
Start with templates for the application configuration options.

Remove "Format to be followed for making changes in this file" from
c-user.

Update #3910.
2020-04-02 10:23:36 +02:00
Sebastian Huber
c95e3e3114 c-user: Move CONFIGURE_MAXIMUM_PRIORITY
Move this option to the scheduler configuration options.

Update #3836.
2020-04-02 09:46:27 +02:00
Sebastian Huber
39ca06c492 c-user: Clarify config options use
Update #3836.
2020-04-02 09:46:01 +02:00
Sebastian Huber
4032c96da9 c-user: Document all configuration options
Close #2806.
2020-04-01 07:49:15 +02:00
Sebastian Huber
7bad8940ad c-user: Use new template for integer config opts
Try to bring all descriptions up to date.  Add cross-references to
several options.  Clarify configuration value constraints.

Use this template also for initializer type options.

Close #3901.
2020-04-01 07:49:12 +02:00
Sebastian Huber
e26f87497e c-user: Avoid self references
Update #3900.
2020-03-30 11:49:58 +02:00
Sebastian Huber
2f18a530bc c-user: Use new template for feature config opts
Update #3900.
2020-03-30 11:14:41 +02:00