summaryrefslogtreecommitdiffstats
path: root/cpukit/doxygen (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doxygen: Fix constraintsSebastian Huber8 days1-2/+3
| | | | | | | Somehow the constraints for CONFIGURE_TICKS_PER_TIMESLICE and CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK got mixed up. Update #4986.
* Do not define CONFIGURE_TICKS_PER_TIMESLICE to 0Sebastian Huber2024-03-201-1/+1
| | | | | | | Unconditionally make a CONFIGURE_TICKS_PER_TIMESLICE value less than or equal to zero an error. Update #4986.
* Ensure ticks per timeslice is greater than zeroZack leung2024-03-141-2/+1
|
* doxygen: Fix link formatSebastian Huber2024-02-161-1/+1
|
* doxygen: CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITYSebastian Huber2023-12-191-1/+29
| | | | | | Document CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY. Update #4961.
* doxygen: Replace and move main pageSebastian Huber2023-10-231-0/+206
| | | | | | | | | | | | | | | Replace the main page with a high level description of the RTEMS feature set similar to: https://docs.rtems.org/branches/master/user/overview/index.html#features The replaced content can be found in the RTEMS Classic API Guide: https://docs.rtems.org/branches/master/c-user/overview.html https://docs.rtems.org/branches/master/c-user/key_concepts.html Update #3705.
* sys: Add files to Doxygen groupSebastian Huber2023-07-261-0/+8
| | | | | | Canonicalize brief descriptions. Update #3707.
* rtems: Link config options and global constructionSebastian Huber2023-07-251-3/+17
|
* doxgen: Document build system provided filesSebastian Huber2023-07-211-0/+82
| | | | Update #3707.
* Update company nameSebastian Huber2023-05-203-3/+3
| | | | | The embedded brains GmbH & Co. KG is the legal successor of embedded brains GmbH.
* doxygen: Add group for FreeBSD kernel header filesSebastian Huber2023-03-171-0/+9
|
* doxygen: Document hash algorithm filesSebastian Huber2023-03-161-0/+149
|
* doxygen: Add groups for related test suitesSebastian Huber2023-03-141-0/+24
|
* doxygen: Add Doxygen files to a groupSebastian Huber2023-02-162-1/+23
| | | | Update #3707.
* doxygen: Document CONFIGURE_INITSebastian Huber2023-02-141-1/+22
|
* doxygen: Fix header file pathSebastian Huber2023-02-141-2/+3
|
* doxygen: Harmonize header file referencesSebastian Huber2023-02-141-6/+6
|
* doxygen: Use @anchor for appl config optionsSebastian Huber2023-02-141-228/+534
| | | | | | | | | | | The application configuration options are documented in "cpukit/doxygen/appl-config.h". Since the application configuration option defines are also present in multiple test program sources, the "#OPTION" references cannot be mapped to a unique definition. Add an anchor for each option and reference it to avoid the issues with the multiple definitions. Update #3994.
* doxygen: Generalize appl config constraintsSebastian Huber2023-02-141-525/+576
| | | | | | | | Rename the constaints section of application configuration options from "Value Constraints" in "Constraints. Adjust the constraint wording accordingly. This is in line with the RTEMS Classic API Guide. Update #3994.
* doxygen: Clarify CONFIGURE_DISABLE_BSP_SETTINGSSebastian Huber2023-02-141-219/+31
| | | | | | | | | | Each BSP may optionally provide default values for some application configuration options. Remove the documentation of these items, since the BSP provided defines are not application configuration options, they are optional default values. Clarify CONFIGURE_DISABLE_BSP_SETTINGS accordingly and move it into the "General System Configuration" group. Update #3994.
* doxygen: Use quotes for href URLsSebastian Huber2023-02-141-55/+55
| | | | Update #3994.
* config: Add CONFIGURE_RECORD_INTERRUPTS_ENABLEDSebastian Huber2022-12-021-0/+23
| | | | | | | | This enables the tracing of interrupt entry/exit events through an application configuration option. The interrupt processing can be viewed with Trace Compass using rtems-record-lttng from the RTEMS Tools. Update #4769.
* config: Add CONFIGURE_IDLE_TASK_STORAGE_SIZESebastian Huber2022-10-141-10/+85
| | | | | | | | | | | | By default, allocate the IDLE task storage areas from the RTEMS Workspace. This avoids having to estimate the thread-local storage size in the default configuration. Add the application configuration option CONFIGURE_IDLE_TASK_STORAGE_SIZE to request a static allocation of the task storage area for IDLE tasks. Update #3835. Update #4524.
* config: Changeable size for IDLE stack allocatorSebastian Huber2022-10-141-1/+1
| | | | | | | | Allow the IDLE stack allocator to change the stack size. This can be used by applications with a very dynamic thread-local storage size to adjust the thread storage area of the IDLE tasks dynamically. Update #4524.
* config: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZESebastian Huber2022-10-061-47/+48
| | | | | Move CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE to the general configuration options.
* config: Document CONFIGURE_POSIX_TIMERS_FACE_BEHAVIORSebastian Huber2022-09-051-0/+49
| | | | Update #4691.
* config: Document CONFIGURE_SCHEDULER_TABLE_ENTRIESSebastian Huber2022-02-221-4/+80
|
* cpukit: Add signal mapping supportKinsey Moore2021-10-291-0/+23
| | | | | | This adds a confdef option allowing an application to request mapping machine exceptions to POSIX signals. This is required for some languages such as Ada.
* rtems: Regenerate for IDLE task allocator optionSebastian Huber2021-10-251-1/+27
| | | | Update #4524.
* appl-config: Add missing "the"Sebastian Huber2021-04-301-11/+10
|
* appl-config: CONFIGURE_BSP_PREREQUISITE_DRIVERSSebastian Huber2021-04-301-2/+2
| | | | Replace copy and paste with a proper description.
* appl-config: Reformat option constraintsSebastian Huber2021-04-301-120/+209
| | | | | | 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.
* CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZESebastian Huber2021-03-051-3/+11
| | | | | Ensure that CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE meets the task storage alignment requirement.
* Improve file header comment in generated filesSebastian Huber2021-01-251-3/+7
|
* config: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZESebastian Huber2020-11-271-2/+4
| | | | | | Fix the documentation. Update #4181.
* config: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZESebastian Huber2020-11-261-0/+63
| | | | | | | | | | In order to better support applications which use the new rtems_task_construct() directive add the CONFIGURE_INIT_TASK_CONSTURCT_STORAGE_SIZE configuration option. If this option is specified, then the Classic API initialization task is constructed with rtems_task_construct(). Update #4181.
* doxygen: Use common syntax for groupsSebastian Huber2020-11-231-3/+4
|
* doxygen: Rename Internal to ImplementationSebastian Huber2020-11-231-2/+2
| | | | | | Use a top-level implementation group to gather implementation related files. The use of "Impl" is shorter and matches with the *impl.h file names.
* Improve automatically generated warningSebastian Huber2020-11-121-5/+4
|
* doxygen: Add "Generated from ..." commentsSebastian Huber2020-10-081-4/+339
| | | | | | Improve file header comment. Update #3994.
* doxygen: Fix use of getchark() and rtems_putc()Sebastian Huber2020-09-281-6/+6
|
* doxygen: Wrap long linesSebastian Huber2020-09-181-10/+20
|
* validation: Add general purpose test suiteSebastian Huber2020-09-171-0/+6
| | | | | | | | | Add a general purpose test suite for validation tests. This is the first test suite generated from a specification item in the rtems-central repository. Update #3959.
* doxygen: Move top-level group definitionsSebastian Huber2020-09-171-0/+44
| | | | Update #3959.
* rtems: Add rtems_task_construct()Sebastian Huber2020-09-171-0/+22
| | | | | | | | | | | | | | | | | In contrast to rtems_task_create() this function constructs a task with a user-provided task storage area. The new directive uses a configuration structure instead of individual parameters. Add RTEMS_TASK_STORAGE_SIZE() to calculate the recommended size of a task storage area based on the task attributes and the size dedicated to the task stack and thread-local storage. This macro may allow future extensions without breaking the API. Add application configuration option CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE to adjust RTEMS Workspace size estimate. Update #3959.
* CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZESebastian Huber2020-09-171-0/+37
| | | | | | | | | | | Add this application configuration option. This configuration option can be used to reserve space for the dynamic linking of modules with thread-local storage objects. Add RTEMS_TASK_STORAGE_ALIGNMENT to define the minium alignment of a thread-local storage size. Update #4074.
* Document application configuration optionsSebastian Huber2020-08-071-0/+4191
Add a new directory for Doxygen-specific documentation content. Add a Doxygen only header file containing documentation of the application configuration options. The header file is generated from specification items. Close #3994.
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 12:15:27 +0000