summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-07 08:49:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-07 12:58:52 +0200
commitb29dd738f97901f464400a19510056790807dc47 (patch)
tree12530221be861aad0f8ba217192fc52db98dffd4
parentapplconfig: Use item mapper for substitution (diff)
downloadrtems-central-b29dd738f97901f464400a19510056790807dc47.tar.bz2
spec: Use ${...} references in /if/acfg/*
This allows generation of Sphinx and Doxygen output.
-rw-r--r--spec/if/acfg/appl-disable-filesystem.yml2
-rw-r--r--spec/if/acfg/appl-does-not-need-clock-driver.yml4
-rw-r--r--spec/if/acfg/appl-extra-drivers.yml4
-rw-r--r--spec/if/acfg/appl-needs-clock-driver.yml4
-rw-r--r--spec/if/acfg/appl-needs-console-driver.yml8
-rw-r--r--spec/if/acfg/appl-needs-simple-console-driver.yml10
-rw-r--r--spec/if/acfg/appl-needs-simple-task-console-driver.yml12
-rw-r--r--spec/if/acfg/appl-needs-timer-driver.yml4
-rw-r--r--spec/if/acfg/appl-prerequisite-drivers.yml6
-rw-r--r--spec/if/acfg/ata-driver-task-priority.yml2
-rw-r--r--spec/if/acfg/bdbuf-buffer-max-size.yml2
-rw-r--r--spec/if/acfg/bdbuf-task-stack-size.yml2
-rw-r--r--spec/if/acfg/bsp-idle-task-body.yml4
-rw-r--r--spec/if/acfg/bsp-idle-task-stack-size.yml4
-rw-r--r--spec/if/acfg/bsp-initial-extension.yml4
-rw-r--r--spec/if/acfg/bsp-interrupt-stack-size.yml4
-rw-r--r--spec/if/acfg/bsp-prerequisite-drivers.yml6
-rw-r--r--spec/if/acfg/cbs-max-servers.yml4
-rw-r--r--spec/if/acfg/constraint-unlimited.yml7
-rw-r--r--spec/if/acfg/dirty-memory.yml4
-rw-r--r--spec/if/acfg/disable-bsp-settings.yml12
-rw-r--r--spec/if/acfg/disable-newlib-reentrancy.yml2
-rw-r--r--spec/if/acfg/filesystem-all.yml14
-rw-r--r--spec/if/acfg/filesystem-dosfs.yml2
-rw-r--r--spec/if/acfg/filesystem-rfs.yml2
-rw-r--r--spec/if/acfg/group-bsp.yml2
-rw-r--r--spec/if/acfg/group-filesystem.yml34
-rw-r--r--spec/if/acfg/group-mpci.yml2
-rw-r--r--spec/if/acfg/group-schedgeneral.yml17
-rw-r--r--spec/if/acfg/idle-task-body.yml4
-rw-r--r--spec/if/acfg/idle-task-init-appl.yml6
-rw-r--r--spec/if/acfg/idle-task-stack-size.yml4
-rw-r--r--spec/if/acfg/imfs-disable-chmod.yml2
-rw-r--r--spec/if/acfg/imfs-disable-chown.yml2
-rw-r--r--spec/if/acfg/imfs-disable-link.yml2
-rw-r--r--spec/if/acfg/imfs-disable-mknod.yml2
-rw-r--r--spec/if/acfg/imfs-disable-mount.yml2
-rw-r--r--spec/if/acfg/imfs-disable-readdir.yml2
-rw-r--r--spec/if/acfg/imfs-disable-readlink.yml2
-rw-r--r--spec/if/acfg/imfs-disable-rename.yml2
-rw-r--r--spec/if/acfg/imfs-disable-rmnod.yml2
-rw-r--r--spec/if/acfg/imfs-disable-symlink.yml2
-rw-r--r--spec/if/acfg/imfs-disable-unmount.yml2
-rw-r--r--spec/if/acfg/imfs-disable-utime.yml2
-rw-r--r--spec/if/acfg/imfs-enable-mkfifo.yml2
-rw-r--r--spec/if/acfg/init-task-name.yml4
-rw-r--r--spec/if/acfg/init-task-stack-size.yml4
-rw-r--r--spec/if/acfg/initial-extensions.yml4
-rw-r--r--spec/if/acfg/interrupt-stack-size.yml12
-rw-r--r--spec/if/acfg/malloc-bsp-supports-sbrk.yml6
-rw-r--r--spec/if/acfg/malloc-dirty.yml4
-rw-r--r--spec/if/acfg/max-barriers.yml2
-rw-r--r--spec/if/acfg/max-message-queues.yml4
-rw-r--r--spec/if/acfg/max-partitions.yml2
-rw-r--r--spec/if/acfg/max-periods.yml2
-rw-r--r--spec/if/acfg/max-ports.yml2
-rw-r--r--spec/if/acfg/max-posix-key-value-pairs.yml12
-rw-r--r--spec/if/acfg/max-posix-keys.yml2
-rw-r--r--spec/if/acfg/max-posix-message-queues.yml4
-rw-r--r--spec/if/acfg/max-posix-semaphores.yml8
-rw-r--r--spec/if/acfg/max-posix-shms.yml2
-rw-r--r--spec/if/acfg/max-posix-threads.yml15
-rw-r--r--spec/if/acfg/max-posix-timers.yml2
-rw-r--r--spec/if/acfg/max-priority.yml12
-rw-r--r--spec/if/acfg/max-regions.yml2
-rw-r--r--spec/if/acfg/max-semaphores.yml6
-rw-r--r--spec/if/acfg/max-tasks.yml11
-rw-r--r--spec/if/acfg/max-thread-name-size.yml2
-rw-r--r--spec/if/acfg/max-timers.yml2
-rw-r--r--spec/if/acfg/memory-overhead.yml2
-rw-r--r--spec/if/acfg/message-buffer-memory.yml4
-rw-r--r--spec/if/acfg/microseconds-per-tick.yml2
-rw-r--r--spec/if/acfg/min-posix-thread-stack-size.yml2
-rw-r--r--spec/if/acfg/min-task-stack-size.yml6
-rw-r--r--spec/if/acfg/mp-extra-server-stack.yml4
-rw-r--r--spec/if/acfg/mp-max-global-objects.yml2
-rw-r--r--spec/if/acfg/mp-max-nodes.yml2
-rw-r--r--spec/if/acfg/mp-max-proxies.yml4
-rw-r--r--spec/if/acfg/mp-mpci-table-pointer.yml4
-rw-r--r--spec/if/acfg/mp-node-number.yml2
-rw-r--r--spec/if/acfg/posix-init-thread-stack-size.yml4
-rw-r--r--spec/if/acfg/posix-init-thread-table.yml4
-rw-r--r--spec/if/acfg/record-extensions-enabled.yml2
-rw-r--r--spec/if/acfg/record-fatal-dump-base64-zlib.yml4
-rw-r--r--spec/if/acfg/record-fatal-dump-base64.yml6
-rw-r--r--spec/if/acfg/record-per-processor-items.yml2
-rw-r--r--spec/if/acfg/rtems-init-tasks-table.yml4
-rw-r--r--spec/if/acfg/scheduler-assignments.yml6
-rw-r--r--spec/if/acfg/scheduler-cbs.yml7
-rw-r--r--spec/if/acfg/scheduler-edf-smp.yml9
-rw-r--r--spec/if/acfg/scheduler-edf.yml7
-rw-r--r--spec/if/acfg/scheduler-name.yml20
-rw-r--r--spec/if/acfg/scheduler-priority-affinity-smp.yml9
-rw-r--r--spec/if/acfg/scheduler-priority-smp.yml9
-rw-r--r--spec/if/acfg/scheduler-priority.yml11
-rw-r--r--spec/if/acfg/scheduler-simple-smp.yml7
-rw-r--r--spec/if/acfg/scheduler-simple.yml7
-rw-r--r--spec/if/acfg/task-stack-allocator-init.yml4
-rw-r--r--spec/if/acfg/task-stack-allocator.yml4
-rw-r--r--spec/if/acfg/task-stack-deallocator.yml4
-rw-r--r--spec/if/acfg/task-stack-from-alloc.yml2
-rw-r--r--spec/if/acfg/task-stack-no-workspace.yml2
-rw-r--r--spec/if/acfg/ticks-per-time-slice.yml2
-rw-r--r--spec/if/acfg/unified-work-areas.yml2
-rw-r--r--spec/if/acfg/unlimited-allocation-size.yml8
-rw-r--r--spec/if/acfg/unlimited-objects.yml4
-rw-r--r--spec/if/acfg/use-devfs-as-base-filesystem.yml24
-rw-r--r--spec/if/acfg/use-miniimfs-as-base-filesystem.yml16
-rw-r--r--spec/if/acfg/verbose-system-init.yml2
-rw-r--r--spec/if/acfg/zero-workspace-automatically.yml2
110 files changed, 283 insertions, 295 deletions
diff --git a/spec/if/acfg/appl-disable-filesystem.yml b/spec/if/acfg/appl-disable-filesystem.yml
index f9ec07f3..b994f38a 100644
--- a/spec/if/acfg/appl-disable-filesystem.yml
+++ b/spec/if/acfg/appl-disable-filesystem.yml
@@ -18,7 +18,7 @@ links:
name: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
notes: |
Filesystems shall be initialized to support file descriptor based device
- drivers and basic input/output functions such as :c:func:`printf`.
+ drivers and basic input/output functions such as ``printf()``.
Filesystems can be disabled to reduce the memory footprint of an application.
text: ''
type: interface
diff --git a/spec/if/acfg/appl-does-not-need-clock-driver.yml b/spec/if/acfg/appl-does-not-need-clock-driver.yml
index 67a89324..f82fc574 100644
--- a/spec/if/acfg/appl-does-not-need-clock-driver.yml
+++ b/spec/if/acfg/appl-does-not-need-clock-driver.yml
@@ -22,11 +22,11 @@ notes: |
The application shall define exactly one of the following configuration options
- * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
+ * ${appl-needs-clock-driver:/name},
* `CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or
- * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`,
+ * ${appl-needs-timer-driver:/name},
otherwise a compile time error in the configuration file will occur.
text: ''
diff --git a/spec/if/acfg/appl-extra-drivers.yml b/spec/if/acfg/appl-extra-drivers.yml
index e2d053f7..20b1dc50 100644
--- a/spec/if/acfg/appl-extra-drivers.yml
+++ b/spec/if/acfg/appl-extra-drivers.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a list of initializers for
- structures of type :c:type:`rtems_driver_address_table`.
+ structures of type ${../rtems/io/driver-address-table:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
@@ -23,7 +23,7 @@ notes: |
The value of this configuration option is placed after the entries of other
device driver configuration options.
- See :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS` for an alternative
+ See ${appl-prerequisite-drivers:/name} for an alternative
placement of application device driver initializers.
text: ''
type: interface
diff --git a/spec/if/acfg/appl-needs-clock-driver.yml b/spec/if/acfg/appl-needs-clock-driver.yml
index c3993bcf..cc0f01df 100644
--- a/spec/if/acfg/appl-needs-clock-driver.yml
+++ b/spec/if/acfg/appl-needs-clock-driver.yml
@@ -20,9 +20,9 @@ notes: |
* `CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
- * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or
+ * ${appl-does-not-need-clock-driver:/name}, or
- * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`,
+ * ${appl-needs-timer-driver:/name},
otherwise a compile time error in the configuration file will occur.
text: ''
diff --git a/spec/if/acfg/appl-needs-console-driver.yml b/spec/if/acfg/appl-needs-console-driver.yml
index 6c0e8f06..1659489a 100644
--- a/spec/if/acfg/appl-needs-console-driver.yml
+++ b/spec/if/acfg/appl-needs-console-driver.yml
@@ -17,16 +17,16 @@ notes: |
device file. This device is used to initialize the standard input, output,
and error file descriptors.
- BSPs should be constructed in a manner that allows :c:func:`printk` to work
+ BSPs should be constructed in a manner that allows ``printk()`` to work
properly without the need for the Console Driver to be configured.
The
- * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,
+ * ${appl-needs-console-driver:/name},
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and
+ * ${appl-needs-simple-console-driver:/name}, and
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`
+ * ${appl-needs-simple-task-console-driver:/name}
configuration options are mutually exclusive.
text: ''
diff --git a/spec/if/acfg/appl-needs-simple-console-driver.yml b/spec/if/acfg/appl-needs-simple-console-driver.yml
index 37af5591..f31d3410 100644
--- a/spec/if/acfg/appl-needs-simple-console-driver.yml
+++ b/spec/if/acfg/appl-needs-simple-console-driver.yml
@@ -17,20 +17,20 @@ notes: |
device file. This device is used to initialize the standard input, output,
and error file descriptors.
- This device driver reads via :c:func:`getchark`.
+ This device driver reads via ``getchark()``.
- This device driver writes via :c:func:`rtems_putc`.
+ This device driver writes via ``rtems_putc()``.
The Termios framework is not used. There is no support to change device
settings, e.g. baud, stop bits, parity, etc.
The
- * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,
+ * ${appl-needs-console-driver:/name},
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and
+ * ${appl-needs-simple-console-driver:/name}, and
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`
+ * ${appl-needs-simple-task-console-driver:/name}
configuration options are mutually exclusive.
text: ''
diff --git a/spec/if/acfg/appl-needs-simple-task-console-driver.yml b/spec/if/acfg/appl-needs-simple-task-console-driver.yml
index 15ad5efa..d276efdd 100644
--- a/spec/if/acfg/appl-needs-simple-task-console-driver.yml
+++ b/spec/if/acfg/appl-needs-simple-task-console-driver.yml
@@ -17,17 +17,17 @@ notes: |
device file. This device is used to initialize the standard input, output,
and error file descriptors.
- This device driver reads via :c:func:`getchark`.
+ This device driver reads via ``getchark()``.
This device driver writes into a write buffer. The count of characters
written into the write buffer is returned. It might be less than the
requested count, in case the write buffer is full. The write is
non-blocking and may be called from interrupt context. A dedicated task
reads from the write buffer and outputs the characters via
- :c:func:`rtems_putc`. This task runs with the least important priority.
+ ``rtems_putc()``. This task runs with the least important priority.
The write buffer size is 2047 characters and it is not configurable.
- Use ``fsync(STDOUT_FILENO)`` or ``fdatasync(STDOUT_FILENO)`` to drain the
+ Use ``fsync( STDOUT_FILENO )`` or ``fdatasync( STDOUT_FILENO )`` to drain the
write buffer.
The Termios framework is not used. There is no support to change device
@@ -35,11 +35,11 @@ notes: |
The
- * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,
+ * ${appl-needs-console-driver:/name},
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and
+ * ${appl-needs-simple-console-driver:/name}, and
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`
+ * ${appl-needs-simple-task-console-driver:/name}
configuration options are mutually exclusive.
text: ''
diff --git a/spec/if/acfg/appl-needs-timer-driver.yml b/spec/if/acfg/appl-needs-timer-driver.yml
index 93ae9923..364bd12f 100644
--- a/spec/if/acfg/appl-needs-timer-driver.yml
+++ b/spec/if/acfg/appl-needs-timer-driver.yml
@@ -18,9 +18,9 @@ notes: |
The application shall define exactly one of the following configuration options
- * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`,
+ * ${appl-needs-clock-driver:/name},
- * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or
+ * ${appl-does-not-need-clock-driver:/name}, or
* `CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`,
diff --git a/spec/if/acfg/appl-prerequisite-drivers.yml b/spec/if/acfg/appl-prerequisite-drivers.yml
index ace0d734..552756e6 100644
--- a/spec/if/acfg/appl-prerequisite-drivers.yml
+++ b/spec/if/acfg/appl-prerequisite-drivers.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a list of initializers for
- structures of type :c:type:`rtems_driver_address_table`.
+ structures of type ${../rtems/io/driver-address-table:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
@@ -21,10 +21,10 @@ links:
name: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
notes: |
The value of this configuration option is placed after the entries defined by
- :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS` and before all other device driver
+ ${bsp-prerequisite-drivers:/name} and before all other device driver
configuration options.
- See :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS` for an alternative placement
+ See ${appl-extra-drivers:/name} for an alternative placement
of application device driver initializers.
text: ''
type: interface
diff --git a/spec/if/acfg/ata-driver-task-priority.yml b/spec/if/acfg/ata-driver-task-priority.yml
index 30cfb6fd..f277c07b 100644
--- a/spec/if/acfg/ata-driver-task-priority.yml
+++ b/spec/if/acfg/ata-driver-task-priority.yml
@@ -17,6 +17,6 @@ links:
name: CONFIGURE_ATA_DRIVER_TASK_PRIORITY
notes: |
This configuration option is only evaluated if the configuration option
- :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined.
+ ${appl-needs-ata-driver:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/bdbuf-buffer-max-size.yml b/spec/if/acfg/bdbuf-buffer-max-size.yml
index 08ca7ff7..1c6a4115 100644
--- a/spec/if/acfg/bdbuf-buffer-max-size.yml
+++ b/spec/if/acfg/bdbuf-buffer-max-size.yml
@@ -3,7 +3,7 @@ appl-config-option-type: integer
constraints:
min: 0
texts:
- - It shall be an integral multiple of :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`.
+ - It shall be an integral multiple of ${bdbuf-buffer-min-size:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: 4096
diff --git a/spec/if/acfg/bdbuf-task-stack-size.yml b/spec/if/acfg/bdbuf-task-stack-size.yml
index f17f1f27..7042bb5f 100644
--- a/spec/if/acfg/bdbuf-task-stack-size.yml
+++ b/spec/if/acfg/bdbuf-task-stack-size.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
appl-config-option-type: integer
constraints:
- min: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`
+ min: ${min-task-stack-size:/name}
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: '``RTEMS_MINIMUM_STACK_SIZE``'
diff --git a/spec/if/acfg/bsp-idle-task-body.yml b/spec/if/acfg/bsp-idle-task-body.yml
index 3fa18bec..ff8cd034 100644
--- a/spec/if/acfg/bsp-idle-task-body.yml
+++ b/spec/if/acfg/bsp-idle-task-body.yml
@@ -14,10 +14,10 @@ description: |
* this configuration option is defined by the BSP
- * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+ * and ${disable-bsp-settings:/name} is undefined,
then the value of this configuration option defines the default value of
- :ref:`CONFIGURE_IDLE_TASK_BODY`.
+ ${idle-task-body:/name}.
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/bsp-idle-task-stack-size.yml b/spec/if/acfg/bsp-idle-task-stack-size.yml
index 5a982222..63e9111e 100644
--- a/spec/if/acfg/bsp-idle-task-stack-size.yml
+++ b/spec/if/acfg/bsp-idle-task-stack-size.yml
@@ -10,10 +10,10 @@ description: |
* this configuration option is defined by the BSP
- * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+ * and ${disable-bsp-settings:/name} is undefined,
then the value of this configuration option defines the default value of
- :ref:`CONFIGURE_IDLE_TASK_SIZE`.
+ ${idle-task-stack-size:/name}.
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/bsp-initial-extension.yml b/spec/if/acfg/bsp-initial-extension.yml
index a24078b8..e1cb01e8 100644
--- a/spec/if/acfg/bsp-initial-extension.yml
+++ b/spec/if/acfg/bsp-initial-extension.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a list of initializers for
- structures of type :c:type:`rtems_extensions_table`.
+ structures of type ${../rtems/userext/table:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
@@ -14,7 +14,7 @@ description: |
* this configuration option is defined by the BSP
- * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+ * and ${disable-bsp-settings:/name} is undefined,
then the value of this configuration option is used to initialize the table
of initial user extensions.
diff --git a/spec/if/acfg/bsp-interrupt-stack-size.yml b/spec/if/acfg/bsp-interrupt-stack-size.yml
index c28fb731..82edfaa1 100644
--- a/spec/if/acfg/bsp-interrupt-stack-size.yml
+++ b/spec/if/acfg/bsp-interrupt-stack-size.yml
@@ -10,10 +10,10 @@ description: |
* this configuration option is defined by the BSP
- * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+ * and ${disable-bsp-settings:/name} is undefined,
then the value of this configuration option defines the default value of
- :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`.
+ ${interrupt-stack-size:/name}.
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/bsp-prerequisite-drivers.yml b/spec/if/acfg/bsp-prerequisite-drivers.yml
index 4f1e5ef6..e95f53a1 100644
--- a/spec/if/acfg/bsp-prerequisite-drivers.yml
+++ b/spec/if/acfg/bsp-prerequisite-drivers.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a list of initializers for
- structures of type :c:type:`rtems_extensions_table`.
+ structures of type ${../rtems/userext/table:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
@@ -14,7 +14,7 @@ description: |
* this configuration option is defined by the BSP
- * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+ * and ${disable-bsp-settings:/name} is undefined,
then the value of this configuration option is used to initialize the table
of initial user extensions.
@@ -28,6 +28,6 @@ name: CONFIGURE_BSP_PREREQUISITE_DRIVERS
notes: |
The value of this configuration option is placed before the entries of all
other initial user extensions (including
- :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`).
+ ${appl-prerequisite-drivers:/name}).
text: ''
type: interface
diff --git a/spec/if/acfg/cbs-max-servers.yml b/spec/if/acfg/cbs-max-servers.yml
index 63c30a81..2b7307c6 100644
--- a/spec/if/acfg/cbs-max-servers.yml
+++ b/spec/if/acfg/cbs-max-servers.yml
@@ -5,7 +5,7 @@ constraints:
min: 0
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-default-value: :ref:`CONFIGURE_MAXIMUM_TASKS`
+default-value: ${max-tasks:/name}
description: |
The value of this configuration option defines the maximum number Constant
Bandwidth Servers that can be concurrently active.
@@ -20,6 +20,6 @@ links:
name: CONFIGURE_CBS_MAXIMUM_SERVERS
notes: |
This configuration option is only evaluated if the configuration option
- :ref:`CONFIGURE_SCHEDULER_CBS` is defined.
+ ${scheduler-cbs:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/constraint-unlimited.yml b/spec/if/acfg/constraint-unlimited.yml
index 786fd53d..6ba50ad9 100644
--- a/spec/if/acfg/constraint-unlimited.yml
+++ b/spec/if/acfg/constraint-unlimited.yml
@@ -7,7 +7,8 @@ rationale: null
scope: user
text: |
The value of this configuration option may be defined through
- :c:func:`rtems_resource_unlimited` the enable unlimited objects for this
- object class, if the value passed to :c:func:`rtems_resource_unlimited`
- satisfies all other constraints of this configuration option.
+ ${../rtems/config/resource-unlimited:/name} the enable unlimited objects for
+ this object class, if the value passed to
+ ${../rtems/config/resource-unlimited:/name} satisfies all other constraints
+ of this configuration option.
type: constraint
diff --git a/spec/if/acfg/dirty-memory.yml b/spec/if/acfg/dirty-memory.yml
index 59af9ec3..1813d2bc 100644
--- a/spec/if/acfg/dirty-memory.yml
+++ b/spec/if/acfg/dirty-memory.yml
@@ -17,9 +17,9 @@ notes: |
Dirtying memory can add significantly to system initialization time. It may
assist in finding code that incorrectly assumes the contents of free memory
areas is cleared to zero during system initialization. In case
- :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is also defined, then the
+ ${zero-workspace-automatically:/name} is also defined, then the
memory is first dirtied and then zeroed.
- See also :ref:`CONFIGURE_MALLOC_DIRTY`.
+ See also ${malloc-dirty:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/disable-bsp-settings.yml b/spec/if/acfg/disable-bsp-settings.yml
index 9ca726de..84b376c0 100644
--- a/spec/if/acfg/disable-bsp-settings.yml
+++ b/spec/if/acfg/disable-bsp-settings.yml
@@ -6,17 +6,17 @@ description: |
In case this configuration option is defined, then the following BSP related
configuration options are undefined:
- * :ref:`BSP_IDLE_TASK_BODY`
+ * ${bsp-idle-task-body:/name}
- * :ref:`BSP_IDLE_TASK_STACK_SIZE`
+ * ${bsp-idle-task-stack-size:/name}
- * :ref:`BSP_INITIAL_EXTENSION`
+ * ${bsp-initial-extension:/name}
- * :ref:`BSP_INTERRUPT_STACK_SIZE`
+ * ${bsp-interrupt-stack-size:/name}
- * :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
+ * ${bsp-prerequisite-drivers:/name}
- * :ref:`CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK`
+ * ${malloc-bsp-supports-sbrk:/name}
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/disable-newlib-reentrancy.yml b/spec/if/acfg/disable-newlib-reentrancy.yml
index b3390e7c..26a2e521 100644
--- a/spec/if/acfg/disable-newlib-reentrancy.yml
+++ b/spec/if/acfg/disable-newlib-reentrancy.yml
@@ -15,7 +15,7 @@ name: CONFIGURE_DISABLE_NEWLIB_REENTRANCY
notes: |
You can enable this option to reduce the size of the :term:`TCB`. Use this
option with care, since it can lead to race conditions and undefined system
- behaviour. For example, :c:data:`errno` is no longer a thread-local variable
+ behaviour. For example, ``errno`` is no longer a thread-local variable
if this option is enabled.
text: ''
type: interface
diff --git a/spec/if/acfg/filesystem-all.yml b/spec/if/acfg/filesystem-all.yml
index 9e03e126..04a578a6 100644
--- a/spec/if/acfg/filesystem-all.yml
+++ b/spec/if/acfg/filesystem-all.yml
@@ -6,19 +6,19 @@ description: |
In case this configuration option is defined, then the following
configuration options will be defined as well
- * :ref:`CONFIGURE_FILESYSTEM_DOSFS`,
+ * ${filesystem-dosfs:/name},
- * :ref:`CONFIGURE_FILESYSTEM_FTPFS`,
+ * ${filesystem-ftpfs:/name},
- * :ref:`CONFIGURE_FILESYSTEM_IMFS`,
+ * ${filesystem-imfs:/name},
- * :ref:`CONFIGURE_FILESYSTEM_JFFS2`,
+ * ${filesystem-jffs2:/name},
- * :ref:`CONFIGURE_FILESYSTEM_NFS`,
+ * ${filesystem-nfs:/name},
- * :ref:`CONFIGURE_FILESYSTEM_RFS`, and
+ * ${filesystem-rfs:/name}, and
- * :ref:`CONFIGURE_FILESYSTEM_TFTPFS`.
+ * ${filesystem-tftpfs:/name}.
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/filesystem-dosfs.yml b/spec/if/acfg/filesystem-dosfs.yml
index d67b49f6..bd69f4cb 100644
--- a/spec/if/acfg/filesystem-dosfs.yml
+++ b/spec/if/acfg/filesystem-dosfs.yml
@@ -15,6 +15,6 @@ links:
name: CONFIGURE_FILESYSTEM_DOSFS
notes: |
This filesystem requires a Block Device Cache configuration, see
- :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`.
+ ${appl-needs-libblock:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/filesystem-rfs.yml b/spec/if/acfg/filesystem-rfs.yml
index f2d5ba58..af9d4f26 100644
--- a/spec/if/acfg/filesystem-rfs.yml
+++ b/spec/if/acfg/filesystem-rfs.yml
@@ -15,6 +15,6 @@ links:
name: CONFIGURE_FILESYSTEM_RFS
notes: |
This filesystem requires a Block Device Cache configuration, see
- :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`.
+ ${appl-needs-libblock:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/group-bsp.yml b/spec/if/acfg/group-bsp.yml
index 623b2d04..6620ea95 100644
--- a/spec/if/acfg/group-bsp.yml
+++ b/spec/if/acfg/group-bsp.yml
@@ -5,7 +5,7 @@ description: |
This section describes configuration options related to the BSP. Some
configuration options may have a BSP-specific setting which is defined by
``<bsp.h>``. The BSP-specific settings can be disabled by the
- :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option.
+ ${disable-bsp-settings:/name} configuration option.
enabled-by: true
interface-type: appl-config-group
links:
diff --git a/spec/if/acfg/group-filesystem.yml b/spec/if/acfg/group-filesystem.yml
index 977641fa..d509233f 100644
--- a/spec/if/acfg/group-filesystem.yml
+++ b/spec/if/acfg/group-filesystem.yml
@@ -6,43 +6,43 @@ description: |
By default, the In-Memory Filesystem (IMFS) is used as the base filesystem (also
known as root filesystem). In order to save some memory for your application,
you can disable the filesystem support with the
- :ref:`CONFIGURE_APPLICATION_DISABLE_FILESYSTEM` configuration option.
+ ${appl-disable-filesystem:/name} configuration option.
Alternatively, you can strip down the features of the base filesystem with the
- :ref:`CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM` and
- :ref:`CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM` configuration options. These
+ ${use-miniimfs-as-base-filesystem:/name} and
+ ${use-devfs-as-base-filesystem:/name} configuration options. These
three configuration options are mutually exclusive. They are intended for an
advanced application configuration.
Features of the IMFS can be disabled and enabled with the following
configuration options:
- * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`
+ * ${imfs-disable-chmod:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`
+ * ${imfs-disable-chown:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_LINK`
+ * ${imfs-disable-link:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD`
+ * ${imfs-disable-mknod:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`
+ * ${imfs-disable-mknod-file:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`
+ * ${imfs-disable-mount:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_READDIR`
+ * ${imfs-disable-readdir:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_READLINK`
+ * ${imfs-disable-readlink:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_RENAME`
+ * ${imfs-disable-rename:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`
+ * ${imfs-disable-rmnod:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`
+ * ${imfs-disable-symlink:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`
+ * ${imfs-disable-unmount:/name}
- * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`
+ * ${imfs-disable-utime:/name}
- * :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO`
+ * ${imfs-enable-mkfifo:/name}
enabled-by: true
interface-type: appl-config-group
links:
diff --git a/spec/if/acfg/group-mpci.yml b/spec/if/acfg/group-mpci.yml
index 238b898a..fcb969b6 100644
--- a/spec/if/acfg/group-mpci.yml
+++ b/spec/if/acfg/group-mpci.yml
@@ -5,7 +5,7 @@ description: |
This section describes multiprocessing related configuration options. The
options are only used if RTEMS was built with the ``--enable-multiprocessing``
build configuration option. Additionally, this class of configuration options
- are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION`
+ are only applicable if the configuration option ${mp-appl:/name}
is defined. The multiprocessing (MPCI) support must not be confused with the
SMP support.
enabled-by: true
diff --git a/spec/if/acfg/group-schedgeneral.yml b/spec/if/acfg/group-schedgeneral.yml
index 93429ed0..8b5702dd 100644
--- a/spec/if/acfg/group-schedgeneral.yml
+++ b/spec/if/acfg/group-schedgeneral.yml
@@ -8,17 +8,18 @@ description: |
configuration does not need any of the configuration options described in this
section.
- By default, the :ref:`Deterministic Priority Scheduler <SchedulerPriority>`
+ By default, the ${.:/document-reference/scheduler-priority}
algorithm is used in uniprocessor configurations. In case SMP is enabled and
the configured maximum processors
- (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`) is greater
- than one, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler
- <SchedulerSMPEDF>` is selected as the default scheduler algorithm.
+ (${max-processors:/name}) is greater
+ than one, then the
+ ${.:/document-reference/scheduler-smp-edf}
+ is selected as the default scheduler algorithm.
- For the :ref:`schedulers built into
- RTEMS <SchedulingConcepts>`, the configuration is straightforward. All that is
- required is to define the configuration option which specifies which scheduler
- you want for in your application.
+ For the schedulers provided by RTEMS (see ${.:/document-reference/scheduler-concepts}), the
+ configuration is straightforward. All that is required is to define the
+ configuration option which specifies which scheduler you want for in your
+ application.
The pluggable scheduler interface also enables the user to provide their own
scheduling algorithm. If you choose to do this, you must define multiple
diff --git a/spec/if/acfg/idle-task-body.yml b/spec/if/acfg/idle-task-body.yml
index a4221954..82fc7a4f 100644
--- a/spec/if/acfg/idle-task-body.yml
+++ b/spec/if/acfg/idle-task-body.yml
@@ -8,7 +8,7 @@ constraints:
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
- If :ref:`BSP_IDLE_TASK_BODY` is defined, then this will be the default value,
+ If ${bsp-idle-task-body:/name} is defined, then this will be the default value,
otherwise the default value is ``_CPU_Thread_Idle_body``.
description: |
The value of this configuration option initializes the IDLE thread body.
@@ -25,6 +25,6 @@ notes: |
exists.
IDLE threads can be used to initialize the application, see configuration
- option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`.
+ option ${idle-task-init-appl:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/idle-task-init-appl.yml b/spec/if/acfg/idle-task-init-appl.yml
index 378fb73e..c52eeb49 100644
--- a/spec/if/acfg/idle-task-init-appl.yml
+++ b/spec/if/acfg/idle-task-init-appl.yml
@@ -26,15 +26,15 @@ notes: |
The IDLE task shall run at the lowest priority of all tasks in the system.
If this configuration option is defined, then it is mandatory to configure a
- user IDLE task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option,
+ user IDLE task with the ${idle-task-body:/name} configuration option,
otherwise a compile time error in the configuration file will occur.
The application shall define exactly one of the following configuration
options
- * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
+ * ${rtems-init-tasks-table:/name},
- * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
+ * ${posix-init-thread-table:/name}, or
* `CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
diff --git a/spec/if/acfg/idle-task-stack-size.yml b/spec/if/acfg/idle-task-stack-size.yml
index a4137f5d..9053a93b 100644
--- a/spec/if/acfg/idle-task-stack-size.yml
+++ b/spec/if/acfg/idle-task-stack-size.yml
@@ -3,7 +3,7 @@ appl-config-option-type: integer
constraints: {}
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-default-value: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`
+default-value: ${min-task-stack-size:/name}
description: |
The value of this configuration option defines the task stack size for an
IDLE task.
@@ -20,6 +20,6 @@ links:
name: CONFIGURE_IDLE_TASK_STACK_SIZE
notes: |
In SMP configurations, there is one IDLE task per configured processor, see
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS`.
+ ${max-processors:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/imfs-disable-chmod.yml b/spec/if/acfg/imfs-disable-chmod.yml
index 88c80592..0907d87e 100644
--- a/spec/if/acfg/imfs-disable-chmod.yml
+++ b/spec/if/acfg/imfs-disable-chmod.yml
@@ -7,7 +7,7 @@ default: |
changing the mode of files.
description: |
In case this configuration option is defined, then the root IMFS does not
- support changing the mode of files (no support for :c:func:`chmod`).
+ support changing the mode of files (no support for ``chmod()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-chown.yml b/spec/if/acfg/imfs-disable-chown.yml
index ae33bcf6..f8729dbd 100644
--- a/spec/if/acfg/imfs-disable-chown.yml
+++ b/spec/if/acfg/imfs-disable-chown.yml
@@ -7,7 +7,7 @@ default: |
changing the ownership of files.
description: |
In case this configuration option is defined, then the root IMFS does not
- support changing the ownership of files (no support for :c:func:`chown`).
+ support changing the ownership of files (no support for ``chown()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-link.yml b/spec/if/acfg/imfs-disable-link.yml
index 130958e6..f4bb0ef7 100644
--- a/spec/if/acfg/imfs-disable-link.yml
+++ b/spec/if/acfg/imfs-disable-link.yml
@@ -7,7 +7,7 @@ default: |
links.
description: |
In case this configuration option is defined, then the root IMFS does not
- support hard links (no support for :c:func:`link`).
+ support hard links (no support for ``link()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-mknod.yml b/spec/if/acfg/imfs-disable-mknod.yml
index 1bd389f3..450bdb78 100644
--- a/spec/if/acfg/imfs-disable-mknod.yml
+++ b/spec/if/acfg/imfs-disable-mknod.yml
@@ -7,7 +7,7 @@ default: |
files.
description: |
In case this configuration option is defined, then the root IMFS does not
- support making files (no support for :c:func:`mknod`).
+ support making files (no support for ``mknod()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-mount.yml b/spec/if/acfg/imfs-disable-mount.yml
index e434ff51..d6503e00 100644
--- a/spec/if/acfg/imfs-disable-mount.yml
+++ b/spec/if/acfg/imfs-disable-mount.yml
@@ -7,7 +7,7 @@ default: |
mounting other filesystems.
description: |
In case this configuration option is defined, then the root IMFS does not
- support mounting other filesystems (no support for :c:func:`mount`).
+ support mounting other filesystems (no support for ``mount()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-readdir.yml b/spec/if/acfg/imfs-disable-readdir.yml
index d3f8cc68..48b520e2 100644
--- a/spec/if/acfg/imfs-disable-readdir.yml
+++ b/spec/if/acfg/imfs-disable-readdir.yml
@@ -7,7 +7,7 @@ default: |
reading directories.
description: |
In case this configuration option is defined, then the root IMFS does not
- support reading directories (no support for :c:func:`readdir`). It is still
+ support reading directories (no support for ``readdir()``). It is still
possible to open files in a directory.
enabled-by: true
index-entries: []
diff --git a/spec/if/acfg/imfs-disable-readlink.yml b/spec/if/acfg/imfs-disable-readlink.yml
index 5bfc00c4..3137c930 100644
--- a/spec/if/acfg/imfs-disable-readlink.yml
+++ b/spec/if/acfg/imfs-disable-readlink.yml
@@ -7,7 +7,7 @@ default: |
reading symbolic links.
description: |
In case this configuration option is defined, then the root IMFS does not
- support reading symbolic links (no support for :c:func:`readlink`).
+ support reading symbolic links (no support for ``readlink()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-rename.yml b/spec/if/acfg/imfs-disable-rename.yml
index 60a33fff..6c51a1b5 100644
--- a/spec/if/acfg/imfs-disable-rename.yml
+++ b/spec/if/acfg/imfs-disable-rename.yml
@@ -7,7 +7,7 @@ default: |
renaming files.
description: |
In case this configuration option is defined, then the root IMFS does not
- support renaming files (no support for :c:func:`rename`).
+ support renaming files (no support for ``rename()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-rmnod.yml b/spec/if/acfg/imfs-disable-rmnod.yml
index 3686ab03..2b1e03a7 100644
--- a/spec/if/acfg/imfs-disable-rmnod.yml
+++ b/spec/if/acfg/imfs-disable-rmnod.yml
@@ -7,7 +7,7 @@ default: |
removing files.
description: |
In case this configuration option is defined, then the root IMFS does not
- support removing files (no support for :c:func:`rmnod`).
+ support removing files (no support for ``rmnod()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-symlink.yml b/spec/if/acfg/imfs-disable-symlink.yml
index d4b507db..5608a857 100644
--- a/spec/if/acfg/imfs-disable-symlink.yml
+++ b/spec/if/acfg/imfs-disable-symlink.yml
@@ -7,7 +7,7 @@ default: |
creating symbolic links.
description: |
In case this configuration option is defined, then the root IMFS does not
- support creating symbolic links (no support for :c:func:`symlink`).
+ support creating symbolic links (no support for ``symlink()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-unmount.yml b/spec/if/acfg/imfs-disable-unmount.yml
index 20cf5e15..84ce19e5 100644
--- a/spec/if/acfg/imfs-disable-unmount.yml
+++ b/spec/if/acfg/imfs-disable-unmount.yml
@@ -7,7 +7,7 @@ default: |
unmounting other filesystems.
description: |
In case this configuration option is defined, then the root IMFS does not
- support unmounting other filesystems (no support for :c:func:`unmount`).
+ support unmounting other filesystems (no support for ``unmount()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-disable-utime.yml b/spec/if/acfg/imfs-disable-utime.yml
index 49a13c28..e03cfe4b 100644
--- a/spec/if/acfg/imfs-disable-utime.yml
+++ b/spec/if/acfg/imfs-disable-utime.yml
@@ -7,7 +7,7 @@ default: |
changing file times.
description: |
In case this configuration option is defined, then the root IMFS does not
- support changing file times (no support for :c:func:`utime`).
+ support changing file times (no support for ``utime()``).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/imfs-enable-mkfifo.yml b/spec/if/acfg/imfs-enable-mkfifo.yml
index 22aed1da..66d40ec1 100644
--- a/spec/if/acfg/imfs-enable-mkfifo.yml
+++ b/spec/if/acfg/imfs-enable-mkfifo.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default: |
If this configuration option is undefined, then the root IMFS does not
- support making FIFOs (no support for :c:func:`mkfifo`).
+ support making FIFOs (no support for ``mkfifo()``).
description: |
In case this configuration option is defined, then the root IMFS supports
making FIFOs.
diff --git a/spec/if/acfg/init-task-name.yml b/spec/if/acfg/init-task-name.yml
index 9ce6f52e..62eb8d23 100644
--- a/spec/if/acfg/init-task-name.yml
+++ b/spec/if/acfg/init-task-name.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a valid integer of type
- ``rtems_name``.
+ ${../rtems/types/name:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
@@ -20,6 +20,6 @@ links:
uid: group-classicinit
name: CONFIGURE_INIT_TASK_NAME
notes: |
- Use :c:func:`rtems_build_name` to define the task name.
+ Use ${../rtems/object/build-name:/name} to define the task name.
text: ''
type: interface
diff --git a/spec/if/acfg/init-task-stack-size.yml b/spec/if/acfg/init-task-stack-size.yml
index fb3daa0a..8bccea64 100644
--- a/spec/if/acfg/init-task-stack-size.yml
+++ b/spec/if/acfg/init-task-stack-size.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
appl-config-option-type: integer
constraints:
- min: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`
+ min: ${min-task-stack-size:/name}
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-default-value: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`
+default-value: ${min-task-stack-size:/name}
description: |
The value of this configuration option defines the task stack size of the
Classic API initialization task.
diff --git a/spec/if/acfg/initial-extensions.yml b/spec/if/acfg/initial-extensions.yml
index 9d742c05..d719f334 100644
--- a/spec/if/acfg/initial-extensions.yml
+++ b/spec/if/acfg/initial-extensions.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a list of initializers for
- structures of type :c:type:`rtems_extensions_table`.
+ structures of type ${../rtems/userext/table:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
@@ -21,7 +21,7 @@ links:
name: CONFIGURE_INITIAL_EXTENSIONS
notes: |
The value of this configuration option is placed before the entries of
- :ref:`BSP_INITIAL_EXTENSION` and after the entries of all other initial
+ ${bsp-initial-extension:/name} and after the entries of all other initial
user extensions.
text: ''
type: interface
diff --git a/spec/if/acfg/interrupt-stack-size.yml b/spec/if/acfg/interrupt-stack-size.yml
index b2986237..8271b471 100644
--- a/spec/if/acfg/interrupt-stack-size.yml
+++ b/spec/if/acfg/interrupt-stack-size.yml
@@ -4,7 +4,7 @@ constraints: {}
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
- The default value is :ref:`BSP_INTERRUPT_STACK_SIZE` in case it is defined,
+ The default value is ${bsp-interrupt-stack-size:/name} in case it is defined,
otherwise the default value is ``CPU_STACK_MINIMUM_SIZE``.
description: |
The value of this configuration option defines the size of an interrupt stack
@@ -25,7 +25,7 @@ links:
name: CONFIGURE_INTERRUPT_STACK_SIZE
notes: |
There is one interrupt stack available for each configured processor
- (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). The interrupt stack areas are
+ (${max-processors:/name}). The interrupt stack areas are
statically allocated in a special linker section (``.rtemsstack.interrupt``).
The placement of this linker section is BSP-specific.
@@ -33,11 +33,11 @@ notes: |
to perform the sequential system initialization before the multithreading
is started.
- The interrupt stacks are covered by the :ref:`stack checker
- <CONFIGURE_STACK_CHECKER_ENABLED>`. However, using a too small interrupt
- stack size may still result in undefined behaviour.
+ The interrupt stacks are covered by the stack checker, see
+ ${stack-checker-enabled:/name}. However, using a too small interrupt stack
+ size may still result in undefined behaviour.
In releases before RTEMS 5.1 the default value was
- :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` instead of ``CPU_STACK_MINIMUM_SIZE``.
+ ${min-task-stack-size:/name} instead of ``CPU_STACK_MINIMUM_SIZE``.
text: ''
type: interface
diff --git a/spec/if/acfg/malloc-bsp-supports-sbrk.yml b/spec/if/acfg/malloc-bsp-supports-sbrk.yml
index 8ffd6a31..4589d2fd 100644
--- a/spec/if/acfg/malloc-bsp-supports-sbrk.yml
+++ b/spec/if/acfg/malloc-bsp-supports-sbrk.yml
@@ -7,12 +7,12 @@ description: |
* this configuration option is defined by the BSP
- * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+ * and ${disable-bsp-settings:/name} is undefined,
then not all memory is made available to the C Program Heap immediately at
- system initialization time. When :c:func:`malloc()` or other standard memory
+ system initialization time. When ``malloc()`` or other standard memory
allocation functions are unable to allocate memory, they will call the BSP
- supplied :c:func:`sbrk()` function to obtain more memory.
+ supplied ``sbrk()`` function to obtain more memory.
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/malloc-dirty.yml b/spec/if/acfg/malloc-dirty.yml
index 8840eff6..47dc7322 100644
--- a/spec/if/acfg/malloc-dirty.yml
+++ b/spec/if/acfg/malloc-dirty.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
description: |
In case this configuration option is defined, then each memory area returned
- by C Program Heap allocator functions such as :c:func:`malloc` is dirtied
+ by C Program Heap allocator functions such as ``malloc()`` is dirtied
with a ``0xCF`` byte pattern before it is handed over to the application.
enabled-by: true
index-entries: []
@@ -16,7 +16,7 @@ name: CONFIGURE_MALLOC_DIRTY
notes: |
The dirtying performed by this option is carried out for each successful
memory allocation from the C Program Heap in contrast to
- :ref:`CONFIGURE_DIRTY_MEMORY` which dirties the memory only once during the
+ ${dirty-memory:/name} which dirties the memory only once during the
system initialization.
text: ''
type: interface
diff --git a/spec/if/acfg/max-barriers.yml b/spec/if/acfg/max-barriers.yml
index 77bc28e2..129e552e 100644
--- a/spec/if/acfg/max-barriers.yml
+++ b/spec/if/acfg/max-barriers.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_BARRIERS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-message-queues.yml b/spec/if/acfg/max-message-queues.yml
index e8963de9..ad471a5c 100644
--- a/spec/if/acfg/max-message-queues.yml
+++ b/spec/if/acfg/max-message-queues.yml
@@ -22,8 +22,8 @@ links:
name: CONFIGURE_MAXIMUM_MESSAGE_QUEUES
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`. You have to account for the memory used to
+ ${.:/document-reference/config-unlimited-objects}. You have to account for the memory used to
store the messages of each message queue, see
- :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
+ ${message-buffer-memory:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-partitions.yml b/spec/if/acfg/max-partitions.yml
index b6c088a6..ef151f1c 100644
--- a/spec/if/acfg/max-partitions.yml
+++ b/spec/if/acfg/max-partitions.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_PARTITIONS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-periods.yml b/spec/if/acfg/max-periods.yml
index 694ab3c0..008236dc 100644
--- a/spec/if/acfg/max-periods.yml
+++ b/spec/if/acfg/max-periods.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_PERIODS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-ports.yml b/spec/if/acfg/max-ports.yml
index a1752318..a9617ed8 100644
--- a/spec/if/acfg/max-ports.yml
+++ b/spec/if/acfg/max-ports.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_PORTS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-posix-key-value-pairs.yml b/spec/if/acfg/max-posix-key-value-pairs.yml
index 694fbee0..4c774581 100644
--- a/spec/if/acfg/max-posix-key-value-pairs.yml
+++ b/spec/if/acfg/max-posix-key-value-pairs.yml
@@ -7,9 +7,9 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
The default value is
- :ref:`CONFIGURE_MAXIMUM_POSIX_KEYS` *
- :ref:`CONFIGURE_MAXIMUM_TASKS` +
- :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS`.
+ ${max-posix-keys:/name} *
+ ${max-tasks:/name} +
+ ${max-posix-threads:/name}.
description: |
The value of this configuration option defines the maximum number of key
value pairs used by POSIX API Keys that can be concurrently active.
@@ -26,9 +26,9 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
- A key value pair is created by :c:func:`pthread_setspecific` if the value
- is not :c:macro:`NULL`, otherwise it is deleted.
+ A key value pair is created by ``pthread_setspecific()`` if the value
+ is not ${../c/null:/name}, otherwise it is deleted.
text: ''
type: interface
diff --git a/spec/if/acfg/max-posix-keys.yml b/spec/if/acfg/max-posix-keys.yml
index 5239647c..82308c31 100644
--- a/spec/if/acfg/max-posix-keys.yml
+++ b/spec/if/acfg/max-posix-keys.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_KEYS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-posix-message-queues.yml b/spec/if/acfg/max-posix-message-queues.yml
index 097871f8..1028f6c8 100644
--- a/spec/if/acfg/max-posix-message-queues.yml
+++ b/spec/if/acfg/max-posix-message-queues.yml
@@ -24,8 +24,8 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`. You have to account for the memory used to
+ ${.:/document-reference/config-unlimited-objects}. You have to account for the memory used to
store the messages of each message queue, see
- :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
+ ${message-buffer-memory:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-posix-semaphores.yml b/spec/if/acfg/max-posix-semaphores.yml
index 5c313fee..827b3c4c 100644
--- a/spec/if/acfg/max-posix-semaphores.yml
+++ b/spec/if/acfg/max-posix-semaphores.yml
@@ -24,10 +24,10 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
- Named semaphores are created with :c:func:`sem_open()`. Semaphores
- initialized with :c:func:`sem_init()` are not affected by this configuration
- option since the storage space for these semaphores is user-provided.
+ Named semaphores are created with ``sem_open()``. Semaphores initialized
+ with ``sem_init()`` are not affected by this configuration option since the
+ storage space for these semaphores is user-provided.
text: ''
type: interface
diff --git a/spec/if/acfg/max-posix-shms.yml b/spec/if/acfg/max-posix-shms.yml
index d3f544a6..f3087fe4 100644
--- a/spec/if/acfg/max-posix-shms.yml
+++ b/spec/if/acfg/max-posix-shms.yml
@@ -24,6 +24,6 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_SHMS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-posix-threads.yml b/spec/if/acfg/max-posix-threads.yml
index 0b314d5c..aba1ba9b 100644
--- a/spec/if/acfg/max-posix-threads.yml
+++ b/spec/if/acfg/max-posix-threads.yml
@@ -22,18 +22,15 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_THREADS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
- This calculations for the required memory in the RTEMS Workspace for
- threads assume that each thread has a minimum stack size and has floating
- point support enabled. The configuration option
- :ref:`CONFIGURE_EXTRA_TASK_STACKS` is used to specify thread stack
- requirements **above** the minimum size required. See :ref:`Reserve
- Task/Thread Stack Memory Above Minimum` for more information about
- ``CONFIGURE_EXTRA_TASK_STACKS``.
+ This calculations for the required memory in the RTEMS Workspace for threads
+ assume that each thread has a minimum stack size and has floating point
+ support enabled. The configuration option ${extra-task-stacks:/name} is used
+ to specify thread stack requirements **above** the minimum size required.
The maximum number of Classic API Tasks is specified by
- :ref:`CONFIGURE_MAXIMUM_TASKS`.
+ ${max-tasks:/name}.
All POSIX threads have floating point enabled.
text: ''
diff --git a/spec/if/acfg/max-posix-timers.yml b/spec/if/acfg/max-posix-timers.yml
index 67b1056e..4830bdb7 100644
--- a/spec/if/acfg/max-posix-timers.yml
+++ b/spec/if/acfg/max-posix-timers.yml
@@ -24,7 +24,7 @@ links:
name: CONFIGURE_MAXIMUM_POSIX_TIMERS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
Timers are only available if RTEMS was built with the
``--enable-posix`` build configuration option.
diff --git a/spec/if/acfg/max-priority.yml b/spec/if/acfg/max-priority.yml
index 9cd3f58a..8f561f30 100644
--- a/spec/if/acfg/max-priority.yml
+++ b/spec/if/acfg/max-priority.yml
@@ -14,15 +14,15 @@ default-value: 255
description: |
For the following schedulers
- * :ref:`SchedulerPriority`, which is the default in uniprocessor
+ * ${.:/document-reference/scheduler-priority}, which is the default in uniprocessor
configurations and can be configured through the
- :ref:`CONFIGURE_SCHEDULER_PRIORITY` configuration option,
+ ${scheduler-priority:/name} configuration option,
- * :ref:`SchedulerSMPPriority` which can be configured through the
- :ref:`CONFIGURE_SCHEDULER_PRIORITY_SMP` configuration option, and
+ * ${.:/document-reference/scheduler-smp-priority} which can be configured through the
+ ${scheduler-priority-smp:/name} configuration option, and
- * :ref:`SchedulerSMPPriorityAffinity` which can be configured through the
- :ref:`CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP` configuration option
+ * ${.:/document-reference/scheduler-smp-priority-affinity} which can be configured through the
+ ${scheduler-priority-affinity-smp:/name} configuration option
this configuration option specifies the maximum numeric priority of any task
for these schedulers and one less that the number of priority levels for
diff --git a/spec/if/acfg/max-regions.yml b/spec/if/acfg/max-regions.yml
index fe06f81f..38b63072 100644
--- a/spec/if/acfg/max-regions.yml
+++ b/spec/if/acfg/max-regions.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_REGIONS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/max-semaphores.yml b/spec/if/acfg/max-semaphores.yml
index 76798f34..4bb560c8 100644
--- a/spec/if/acfg/max-semaphores.yml
+++ b/spec/if/acfg/max-semaphores.yml
@@ -22,10 +22,10 @@ links:
name: CONFIGURE_MAXIMUM_SEMAPHORES
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
In SMP configurations, the size of a Semaphore Control Block depends on the
- scheduler count (see :ref:`ConfigurationSchedulerTable`). The semaphores
- using the :ref:`MrsP` need a ceiling priority per scheduler.
+ scheduler count (see ${.:/document-reference/config-scheduler-table}). The semaphores
+ using the ${.:/document-reference/mrsp} need a ceiling priority per scheduler.
text: ''
type: interface
diff --git a/spec/if/acfg/max-tasks.yml b/spec/if/acfg/max-tasks.yml
index 45b00175..86f97695 100644
--- a/spec/if/acfg/max-tasks.yml
+++ b/spec/if/acfg/max-tasks.yml
@@ -24,18 +24,15 @@ links:
name: CONFIGURE_MAXIMUM_TASKS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
The calculations for the required memory in the RTEMS Workspace for tasks
assume that each task has a minimum stack size and has floating point
- support enabled. The configuration parameter
- ``CONFIGURE_EXTRA_TASK_STACKS`` is used to specify task stack requirements
- *ABOVE* the minimum size required. See :ref:`Reserve Task/Thread Stack
- Memory Above Minimum` for more information about
- ``CONFIGURE_EXTRA_TASK_STACKS``.
+ support enabled. The configuration option ${extra-task-stacks:/name} is used
+ to specify task stack requirements *above* the minimum size required.
The maximum number of POSIX threads is specified by
- :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS`.
+ ${max-posix-threads:/name}.
A future enhancement to ``<rtems/confdefs.h>`` could be to eliminate the
assumption that all tasks have floating point enabled. This would require
diff --git a/spec/if/acfg/max-thread-name-size.yml b/spec/if/acfg/max-thread-name-size.yml
index e8f3c552..1772ec1c 100644
--- a/spec/if/acfg/max-thread-name-size.yml
+++ b/spec/if/acfg/max-thread-name-size.yml
@@ -21,7 +21,7 @@ links:
name: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE
notes: |
The default value was chosen for Linux compatibility, see
- `PTHREAD_SETNAME_NP(3) <http://man7.org/linux/man-pages/man3/pthread_setname_np.3.html>`_.
+ ${.:/document-reference/pthread-setname-np}.
The size of the thread control block is increased by the maximum thread name
size.
diff --git a/spec/if/acfg/max-timers.yml b/spec/if/acfg/max-timers.yml
index 0ecfe00f..5cc6783c 100644
--- a/spec/if/acfg/max-timers.yml
+++ b/spec/if/acfg/max-timers.yml
@@ -22,6 +22,6 @@ links:
name: CONFIGURE_MAXIMUM_TIMERS
notes: |
This object class can be configured in unlimited allocation mode, see
- :ref:`ConfigUnlimitedObjects`.
+ ${.:/document-reference/config-unlimited-objects}.
text: ''
type: interface
diff --git a/spec/if/acfg/memory-overhead.yml b/spec/if/acfg/memory-overhead.yml
index a7a07757..39061e26 100644
--- a/spec/if/acfg/memory-overhead.yml
+++ b/spec/if/acfg/memory-overhead.yml
@@ -25,6 +25,6 @@ notes: |
in ``<rtems/confdefs.h>`` has resulted in an underestimation. Typically the
memory allocation will be too low when an application does not account for
all message queue buffers or task stacks, see
- :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.
+ ${message-buffer-memory:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/message-buffer-memory.yml b/spec/if/acfg/message-buffer-memory.yml
index 0f98d9d4..9b926115 100644
--- a/spec/if/acfg/message-buffer-memory.yml
+++ b/spec/if/acfg/message-buffer-memory.yml
@@ -23,8 +23,8 @@ links:
uid: constraint-memsz
name: CONFIGURE_MESSAGE_BUFFER_MEMORY
notes: |
- The configuration options :ref:`CONFIGURE_MAXIMUM_MESSAGE_QUEUES` and
- :ref:`CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES` define only how many message
+ The configuration options ${max-message-queues:/name} and
+ ${max-posix-message-queues:/name} define only how many message
queues can be created by the application. The memory for the message
buffers is configured by this option. For each message queue you have to
reserve some memory for the message buffers. The size dependes on the
diff --git a/spec/if/acfg/microseconds-per-tick.yml b/spec/if/acfg/microseconds-per-tick.yml
index ee1480f1..07060869 100644
--- a/spec/if/acfg/microseconds-per-tick.yml
+++ b/spec/if/acfg/microseconds-per-tick.yml
@@ -37,7 +37,7 @@ links:
name: CONFIGURE_MICROSECONDS_PER_TICK
notes: |
This configuration option has no impact if the Clock Driver is not
- configured, see :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`.
+ configured, see ${appl-does-not-need-clock-driver:/name}.
There may be Clock Driver specific limits on the resolution or maximum value
of a clock tick quantum.
diff --git a/spec/if/acfg/min-posix-thread-stack-size.yml b/spec/if/acfg/min-posix-thread-stack-size.yml
index 6a2e819f..8b3d364f 100644
--- a/spec/if/acfg/min-posix-thread-stack-size.yml
+++ b/spec/if/acfg/min-posix-thread-stack-size.yml
@@ -5,7 +5,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
The default value is two times the value of
- :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+ ${min-task-stack-size:/name}.
description: |
The value of this configuration option defines the minimum stack size in
bytes for every POSIX thread in the system.
diff --git a/spec/if/acfg/min-task-stack-size.yml b/spec/if/acfg/min-task-stack-size.yml
index b64b1ab4..bd13b1c3 100644
--- a/spec/if/acfg/min-task-stack-size.yml
+++ b/spec/if/acfg/min-task-stack-size.yml
@@ -22,7 +22,7 @@ name: CONFIGURE_MINIMUM_TASK_STACK_SIZE
notes: |
Adjusting this parameter should be done with caution. Examining the actual
stack usage using the stack checker usage reporting facility is recommended
- (see also :ref:`CONFIGURE_STACK_CHECKER_ENABLED`).
+ (see also ${stack-checker-enabled:/name}).
This parameter can be used to lower the minimum from that recommended. This
can be used in low memory systems to reduce memory consumption for
@@ -35,10 +35,10 @@ notes: |
By default, this configuration parameter defines also the minimum stack
size of POSIX threads. This can be changed with the
- :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE`
+ ${min-posix-thread-stack-size:/name}
configuration option.
In releases before RTEMS 5.1 the ``CONFIGURE_MINIMUM_TASK_STACK_SIZE`` was
- used to define the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`.
+ used to define the default value of ${interrupt-stack-size:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/mp-extra-server-stack.yml b/spec/if/acfg/mp-extra-server-stack.yml
index 25f11bd8..65e64297 100644
--- a/spec/if/acfg/mp-extra-server-stack.yml
+++ b/spec/if/acfg/mp-extra-server-stack.yml
@@ -14,7 +14,7 @@ default-value: 0
description: |
The value of this configuration option defines the number of bytes the
applications wishes to add to the MPCI task stack on top of
- :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+ ${min-task-stack-size:/name}.
enabled-by: true
index-entries: []
interface-type: appl-config-option
@@ -24,6 +24,6 @@ links:
name: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK
notes: |
This configuration option is only evaluated if
- :ref:`CONFIGURE_MP_APPLICATION` is defined.
+ ${mp-appl:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/mp-max-global-objects.yml b/spec/if/acfg/mp-max-global-objects.yml
index f795d53a..43d5ad0f 100644
--- a/spec/if/acfg/mp-max-global-objects.yml
+++ b/spec/if/acfg/mp-max-global-objects.yml
@@ -21,6 +21,6 @@ notes: |
with the ``RTEMS_GLOBAL`` attribute.
This configuration option is only evaluated if
- :ref:`CONFIGURE_MP_APPLICATION` is defined.
+ ${mp-appl:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/mp-max-nodes.yml b/spec/if/acfg/mp-max-nodes.yml
index 5342ea01..b939f96a 100644
--- a/spec/if/acfg/mp-max-nodes.yml
+++ b/spec/if/acfg/mp-max-nodes.yml
@@ -18,6 +18,6 @@ links:
name: CONFIGURE_MP_MAXIMUM_NODES
notes: |
This configuration option is only evaluated if
- :ref:`CONFIGURE_MP_APPLICATION` is defined.
+ ${mp-appl:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/mp-max-proxies.yml b/spec/if/acfg/mp-max-proxies.yml
index f20b5333..a8a04f0c 100644
--- a/spec/if/acfg/mp-max-proxies.yml
+++ b/spec/if/acfg/mp-max-proxies.yml
@@ -21,9 +21,9 @@ notes: |
Since a proxy is used to represent a remote task/thread which is blocking
on this node. This configuration parameter reflects the maximum number of
remote tasks/threads which can be blocked on objects on this node, see
- :ref:`MPCIProxies`.
+ ${.:/document-reference/mp-proxies}.
This configuration option is only evaluated if
- :ref:`CONFIGURE_MP_APPLICATION` is defined.
+ ${mp-appl:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/mp-mpci-table-pointer.yml b/spec/if/acfg/mp-mpci-table-pointer.yml
index 8d0f00cb..2f92d4d9 100644
--- a/spec/if/acfg/mp-mpci-table-pointer.yml
+++ b/spec/if/acfg/mp-mpci-table-pointer.yml
@@ -4,7 +4,7 @@ constraints:
texts:
- |
The value of this configuration option shall be a pointer to
- :c:type:`rtems_mpci_table`.
+ ${../rtems/types/mpci-table:/name}.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: '``&MPCI_table``'
@@ -24,6 +24,6 @@ notes: |
supporting methods.
This configuration option is only evaluated if
- :ref:`CONFIGURE_MP_APPLICATION` is defined.
+ ${mp-appl:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/mp-node-number.yml b/spec/if/acfg/mp-node-number.yml
index 1a51de4a..df5bce0a 100644
--- a/spec/if/acfg/mp-node-number.yml
+++ b/spec/if/acfg/mp-node-number.yml
@@ -23,6 +23,6 @@ notes: |
differently based upon their node number.
This configuration option is only evaluated if
- :ref:`CONFIGURE_MP_APPLICATION` is defined.
+ ${mp-appl:/name} is defined.
text: ''
type: interface
diff --git a/spec/if/acfg/posix-init-thread-stack-size.yml b/spec/if/acfg/posix-init-thread-stack-size.yml
index 59a3ead4..b3be22e1 100644
--- a/spec/if/acfg/posix-init-thread-stack-size.yml
+++ b/spec/if/acfg/posix-init-thread-stack-size.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
appl-config-option-type: integer
constraints:
- min: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`
+ min: ${min-task-stack-size:/name}
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-default-value: :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE`
+default-value: ${min-posix-thread-stack-size:/name}
description: |
The value of this configuration option defines the thread stack size of the
POSIX API initialization thread.
diff --git a/spec/if/acfg/posix-init-thread-table.yml b/spec/if/acfg/posix-init-thread-table.yml
index 6a7d9250..b51dd8c1 100644
--- a/spec/if/acfg/posix-init-thread-table.yml
+++ b/spec/if/acfg/posix-init-thread-table.yml
@@ -16,11 +16,11 @@ notes: |
The application shall define exactly one of the following configuration
options
- * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
+ * ${rtems-init-tasks-table:/name},
* `CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
- * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
+ * ${idle-task-init-appl:/name}
otherwise a compile time error in the configuration file will occur.
text: ''
diff --git a/spec/if/acfg/record-extensions-enabled.yml b/spec/if/acfg/record-extensions-enabled.yml
index 3486238b..bf894918 100644
--- a/spec/if/acfg/record-extensions-enabled.yml
+++ b/spec/if/acfg/record-extensions-enabled.yml
@@ -7,7 +7,7 @@ description: |
* this configuration option is defined
- * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+ * and ${record-per-processor-items:/name} is properly defined,
then the event record extensions are enabled.
enabled-by: true
diff --git a/spec/if/acfg/record-fatal-dump-base64-zlib.yml b/spec/if/acfg/record-fatal-dump-base64-zlib.yml
index 731a6a72..4856f7c5 100644
--- a/spec/if/acfg/record-fatal-dump-base64-zlib.yml
+++ b/spec/if/acfg/record-fatal-dump-base64-zlib.yml
@@ -7,10 +7,10 @@ description: |
* this configuration option is defined
- * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+ * and ${record-per-processor-items:/name} is properly defined,
then the event records are compressed by zlib and dumped in Base64 encoding
- in a fatal error extension (see :ref:`Terminate`).
+ in a fatal error extension (see ${.:/document-reference/terminate}).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/record-fatal-dump-base64.yml b/spec/if/acfg/record-fatal-dump-base64.yml
index 14ab9517..8a977e14 100644
--- a/spec/if/acfg/record-fatal-dump-base64.yml
+++ b/spec/if/acfg/record-fatal-dump-base64.yml
@@ -7,12 +7,12 @@ description: |
* this configuration option is defined
- * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
+ * and ${record-per-processor-items:/name} is properly defined,
- * and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined,
+ * and ${record-fatal-dump-base64-zlib:/name} is undefined,
then the event records are dumped in Base64 encoding in a fatal error
- extension (see :ref:`Terminate`).
+ extension (see ${.:/document-reference/terminate}).
enabled-by: true
index-entries: []
interface-type: appl-config-option
diff --git a/spec/if/acfg/record-per-processor-items.yml b/spec/if/acfg/record-per-processor-items.yml
index 335c4fca..451569ad 100644
--- a/spec/if/acfg/record-per-processor-items.yml
+++ b/spec/if/acfg/record-per-processor-items.yml
@@ -22,7 +22,7 @@ links:
name: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
notes: |
The event record buffers are statically allocated for each configured
- processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this
+ processor (${max-processors:/name}). If the value of this
configuration option is zero, then nothing is allocated.
text: ''
type: interface
diff --git a/spec/if/acfg/rtems-init-tasks-table.yml b/spec/if/acfg/rtems-init-tasks-table.yml
index 24a35697..97dc73dd 100644
--- a/spec/if/acfg/rtems-init-tasks-table.yml
+++ b/spec/if/acfg/rtems-init-tasks-table.yml
@@ -18,9 +18,9 @@ notes: |
* `CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
- * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
+ * ${posix-init-thread-table:/name}, or
- * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
+ * ${idle-task-init-appl:/name}
otherwise a compile time error in the configuration file will occur.
text: ''
diff --git a/spec/if/acfg/scheduler-assignments.yml b/spec/if/acfg/scheduler-assignments.yml
index e678d6c3..51ca9a4b 100644
--- a/spec/if/acfg/scheduler-assignments.yml
+++ b/spec/if/acfg/scheduler-assignments.yml
@@ -8,10 +8,10 @@ constraints:
* ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
- * :c:macro:`RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER`
+ * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
- |
The value of this configuration option shall be a list of exactly
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements.
+ ${max-processors:/name} elements.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
default-value: |
@@ -31,6 +31,6 @@ notes: |
This configuration option is only evaluated in SMP configurations.
This is an advanced configuration option, see
- :ref:`ConfigurationSchedulersClustered`.
+ ${.:/document-reference/config-scheduler-clustered}.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-cbs.yml b/spec/if/acfg/scheduler-cbs.yml
index 7431d659..c9692d28 100644
--- a/spec/if/acfg/scheduler-cbs.yml
+++ b/spec/if/acfg/scheduler-cbs.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Constant Bandwidth Server (CBS) Scheduler <SchedulerCBS>`
+ ${.:/document-reference/scheduler-cbs}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -17,8 +17,7 @@ notes: |
This scheduler configuration option is an advanced configuration option.
Think twice before you use it.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for exactly one processor.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for exactly one processor.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-edf-smp.yml b/spec/if/acfg/scheduler-edf-smp.yml
index 526b051c..176db96a 100644
--- a/spec/if/acfg/scheduler-edf-smp.yml
+++ b/spec/if/acfg/scheduler-edf-smp.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Earliest Deadline First (EDF) SMP Scheduler <SchedulerSMPEDF>`
+ ${.:/document-reference/scheduler-smp-edf}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -20,12 +20,11 @@ notes: |
This scheduler algorithm is only available when RTEMS is built with SMP
support enabled.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for up to 32 processors.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for up to 32 processors.
This scheduler algorithm is the default in SMP configurations if
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
+ ${max-processors:/name} is
greater than one.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-edf.yml b/spec/if/acfg/scheduler-edf.yml
index 36f89170..0a93ad69 100644
--- a/spec/if/acfg/scheduler-edf.yml
+++ b/spec/if/acfg/scheduler-edf.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Earliest Deadline First (EDF) Scheduler <SchedulerEDF>`
+ ${.:/document-reference/scheduler-edf}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -17,8 +17,7 @@ notes: |
This scheduler configuration option is an advanced configuration option.
Think twice before you use it.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for exactly one processor.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for exactly one processor.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-name.yml b/spec/if/acfg/scheduler-name.yml
index 652fabe3..4974183f 100644
--- a/spec/if/acfg/scheduler-name.yml
+++ b/spec/if/acfg/scheduler-name.yml
@@ -10,21 +10,21 @@ copyrights:
default-value: |
The default value is
- * ``"MEDF"`` for the :ref:`EDF SMP Scheduler <SchedulerSMPEDF>`,
+ * ``"MEDF"`` for the ${.:/document-reference/scheduler-smp-edf},
- * ``"MPA "`` for the :ref:`Arbitrary Processor Affinity Priority SMP Scheduler <SchedulerSMPPriorityAffinity>`,
+ * ``"MPA "`` for the ${.:/document-reference/scheduler-smp-priority-affinity},
- * ``"MPD "`` for the :ref:`Deterministic Priority SMP Scheduler <SchedulerSMPPriority>`,
+ * ``"MPD "`` for the ${.:/document-reference/scheduler-smp-priority},
- * ``"MPS "`` for the :ref:`Simple Priority SMP Scheduler <SchedulerSMPPrioritySimple>`,
+ * ``"MPS "`` for the ${.:/document-reference/scheduler-smp-priority-simple},
- * ``"UCBS"`` for the :ref:`Uniprocessor CBS Scheduler <SchedulerCBS>`,
+ * ``"UCBS"`` for the ${.:/document-reference/scheduler-cbs},
- * ``"UEDF"`` for the :ref:`Uniprocessor EDF Scheduler <SchedulerEDF>`,
+ * ``"UEDF"`` for the ${.:/document-reference/scheduler-edf},
- * ``"UPD "`` for the :ref:`Uniprocessor Deterministic Priority Scheduler <SchedulerPriority>`, and
+ * ``"UPD "`` for the ${.:/document-reference/scheduler-priority}, and
- * ``"UPS "`` for the :ref:`Uniprocessor Simple Priority Scheduler <SchedulerPrioritySimple>`.
+ * ``"UPS "`` for the ${.:/document-reference/scheduler-priority-simple}.
description: |
The value of this configuration option defines the name of the default
scheduler.
@@ -39,8 +39,8 @@ notes: |
This scheduler configuration option is an advanced configuration option.
Think twice before you use it.
- Schedulers can be identified via c:func:`rtems_scheduler_ident`.
+ Schedulers can be identified via ${../rtems/scheduler/ident:/name}.
- Use :c:func:`rtems_build_name` to define the scheduler name.
+ Use ${../rtems/object/build-name:/name} to define the scheduler name.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-priority-affinity-smp.yml b/spec/if/acfg/scheduler-priority-affinity-smp.yml
index 5fce590c..2423d994 100644
--- a/spec/if/acfg/scheduler-priority-affinity-smp.yml
+++ b/spec/if/acfg/scheduler-priority-affinity-smp.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Arbitrary Processor Affinity SMP Scheduler <SchedulerSMPPriorityAffinity>`
+ ${.:/document-reference/scheduler-smp-priority-affinity}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -20,11 +20,10 @@ notes: |
This scheduler algorithm is only available when RTEMS is built with SMP
support enabled.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for up to 32 processors.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for up to 32 processors.
The memory allocated for this scheduler depends on the
- :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+ ${max-priority:/name} configuration option.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-priority-smp.yml b/spec/if/acfg/scheduler-priority-smp.yml
index f23010bf..527a9d6d 100644
--- a/spec/if/acfg/scheduler-priority-smp.yml
+++ b/spec/if/acfg/scheduler-priority-smp.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Deterministic Priority SMP Scheduler <SchedulerSMPPriority>`
+ ${.:/document-reference/scheduler-smp-priority}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -20,11 +20,10 @@ notes: |
This scheduler algorithm is only available when RTEMS is built with SMP
support enabled.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for up to 32 processors.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for up to 32 processors.
The memory allocated for this scheduler depends on the
- :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+ ${max-priority:/name} configuration option.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-priority.yml b/spec/if/acfg/scheduler-priority.yml
index 4f991320..05f291df 100644
--- a/spec/if/acfg/scheduler-priority.yml
+++ b/spec/if/acfg/scheduler-priority.yml
@@ -5,7 +5,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Deterministic Priority Scheduler <SchedulerPriority>`
+ ${.:/document-reference/scheduler-priority}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -18,15 +18,14 @@ notes: |
This scheduler configuration option is an advanced configuration option.
Think twice before you use it.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for exactly one processor.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for exactly one processor.
This scheduler algorithm is the default when
- :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
+ ${max-processors:/name} is
exactly one.
The memory allocated for this scheduler depends on the
- :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+ ${max-priority:/name} configuration option.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-simple-smp.yml b/spec/if/acfg/scheduler-simple-smp.yml
index d3e0ac65..16d6edb3 100644
--- a/spec/if/acfg/scheduler-simple-smp.yml
+++ b/spec/if/acfg/scheduler-simple-smp.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Simple Priority SMP Scheduler <SchedulerSMPPrioritySimple>`
+ ${.:/document-reference/scheduler-smp-priority-simple}
algorithm is made available to the application.
application.
enabled-by: true
@@ -21,8 +21,7 @@ notes: |
This scheduler algorithm is only available when RTEMS is built with SMP
support enabled.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for up to 32 processors.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for up to 32 processors.
text: ''
type: interface
diff --git a/spec/if/acfg/scheduler-simple.yml b/spec/if/acfg/scheduler-simple.yml
index 61e69517..234a65ff 100644
--- a/spec/if/acfg/scheduler-simple.yml
+++ b/spec/if/acfg/scheduler-simple.yml
@@ -4,7 +4,7 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
description: |
In case this configuration option is defined, then
- :ref:`Simple Priority Scheduler <SchedulerPrioritySimple>`
+ ${.:/document-reference/scheduler-priority-simple}
algorithm is made available to the application.
enabled-by: true
index-entries: []
@@ -17,8 +17,7 @@ notes: |
This scheduler configuration option is an advanced configuration option.
Think twice before you use it.
- In case no explicit :ref:`clustered scheduler configuration
- <ConfigurationSchedulersClustered>` is present, then it is used as the
- scheduler for exactly one processor.
+ In case no explicit ${.:/document-reference/config-scheduler-clustered}
+ is present, then it is used as the scheduler for exactly one processor.
text: ''
type: interface
diff --git a/spec/if/acfg/task-stack-allocator-init.yml b/spec/if/acfg/task-stack-allocator-init.yml
index 139ecf27..0a1c8996 100644
--- a/spec/if/acfg/task-stack-allocator-init.yml
+++ b/spec/if/acfg/task-stack-allocator-init.yml
@@ -23,8 +23,8 @@ notes: |
* `CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
- * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
+ * ${task-stack-allocator:/name}
- * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
+ * ${task-stack-deallocator:/name}
text: ''
type: interface
diff --git a/spec/if/acfg/task-stack-allocator.yml b/spec/if/acfg/task-stack-allocator.yml
index acedb118..05748ad5 100644
--- a/spec/if/acfg/task-stack-allocator.yml
+++ b/spec/if/acfg/task-stack-allocator.yml
@@ -24,10 +24,10 @@ name: CONFIGURE_TASK_STACK_ALLOCATOR
notes: |
A correctly configured system shall configure the following to be consistent:
- * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
+ * ${task-stack-allocator-init:/name}
* `CONFIGURE_TASK_STACK_ALLOCATOR`
- * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
+ * ${task-stack-deallocator:/name}
text: ''
type: interface
diff --git a/spec/if/acfg/task-stack-deallocator.yml b/spec/if/acfg/task-stack-deallocator.yml
index 50c21616..a5418e2a 100644
--- a/spec/if/acfg/task-stack-deallocator.yml
+++ b/spec/if/acfg/task-stack-deallocator.yml
@@ -24,9 +24,9 @@ name: CONFIGURE_TASK_STACK_DEALLOCATOR
notes: |
A correctly configured system shall configure the following to be consistent:
- * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
+ * ${task-stack-allocator-init:/name}
- * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
+ * ${task-stack-allocator:/name}
* `CONFIGURE_TASK_STACK_DEALLOCATOR`
text: ''
diff --git a/spec/if/acfg/task-stack-from-alloc.yml b/spec/if/acfg/task-stack-from-alloc.yml
index b9dc7390..7b3e6c31 100644
--- a/spec/if/acfg/task-stack-from-alloc.yml
+++ b/spec/if/acfg/task-stack-from-alloc.yml
@@ -25,6 +25,6 @@ links:
name: CONFIGURE_TASK_STACK_FROM_ALLOCATOR
notes: |
This configuration option may be used if a custom task stack allocator is
- configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
+ configured, see ${task-stack-allocator:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/task-stack-no-workspace.yml b/spec/if/acfg/task-stack-no-workspace.yml
index ab1c7693..3cbe5502 100644
--- a/spec/if/acfg/task-stack-no-workspace.yml
+++ b/spec/if/acfg/task-stack-no-workspace.yml
@@ -14,6 +14,6 @@ links:
name: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
notes: |
This configuration option may be used if a custom task stack allocator is
- configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
+ configured, see ${task-stack-allocator:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/ticks-per-time-slice.yml b/spec/if/acfg/ticks-per-time-slice.yml
index 24e5f0f8..2dedcb9e 100644
--- a/spec/if/acfg/ticks-per-time-slice.yml
+++ b/spec/if/acfg/ticks-per-time-slice.yml
@@ -19,6 +19,6 @@ links:
name: CONFIGURE_TICKS_PER_TIMESLICE
notes: |
This configuration option has no impact if the Clock Driver is not
- configured, see :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`.
+ configured, see ${appl-does-not-need-clock-driver:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/unified-work-areas.yml b/spec/if/acfg/unified-work-areas.yml
index 1a99d8f1..8d57342c 100644
--- a/spec/if/acfg/unified-work-areas.yml
+++ b/spec/if/acfg/unified-work-areas.yml
@@ -26,7 +26,7 @@ notes: |
pool is very undesirable.
In high memory environments, this is desirable when you want to use the
- :ref:`ConfigUnlimitedObjects` option. You will be able to create objects
+ ${.:/document-reference/config-unlimited-objects} option. You will be able to create objects
until you run out of all available memory rather then just until you run out
of RTEMS Workspace.
text: ''
diff --git a/spec/if/acfg/unlimited-allocation-size.yml b/spec/if/acfg/unlimited-allocation-size.yml
index d77027c1..f0a2db95 100644
--- a/spec/if/acfg/unlimited-allocation-size.yml
+++ b/spec/if/acfg/unlimited-allocation-size.yml
@@ -9,10 +9,10 @@ copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: 8
description: |
- If :ref:`CONFIGURE_UNLIMITED_OBJECTS` is defined, then the value of this
+ If ${unlimited-objects:/name} is defined, then the value of this
configuration option defines the default objects maximum of all object
- classes supporting :ref:`ConfigUnlimitedObjects` to
- ``rtems_resource_unlimited(CONFIGURE_UNLIMITED_ALLOCATION_SIZE)``.
+ classes supporting ${.:/document-reference/config-unlimited-objects} to
+ ``rtems_resource_unlimited( CONFIGURE_UNLIMITED_ALLOCATION_SIZE )``.
enabled-by: true
index-entries: []
interface-type: appl-config-option
@@ -25,6 +25,6 @@ notes: |
avoid identifying and limiting the resources used.
The object maximum of each class can be configured also individually using
- the :c:func:`rtems_resource_unlimited` macro.
+ the ${../rtems/config/resource-unlimited:/name} macro.
text: ''
type: interface
diff --git a/spec/if/acfg/unlimited-objects.yml b/spec/if/acfg/unlimited-objects.yml
index 74b0a1c5..bdfb30d8 100644
--- a/spec/if/acfg/unlimited-objects.yml
+++ b/spec/if/acfg/unlimited-objects.yml
@@ -14,12 +14,12 @@ links:
name: CONFIGURE_UNLIMITED_OBJECTS
notes: |
When using unlimited objects, it is common practice to also specify
- :ref:`CONFIGURE_UNIFIED_WORK_AREAS` so the system operates with a single pool
+ ${unified-work-areas:/name} so the system operates with a single pool
of memory for both RTEMS Workspace and C Program Heap.
This option does not override an explicit configuration for a particular
object class by the user.
- See also :ref:`CONFIGURE_UNLIMITED_ALLOCATION_SIZE`.
+ See also ${unlimited-allocation-size:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/use-devfs-as-base-filesystem.yml b/spec/if/acfg/use-devfs-as-base-filesystem.yml
index c6f25693..72e46305 100644
--- a/spec/if/acfg/use-devfs-as-base-filesystem.yml
+++ b/spec/if/acfg/use-devfs-as-base-filesystem.yml
@@ -16,29 +16,29 @@ notes: |
In case this configuration option is defined, then the following
configuration options will be defined as well
- * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
+ * ${imfs-disable-chmod:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
+ * ${imfs-disable-chown:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
+ * ${imfs-disable-link:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`,
+ * ${imfs-disable-mknod-file:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`,
+ * ${imfs-disable-mount:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_READDIR`,
+ * ${imfs-disable-readdir:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
+ * ${imfs-disable-readlink:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
+ * ${imfs-disable-rename:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`,
+ * ${imfs-disable-rmnod:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
+ * ${imfs-disable-symlink:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
+ * ${imfs-disable-utime:/name}, and
- * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
+ * ${imfs-disable-unmount:/name}.
In addition, a simplified path evaluation is enabled. It allows only a look
up of absolute paths.
diff --git a/spec/if/acfg/use-miniimfs-as-base-filesystem.yml b/spec/if/acfg/use-miniimfs-as-base-filesystem.yml
index 1d14e1b3..13474187 100644
--- a/spec/if/acfg/use-miniimfs-as-base-filesystem.yml
+++ b/spec/if/acfg/use-miniimfs-as-base-filesystem.yml
@@ -16,20 +16,20 @@ notes: |
In case this configuration option is defined, then the following
configuration options will be defined as well
- * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
+ * ${imfs-disable-chmod:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
+ * ${imfs-disable-chown:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
+ * ${imfs-disable-link:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
+ * ${imfs-disable-readlink:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
+ * ${imfs-disable-rename:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
+ * ${imfs-disable-symlink:/name},
- * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
+ * ${imfs-disable-utime:/name}, and
- * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
+ * ${imfs-disable-unmount:/name}.
text: ''
type: interface
diff --git a/spec/if/acfg/verbose-system-init.yml b/spec/if/acfg/verbose-system-init.yml
index f39cf1dd..c6c814e3 100644
--- a/spec/if/acfg/verbose-system-init.yml
+++ b/spec/if/acfg/verbose-system-init.yml
@@ -14,6 +14,6 @@ links:
name: CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION
notes: |
You may use this feature to debug system initialization issues. The
- :c:func:`printk` function is used to print the information.
+ ``printk()`` function is used to print the information.
text: ''
type: interface
diff --git a/spec/if/acfg/zero-workspace-automatically.yml b/spec/if/acfg/zero-workspace-automatically.yml
index 64acbcb7..ccca0125 100644
--- a/spec/if/acfg/zero-workspace-automatically.yml
+++ b/spec/if/acfg/zero-workspace-automatically.yml
@@ -20,7 +20,7 @@ name: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
notes: |
Zeroing memory can add significantly to the system initialization time. It is
not necessary for RTEMS but is often assumed by support libraries. In case
- :ref:`CONFIGURE_DIRTY_MEMORY` is also defined, then the memory is first
+ ${dirty-memory:/name} is also defined, then the memory is first
dirtied and then zeroed.
text: ''
type: interface