Notice: We have migrated to GitLab launching 2024-05-01 see here: https://gitlab.rtems.org/

#3836 closed task (fixed)

Specify the application configuration options

Reported by: Sebastian Huber Owned by: Sebastian Huber
Priority: normal Milestone: 5.1
Component: config Version: 5
Severity: normal Keywords: qualification
Cc: Blocked By: #2806, #3900, #3901
Blocking: #3923, #3924

Description (last modified by Sebastian Huber)

The application configuration is currently specified by the RTEMS Classic API Guide, the test cases, and the implementation. Add the application configuration to specification items maintained by Doorstop to "spec/acfg" in a repository. Generate the documentation from the specification items.

The specification and the generator scripts are contained in:

https://git.rtems.org/sebh/rtems-qual.git

Change History (53)

comment:1 Changed on 12/10/19 at 12:25:17 by Sebastian Huber

Description: modified (diff)

comment:2 Changed on 12/11/19 at 08:07:31 by Sebastian Huber <sebastian.huber@…>

In [changeset:"bc9ce6526bdce06b82355dfb9c95e152094d69a3/rtems-docs" bc9ce65/rtems-docs]:

c-user: Move basic system configuration

Move the basic system configuration to the front. Rename it to "General
System Configuration".

Update #3836.

comment:3 Changed on 12/11/19 at 08:07:33 by Sebastian Huber <sebastian.huber@…>

In [changeset:"9d2081649afdbba3e4e59a739eaba43961e8c7bc/rtems-docs" 9d20816/rtems-docs]:

c-user: Move unlimited options to general config

Update #3836.

comment:4 Changed on 12/11/19 at 08:07:35 by Sebastian Huber <sebastian.huber@…>

In [changeset:"3a3271eb268547afe8aa8b60e89a7dc1399867e5/rtems-docs" 3a3271e/rtems-docs]:

c-user: Move unlimited configuration options

Rename unlimited subsection headers.

Update #3836.

comment:5 Changed on 12/11/19 at 08:07:38 by Sebastian Huber <sebastian.huber@…>

In [changeset:"a184ff463fd82092714f48468c9cfd0601c359ca/rtems-docs" a184ff4/rtems-docs]:

c-user: Move CONFIGURE_MEMORY_OVERHEAD

Move CONFIGURE_MEMORY_OVERHEAD to general system configuration.
Remove now empty "Seldom Used Configuration Parameters" section.

Update #3836.

comment:6 Changed on 12/11/19 at 08:07:40 by Sebastian Huber <sebastian.huber@…>

In [changeset:"579d6f2def5a0d026b6ba2a866bc8fea96c25038/rtems-docs" 579d6f2/rtems-docs]:

c-user: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS

Move CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS to general system
configuration. Remove now empty "C Library Support Configuration"
section.

Update #3836.

comment:7 Changed on 03/06/20 at 15:28:34 by Sebastian Huber

Blocked By: 3900, 3901 added

comment:8 Changed on 03/09/20 at 06:43:14 by Sebastian Huber <sebastian.huber@…>

In [changeset:"851e4df3db75f23e798370a1be5315fbf1091f14/rtems-docs" 851e4df/rtems-docs]:

c-user: Remove copyright from Petr Benes

The content introduced by a commit in the RTEMS main repository

commit 418de420a05609ba8919822b553706963a8d3a7b
Author: Joel Sherrill <joel.sherrill@…>
Date: Wed Oct 5 19:59:47 2011 +0000

2011-10-05 Joel Sherrill <joel.sherrill@…>

Petr Benes <benesp16@…>

PR 1912/doc

  • user/conf.t, user/schedule.t: Rework to add scheduler specific information.

is no longer in this file. According to the file history, this was the
only content introduced by Petr Benes. Also during the relicensing of
the documentation to CC-BY-SA-4.0 in 2016 it was proclaimed that OAR was
the only copyright holder of the RTEMS documentation present in the
RTEMS main repository.

Update #3836.

comment:9 Changed on 03/09/20 at 06:43:16 by Sebastian Huber <sebastian.huber@…>

In [changeset:"a174ae4bfa609b4749463ea91322a88eb7642e10/rtems-docs" a174ae4/rtems-docs]:

c-user: Clarify BSP related configuration options

Sort options alphabetically.

Update #3836.

comment:10 Changed on 03/09/20 at 06:43:19 by Sebastian Huber <sebastian.huber@…>

