65 Commits

Author SHA1 Message Date
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
Sebastian Huber
0103b685c6 c-user: Fix typo in file name
Update #3836.
2020-03-30 08:49:05 +02:00
Sebastian Huber
62d58f229f c-user: Document new event record config options
Update #3904.
2020-03-24 07:48:40 +01:00
Sebastian Huber
dfe0ec05b9 c-user: Use new template for feature config opts
Try to bring all descriptions up to date.  Add cross-references to
several options.

Close #3900.
2020-03-24 07:48:21 +01:00
Sebastian Huber
79fb6fddf8 c-user: Canonicalize configuration option groups
Update #3836.
2020-03-18 07:32:26 +01:00
Sebastian Huber
7a8d697d73 c-user: Add reference to proxies
Update #3836.
2020-03-17 15:26:46 +01:00
Sebastian Huber
f75e0bee48 c-user: Fix format
Update #3836.
2020-03-17 15:05:57 +01:00
Sebastian Huber
5e54ffe819 c-user: Add configuration option index entry
Update #3836.
2020-03-17 15:05:32 +01:00
Sebastian Huber
c3ebd832d2 c-user: Fix sorting in filesystem configuration
Update #3836.
2020-03-17 14:41:37 +01:00
Sebastian Huber
5fb9a1c75d c-user: Add missing configuration option notes
Update #3836.
2020-03-17 14:23:41 +01:00
Sebastian Huber
f3076bcd52 c-user: Sort configuration options alphabetically
Update #3836.
2020-03-17 14:11:26 +01:00
Sebastian Huber
1ce24d319a c-user: Obsolete CONFIGURE_MAXIMUM_DEVICES
Close #3898.
2020-03-13 13:27:30 +01:00
Sebastian Huber
ccc58a5c66 c-user: Fix typos 2020-03-13 13:27:16 +01:00
Sebastian Huber
b34f2deba8 c-user: Reorder configuration option groups
Sort the configuration option groups according to the likelihood a user
will define options of a group.

Update #3836.
2020-03-13 13:20:20 +01:00
Sebastian Huber
03a735f896 c-user: Clarify message buffer configuration
The help macro CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE() is not a
configuration option.  Move it into the documentatation of the
CONFIGURE_MESSAGE_BUFFER_MEMORY configuration option.  Move this option
to the general system configuration group.

Update #3836.
2020-03-13 13:20:20 +01:00
Sebastian Huber
a7991aebae c-user: Add copyright information
Add copyright information according to commit in RTEMS main repository:

    commit e53aae2676c42cda521328504f82d26c33827021
    Author: Gedare Bloom <gedare@rtems.org>
    Date:   Mon Mar 26 16:42:38 2012 -0400

    confdefs: Add declaration for unlimited objects.

    Adds to confdefs a way to specify rtems_resource_unlimited for classic and
    posix objects using a new macro CONFIGURE_OBJECTS_UNLIMITED.
    Use CONFIGURE_OBJECTS_ALLOCATION_SIZE to declare the allocation size for
    extending the set of objects at runtime. Updates the unlimited sample
    to demonstrate how to use the new macros. Also adds new documentation in
    the C User's Manual regarding configuring with unlimited objects.
2020-03-13 13:20:20 +01:00
Sebastian Huber
88dd013b42 c-user: Move "Obsolete Configuration Options"
Update #3836.
2020-03-12 10:22:33 +01:00
Sebastian Huber
1fd339b391 c-user: Move "Ada Configuration"
Update #3836.
2020-03-12 10:22:32 +01:00
Sebastian Huber
a388de9416 c-user: Move "Event Recording Configuration"
Update #3836.
2020-03-12 10:22:31 +01:00
Sebastian Huber
b71fb436fd c-user: Move "PCI Library Configuration"
Update #3836.
2020-03-12 10:22:16 +01:00
Sebastian Huber
088a1f856f c-user: Move "Multiprocessing Configuration"
Update #3836.
2020-03-12 10:21:51 +01:00