281 Commits

Author SHA1 Message Date
Sebastian Huber
1b2468c5c6 c-user: Remove RTEMS_MP_NOT_CONFIGURED error
Some objects can be created with a local or global scope in a
multiprocessing network. In non-multiprocessing configurations setting
the scope to local or global had no effect since such a system can be
viewed as a multiprocessing network with just one node. One and all
nodes is the same in such a network. However, if multiprocessing was
configured, creation of a global object in a single node network
resulted in an RTEMS_MP_NOT_CONFIGURED error. Remove this error
condition for symmetry to the non-multiprocessing setup. This is in line
with the task affinity behaviour in SMP systems.

Close #4005.
2020-06-18 07:13:13 +02:00
Sebastian Huber
1f8301a972 c-user: Mention possible preemptions
Mention that object create/delete may case the calling task to be
preempted due to the object allocator mutex.
2020-06-18 07:13:13 +02:00
Sebastian Huber
a517a09856 c-user: Use * for list items 2020-06-17 16:06:38 +02:00
Sebastian Huber
b35f3ef44a Use a complete sentence for acronym definitions 2020-06-04 15:06:12 +02:00
Richi Dubey
a23b1fbaa0 Spelling/Grammar Mistakes 2020-05-17 16:48:25 -05:00
Sebastian Huber
a19be8b748 c-user: Document rtems_extension_create()
Close #3953.
2020-04-17 10:03:46 +02:00
Sebastian Huber
7b7efb2ed0 c-user: Fix RTEMS_SCHEDULER_EDF_SMP()
Update #3815.
2020-04-15 16:51:09 +02:00
Sebastian Huber
cd2ed1ad08 c-user: Split deprecated/removed directives chapter 2020-04-15 16:50:32 +02:00
Sebastian Huber
e150e1689a c-user: Add removed directive rtems_clock_get()
Be in line with Task Manager chapter.

Update #2693.
2020-04-15 16:50:30 +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
6f0bc56893 eng: Add glossary terms
Define the following terms:

* assembler language
* C language
* ELF
* interrupt service
* software component
* software unit

Clarify:

* task

Update #3715.
2020-04-01 07:49:15 +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
Sebastian Huber
41ac3da942 c-user: Move "Device Driver Configuration"
Update #3836.
2020-03-12 10:21:29 +01:00
Sebastian Huber
020d2e7e85 c-user: Move "Clustered Scheduler Configuration"
Update #3836.
2020-03-12 10:21:06 +01:00
Sebastian Huber
275f4a049c c-user: Move "General Scheduler Configuration"
Update #3836.
2020-03-12 10:20:34 +01:00
Sebastian Huber
38032b0cca c-user: Move "Idle Task Configuration"
Update #3836.
2020-03-12 10:20:00 +01:00
Sebastian Huber
4bb586beba c-user: Move "BSP Related Configuration Options"
Update #3836.
2020-03-12 10:19:25 +01:00
Sebastian Huber
1af97adca2 c-user: Move "Block Device Cache Configuration"
Update #3836.
2020-03-12 10:18:57 +01:00
Sebastian Huber
c0a70dba61 c-user: Move "Filesystem Configuration"
Update #3836.
2020-03-12 10:18:36 +01:00
Sebastian Huber
4d74cbd8fc c-user: Move "Message Queue Buffer Configuration"
Update #3836.
2020-03-12 10:18:14 +01:00
Sebastian Huber
bdd17e5c0a c-user: Move "Task Stack Allocator Configuration"
Update #3836.
2020-03-12 10:17:38 +01:00
Sebastian Huber
2a761cfbb1 c-user: Move "POSIX Initialization Thread Configuration"
Update #3836.
2020-03-12 10:17:06 +01:00
Sebastian Huber
16b0d3f177 c-user: Move "POSIX API Configuration"
Update #3836.
2020-03-12 10:16:34 +01:00
Sebastian Huber
a9e6a1dbf8 c-user: Move "Classic API Initialization Task Configuration"
Update #3836.
2020-03-12 10:16:10 +01:00
Sebastian Huber
bf995cf8d9 c-user: Move "Classic API Configuration"
Update #3836.
2020-03-12 10:15:37 +01:00