In [changeset:"988e7ca06358f95c2eace3157523ac35cf8a111f/rtems-docs" 988e7ca/rtems-docs]:

c-user: Clarify message queue configuration

Update #3836.

comment:11 Changed on 03/09/20 at 06:43:21 by Sebastian Huber <sebastian.huber@…>

In [changeset:"e3f68191afdc4bcc903dc14a598fa0b79b05f745/rtems-docs" e3f6819/rtems-docs]:

c-user: Canonicalize configuration section names

Update #3836.

comment:12 Changed on 03/09/20 at 06:43:23 by Sebastian Huber <sebastian.huber@…>

In [changeset:"7a414f92631dd356f9dea27f1a210bcf1acf46f9/rtems-docs" 7a414f9/rtems-docs]:

c-user: Sort configuration options alphabetically

Update #3836.

comment:13 Changed on 03/09/20 at 06:43:25 by Sebastian Huber <sebastian.huber@…>

In [changeset:"c078afb63796a4c079787a6835ca164a420102c8/rtems-docs" c078afb/rtems-docs]:

c-user: Minor format fixes

Update #3836.

comment:14 Changed on 03/12/20 at 09:32:40 by Sebastian Huber <sebastian.huber@…>

In [changeset:"a526872600d6df878fc55a7ac2d5d6bb079d095e/rtems-docs" a526872/rtems-docs]:

c-user: Split up configuring_a_system.rst

Introduce an index file for this chapter. This helps to generate some
sections from the specification in the future. Start with moving
"Introduction" up to "Unlimited Objects" to a new file.

Update #3836.

comment:15 Changed on 03/12/20 at 09:32:42 by Sebastian Huber <sebastian.huber@…>

In [changeset:"ac9d49d53531e309ef2dc57fcd68fbd999838bd3/rtems-docs" ac9d49d/rtems-docs]:

c-user: Move "General System Configuration"

Update #3836.

comment:16 Changed on 03/12/20 at 09:32:44 by Sebastian Huber <sebastian.huber@…>

In [changeset:"bf995cf8d93d384926d1084378d6e0ca4b77f8f8/rtems-docs" bf995cf/rtems-docs]:

c-user: Move "Classic API Configuration"

Update #3836.

comment:17 Changed on 03/12/20 at 09:32:46 by Sebastian Huber <sebastian.huber@…>

In [changeset:"a9e6a1dbf8bf840fc880e1be0fa8468a5acf921e/rtems-docs" a9e6a1d/rtems-docs]:

c-user: Move "Classic API Initialization Task Configuration"

Update #3836.

comment:18 Changed on 03/12/20 at 09:32:48 by Sebastian Huber <sebastian.huber@…>

In [changeset:"16b0d3f177a610a44289ab74208268928654e17a/rtems-docs" 16b0d3f/rtems-docs]:

c-user: Move "POSIX API Configuration"

Update #3836.

comment:19 Changed on 03/12/20 at 09:32:50 by Sebastian Huber <sebastian.huber@…>

In [changeset:"2a761cfbb198929d16d19771c140bc1802ede521/rtems-docs" 2a761cf/rtems-docs]:

c-user: Move "POSIX Initialization Thread Configuration"

Update #3836.

comment:20 Changed on 03/12/20 at 09:32:52 by Sebastian Huber <sebastian.huber@…>

In [changeset:"bdd17e5c0a5ca19b6b8a2c5f4a19d64368af0b9a/rtems-docs" bdd17e5/rtems-docs]:

c-user: Move "Task Stack Allocator Configuration"

Update #3836.

comment:21 Changed on 03/12/20 at 09:32:55 by Sebastian Huber <sebastian.huber@…>

In [changeset:"4d74cbd8fc988de71e89ac2fa651b01d63a1f2df/rtems-docs" 4d74cbd/rtems-docs]:

c-user: Move "Message Queue Buffer Configuration"

Update #3836.

comment:22 Changed on 03/12/20 at 09:32:57 by Sebastian Huber <sebastian.huber@…>

In [changeset:"c0a70dba6154f605226b2e1f763875f8d00f9a7b/rtems-docs" c0a70db/rtems-docs]:

c-user: Move "Filesystem Configuration"

Update #3836.

comment:23 Changed on 03/12/20 at 09:32:59 by Sebastian Huber <sebastian.huber@…>

In [changeset:"1af97adca298788caa2b5872b4d66a9258e79a5e/rtems-docs" 1af97ad/rtems-docs]:

