summaryrefslogtreecommitdiffstats
path: root/cpukit/doxygen (unfollow)
Commit message (Collapse)AuthorFilesLines
2024-04-17doxygen: Fix constraintsSebastian Huber1-2/+3
Somehow the constraints for CONFIGURE_TICKS_PER_TIMESLICE and CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK got mixed up. Update #4986.
2024-03-20Do not define CONFIGURE_TICKS_PER_TIMESLICE to 0Sebastian Huber1-1/+1
Unconditionally make a CONFIGURE_TICKS_PER_TIMESLICE value less than or equal to zero an error. Update #4986.
2024-03-14Ensure ticks per timeslice is greater than zeroZack leung1-2/+1
2024-02-16doxygen: Fix link formatSebastian Huber1-1/+1
2023-12-19doxygen: CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITYSebastian Huber1-1/+29
Document CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY. Update #4961.
2023-10-23doxygen: Replace and move main pageSebastian Huber1-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.
2023-07-26sys: Add files to Doxygen groupSebastian Huber1-0/+8
Canonicalize brief descriptions. Update #3707.
2023-07-25rtems: Link config options and global constructionSebastian Huber1-3/+17
2023-07-21doxgen: Document build system provided filesSebastian Huber1-0/+82
Update #3707.
2023-05-20Update company nameSebastian Huber3-3/+3
The embedded brains GmbH & Co. KG is the legal successor of embedded brains GmbH.
2023-03-17doxygen: Add group for FreeBSD kernel header filesSebastian Huber1-0/+9
2023-03-16doxygen: Document hash algorithm filesSebastian Huber1-0/+149
2023-03-14doxygen: Add groups for related test suitesSebastian Huber1-0/+24
2023-02-16doxygen: Add Doxygen files to a groupSebastian Huber2-1/+23
Update #3707.
2023-02-14doxygen: Document CONFIGURE_INITSebastian Huber1-1/+22
2023-02-14doxygen: Fix header file pathSebastian Huber1-2/+3
2023-02-14doxygen: Harmonize header file referencesSebastian Huber1-6/+6
2023-02-14doxygen: Use @anchor for appl config optionsSebastian Huber1-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.
2023-02-14doxygen: Generalize appl config constraintsSebastian Huber1-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.
2023-02-14doxygen: Clarify CONFIGURE_DISABLE_BSP_SETTINGSSebastian Huber1-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.
2023-02-14doxygen: Use quotes for href URLsSebastian Huber1-55/+55
Update #3994.
2022-12-02config: Add CONFIGURE_RECORD_INTERRUPTS_ENABLEDSebastian Huber1-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.
2022-10-14config: Add CONFIGURE_IDLE_TASK_STORAGE_SIZESebastian Huber1-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.
2022-10-14config: Changeable size for IDLE stack allocatorSebastian Huber1-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.
2022-10-06config: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZESebastian Huber1-47/+48
Move CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE to the general configuration options.
2022-09-05config: Document CONFIGURE_POSIX_TIMERS_FACE_BEHAVIORSebastian Huber1-0/+49
Update #4691.
2022-02-22config: Document CONFIGURE_SCHEDULER_TABLE_ENTRIESSebastian Huber1-4/+80
2021-10-29cpukit: Add signal mapping supportKinsey Moore1-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.
2021-10-25rtems: Regenerate for IDLE task allocator optionSebastian Huber1-1/+27
Update #4524.
2021-04-30appl-config: Add missing "the"Sebastian Huber1-11/+10
2021-04-30appl-config: CONFIGURE_BSP_PREREQUISITE_DRIVERSSebastian Huber1-2/+2
Replace copy and paste with a proper description.
2021-04-30appl-config: Reformat option constraintsSebastian Huber1-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.
2021-03-05CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZESebastian Huber1-3/+11
Ensure that CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE meets the task storage alignment requirement.
2021-01-25Improve file header comment in generated filesSebastian Huber1-3/+7
2020-11-27config: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZESebastian Huber1-2/+4
Fix the documentation. Update #4181.
2020-11-26config: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZESebastian Huber1-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.
2020-11-23doxygen: Use common syntax for groupsSebastian Huber1-3/+4
2020-11-23doxygen: Rename Internal to ImplementationSebastian Huber1-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.
2020-11-12Improve automatically generated warningSebastian Huber1-5/+4
2020-10-08doxygen: Add "Generated from ..." commentsSebastian Huber1-4/+339
Improve file header comment. Update #3994.
2020-09-28doxygen: Fix use of getchark() and rtems_putc()Sebastian Huber1-6/+6
2020-09-18doxygen: Wrap long linesSebastian Huber1-10/+20
2020-09-17validation: Add general purpose test suiteSebastian Huber1-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.
2020-09-17doxygen: Move top-level group definitionsSebastian Huber1-0/+44
Update #3959.
2020-09-17rtems: Add rtems_task_construct()Sebastian Huber1-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.
2020-09-17CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZESebastian Huber1-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.
2020-08-07Document application configuration optionsSebastian Huber1-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-05-05 06:24:57 +0000