c-user: Move "Block Device Cache Configuration"

Update #3836.

comment:24 Changed on 03/12/20 at 09:33:01 by Sebastian Huber <sebastian.huber@…>

In [changeset:"4bb586bebaf38b8a1d3466278b661332d54841ea/rtems-docs" 4bb586b/rtems-docs]:

c-user: Move "BSP Related Configuration Options"

Update #3836.

comment:25 Changed on 03/12/20 at 09:33:03 by Sebastian Huber <sebastian.huber@…>

In [changeset:"38032b0ccad4bde197a832518f9d64df33e97b1d/rtems-docs" 38032b0/rtems-docs]:

c-user: Move "Idle Task Configuration"

Update #3836.

comment:26 Changed on 03/12/20 at 09:33:05 by Sebastian Huber <sebastian.huber@…>

In [changeset:"275f4a049c2f21dd3aab33201c4b76a5ece1ed6d/rtems-docs" 275f4a0/rtems-docs]:

c-user: Move "General Scheduler Configuration"

Update #3836.

comment:27 Changed on 03/12/20 at 09:33:07 by Sebastian Huber <sebastian.huber@…>

In [changeset:"020d2e7e85baeca0d8b6d73536f1d30376e34a12/rtems-docs" 020d2e7/rtems-docs]:

c-user: Move "Clustered Scheduler Configuration"

Update #3836.

comment:28 Changed on 03/12/20 at 09:33:09 by Sebastian Huber <sebastian.huber@…>

In [changeset:"41ac3da942efd60525363b8fe4fbf1ee04eac51c/rtems-docs" 41ac3da/rtems-docs]:

c-user: Move "Device Driver Configuration"

Update #3836.

comment:29 Changed on 03/12/20 at 09:33:11 by Sebastian Huber <sebastian.huber@…>

In [changeset:"088a1f856f6e740700bb6f2d3b2ab5ecc205e5ea/rtems-docs" 088a1f8/rtems-docs]:

c-user: Move "Multiprocessing Configuration"

Update #3836.

comment:30 Changed on 03/12/20 at 09:33:13 by Sebastian Huber <sebastian.huber@…>

In [changeset:"b71fb436fd085b647c0c39a08d30226ff5267edc/rtems-docs" b71fb43/rtems-docs]:

c-user: Move "PCI Library Configuration"

Update #3836.

comment:31 Changed on 03/12/20 at 09:33:15 by Sebastian Huber <sebastian.huber@…>

In [changeset:"a388de94168c1dc7544569e2f329a301d28182bf/rtems-docs" a388de9/rtems-docs]:

c-user: Move "Event Recording Configuration"

Update #3836.

comment:32 Changed on 03/12/20 at 09:33:17 by Sebastian Huber <sebastian.huber@…>

In [changeset:"1fd339b391d81ec82fca6fb28b0bc68b9b638a61/rtems-docs" 1fd339b/rtems-docs]:

c-user: Move "Ada Configuration"

Update #3836.

comment:33 Changed on 03/12/20 at 09:33:19 by Sebastian Huber <sebastian.huber@…>

In [changeset:"88dd013b42bc731e1892802eefe1768ccbd5898d/rtems-docs" 88dd013/rtems-docs]:

c-user: Move "Obsolete Configuration Options"

Update #3836.

comment:34 Changed on 03/13/20 at 12:29:19 by Sebastian Huber <sebastian.huber@…>

In [changeset:"03a735f89611d7fc031190b0e460f062a25a42d4/rtems-docs" 03a735f/rtems-docs]:

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.

comment:35 Changed on 03/13/20 at 12:29:21 by Sebastian Huber <sebastian.huber@…>

In [changeset:"b34f2deba836730ebf21dac5ee435ab505573d29/rtems-docs" b34f2de/rtems-docs]:

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.

comment:36 Changed on 03/17/20 at 13:13:47 by Sebastian Huber <sebastian.huber@…>

In [changeset:"f3076bcd52ad1acf4ed5a0147a4ade659c6f8716/rtems-docs" f3076bc/rtems-docs]:

c-user: Sort configuration options alphabetically

Update #3836.

comment:37 Changed on 03/17/20 at 13:42:18 by Sebastian Huber <sebastian.huber@…>

In [changeset:"5fb9a1c75d708add22f4ca27b3920bd16bbb99c1/rtems-docs" 5fb9a1c/rtems-docs]:

c-user: Add missing configuration option notes

Update #3836.

comment:38 Changed on 03/17/20 at 13:42:20 by Sebastian Huber <sebastian.huber@…>

In [changeset:"c3ebd832d20e3cc93822288bbf14c7027e9dade9/rtems-docs" c3ebd83/rtems-docs]:

c-user: Fix sorting in filesystem configuration

Update #3836.

comment:39 Changed on 03/17/20 at 14:05:46 by Sebastian Huber <sebastian.huber@…>

In [changeset:"5e54ffe8191970ff496a03176128e2880a447314/rtems-docs" 5e54ffe/rtems-docs]:

c-user: Add configuration option index entry

Update #3836.

comment:40 Changed on 03/17/20 at 14:06:11 by Sebastian Huber <sebastian.huber@…>

In [changeset:"f75e0bee4811bb33210a48fe573716c0bb19d5a1/rtems-docs" f75e0be/rtems-docs]:

c-user: Fix format

Update #3836.

comment:41 Changed on 03/17/20 at 14:27:00 by Sebastian Huber <sebastian.huber@…>

In [changeset:"7a8d697d7318f3ab9c905433e52f7ae6334f8617/rtems-docs" 7a8d697/rtems-docs]:

c-user: Add reference to proxies

Update #3836.

comment:42 Changed on 03/18/20 at 06:32:46 by Sebastian Huber <sebastian.huber@…>

In [changeset:"79fb6fddf831586231b0b101790b59f11e708bb5/rtems-docs" 79fb6fd/rtems-docs]:

c-user: Canonicalize configuration option groups

Update #3836.

comment:43 Changed on 03/30/20 at 06:49:24 by Sebastian Huber <sebastian.huber@…>

In [changeset:"0103b685c60eab68ce04951ecc515832e28bbad0/rtems-docs" 0103b68/rtems-docs]:

c-user: Fix typo in file name

Update #3836.

comment:44 Changed on 04/02/20 at 07:47:20 by Sebastian Huber <sebastian.huber@…>

In [changeset:"39ca06c4921ae713a5dfc2d16d419a1db55e0365/rtems-docs" 39ca06c/rtems-docs]:

c-user: Clarify config options use

Update #3836.

comment:45 Changed on 04/02/20 at 07:47:22 by Sebastian Huber <sebastian.huber@…>

In [changeset:"c95e3e31141374701e9f32abef0a5b7dedc42960/rtems-docs" c95e3e3/rtems-docs]:

c-user: Move CONFIGURE_MAXIMUM_PRIORITY

Move this option to the scheduler configuration options.

Update #3836.

comment:46 Changed on 04/02/20 at 08:27:13 by Sebastian Huber

Blocked By: 2806 added

comment:47 Changed on 04/02/20 at 08:32:33 by Sebastian Huber

Blocking: 3923 added

comment:48 Changed on 04/02/20 at 08:35:24 by Sebastian Huber

Blocking: 3924 added

comment:49 Changed on 04/02/20 at 08:40:52 by Sebastian Huber

Description: modified (diff)

comment:50 Changed on 04/02/20 at 08:41:43 by Sebastian Huber

Summary: Specify and test application configurationSpecify the application configuration options

comment:51 Changed on 04/03/20 at 06:58:23 by Sebastian Huber <sebastian.huber@…>

In [changeset:"7e33a80da53cf5638c1ca21a70ebae89a4a1f67d/rtems" 7e33a80/rtems]:

config: Remove filesystem entry config options

Remove the following undocumented configuration options:

  • CONFIGURE_FILESYSTEM_ENTRY_DOSFS
  • CONFIGURE_FILESYSTEM_ENTRY_FTPFS
  • CONFIGURE_FILESYSTEM_ENTRY_IMFS
  • CONFIGURE_FILESYSTEM_ENTRY_JFFS2
  • CONFIGURE_FILESYSTEM_ENTRY_NFS
  • CONFIGURE_FILESYSTEM_ENTRY_RFS
  • CONFIGURE_FILESYSTEM_ENTRY_TFTPFS

Update #3836.

comment:52 Changed on 04/03/20 at 06:59:38 by Sebastian Huber

Resolution: fixed
Status: assignedclosed

All configuration options are now documented and specified through the documentation.

comment:53 Changed on 06/23/21 at 07:16:03 by Sebastian Huber

Keywords: qualification added
Note: See TracTickets for help on using tickets.