[PATCH 1/2] c-user: Avoid Sphinx-specifics in appl config
Chris Johns
chrisj at rtems.org
Wed Jul 8 03:11:05 UTC 2020
On 7/7/20 9:06 pm, Sebastian Huber wrote:
> This helps to generate Doxygen markup from the application configuration
> option specification items.
I do not understand this and the second part of this patch. I am suspicious this
is introducing constraints on what we can use in the documentation.
Maybe the relationships that are happening here, the constraints if there are
any, and reasons we need to have them are discussed in relation to the central
repo to save having more than one thread on this topic.
Thanks
Chris
>
> Update #3994.
> ---
> c-user/config/bsp-related.rst | 8 ++--
> c-user/config/classic-api.rst | 63 ++++++++++++++++-------------
> c-user/config/classic-init-task.rst | 2 +-
> c-user/config/device-driver.rst | 26 ++++++------
> c-user/config/filesystem.rst | 28 ++++++-------
> c-user/config/general.rst | 12 +++---
> c-user/config/mpci.rst | 2 +-
> c-user/config/posix-api.rst | 52 +++++++++++++-----------
> c-user/config/scheduler-general.rst | 6 +--
> 9 files changed, 107 insertions(+), 92 deletions(-)
>
> diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst
> index 5af5cc2..0b3436c 100644
> --- a/c-user/config/bsp-related.rst
> +++ b/c-user/config/bsp-related.rst
> @@ -104,7 +104,7 @@ DEFAULT VALUE:
>
> VALUE CONSTRAINTS:
> 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_extensions_table``.
>
> DESCRIPTION:
> If
> @@ -181,7 +181,7 @@ DEFAULT VALUE:
>
> VALUE CONSTRAINTS:
> 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_extensions_table``.
>
> DESCRIPTION:
> If
> @@ -259,9 +259,9 @@ DESCRIPTION:
> * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` 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.
>
> NOTES:
> This option should not be defined by the application. Only the BSP knows how
> diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst
> index bd2fa00..b72ad30 100644
> --- a/c-user/config/classic-api.rst
> +++ b/c-user/config/classic-api.rst
> @@ -37,9 +37,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -78,9 +79,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -121,9 +123,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -162,9 +165,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -203,9 +207,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -244,9 +249,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -285,9 +291,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -334,9 +341,10 @@ VALUE CONSTRAINTS:
> overflow an integer of type ``uintptr_t``.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> @@ -391,9 +399,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of Classic
> diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst
> index ca300e7..66ddfb8 100644
> --- a/c-user/config/classic-init-task.rst
> +++ b/c-user/config/classic-init-task.rst
> @@ -142,7 +142,7 @@ DESCRIPTION:
> initialization task.
>
> NOTES:
> - Use :c:func:`rtems_build_name` to define the task name.
> + Use ``rtems_build_name()`` to define the task name.
>
> .. index:: CONFIGURE_INIT_TASK_PRIORITY
>
> diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
> index 627c346..40f46a8 100644
> --- a/c-user/config/device-driver.rst
> +++ b/c-user/config/device-driver.rst
> @@ -63,7 +63,7 @@ DEFAULT VALUE:
>
> VALUE CONSTRAINTS:
> 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_driver_address_table``.
>
> DESCRIPTION:
> The value of this configuration option is used to initialize the Device
> @@ -160,11 +160,11 @@ DESCRIPTION:
> initialized during system initialization.
>
> NOTES:
> - The Console Driver is responsible for providing the :file:`/dev/console`
> + The Console Driver is responsible for providing the ``/dev/console``
> 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
> @@ -251,7 +251,7 @@ DEFAULT CONFIGURATION:
> enabled.
>
> DESCRIPTION:
> - In case this configuration option is defined, then the :file:`/dev/null`
> + In case this configuration option is defined, then the ``/dev/null``
> Driver is initialized during system initialization.
>
> NOTES:
> @@ -307,13 +307,13 @@ DESCRIPTION:
> is initialized during system initialization.
>
> NOTES:
> - This device driver is responsible for providing the :file:`/dev/console`
> + This device driver is responsible for providing the ``/dev/console``
> 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.
> @@ -350,21 +350,21 @@ DESCRIPTION:
> Driver is initialized during system initialization.
>
> NOTES:
> - This device driver is responsible for providing the :file:`/dev/console`
> + This device driver is responsible for providing the ``/dev/console``
> 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
> @@ -487,7 +487,7 @@ DEFAULT CONFIGURATION:
> enabled.
>
> DESCRIPTION:
> - In case this configuration option is defined, then the :file:`/dev/zero`
> + In case this configuration option is defined, then the ``/dev/zero``
> Driver is initialized during system initialization.
>
> NOTES:
> @@ -511,7 +511,7 @@ DEFAULT VALUE:
>
> VALUE CONSTRAINTS:
> 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_driver_address_table``.
>
> DESCRIPTION:
> The value of this configuration option is used to initialize the Device
> diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
> index b429a4f..ca00dc6 100644
> --- a/c-user/config/filesystem.rst
> +++ b/c-user/config/filesystem.rst
> @@ -72,7 +72,7 @@ DESCRIPTION:
>
> 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.
>
> .. index:: CONFIGURE_FILESYSTEM_ALL
> @@ -311,7 +311,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -335,7 +335,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -359,7 +359,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -383,7 +383,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -455,7 +455,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -479,7 +479,7 @@ DEFAULT CONFIGURATION:
>
> 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.
>
> NOTES:
> @@ -504,7 +504,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -528,7 +528,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -552,7 +552,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -576,7 +576,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -600,7 +600,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -624,7 +624,7 @@ DEFAULT CONFIGURATION:
>
> 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()``).
>
> NOTES:
> None.
> @@ -644,7 +644,7 @@ OPTION TYPE:
>
> DEFAULT CONFIGURATION:
> 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
> diff --git a/c-user/config/general.rst b/c-user/config/general.rst
> index 4b66c13..08f2a92 100644
> --- a/c-user/config/general.rst
> +++ b/c-user/config/general.rst
> @@ -63,7 +63,7 @@ DESCRIPTION:
> 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.
>
> .. index:: CONFIGURE_EXECUTIVE_RAM_SIZE
> @@ -159,7 +159,7 @@ DEFAULT VALUE:
>
> VALUE CONSTRAINTS:
> 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_extensions_table``.
>
> DESCRIPTION:
> The value of this configuration option is used to initialize the table of
> @@ -242,7 +242,7 @@ DEFAULT CONFIGURATION:
>
> 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.
>
> NOTES:
> @@ -716,14 +716,14 @@ DESCRIPTION:
> If :ref:`CONFIGURE_UNLIMITED_OBJECTS` 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)``.
> + ``rtems_resource_unlimited( CONFIGURE_UNLIMITED_ALLOCATION_SIZE )``.
>
> NOTES:
> By allowing users to declare all resources as being unlimited the user can
> 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_resource_unlimited()`` macro.
>
> .. index:: CONFIGURE_UNLIMITED_OBJECTS
>
> @@ -779,7 +779,7 @@ DESCRIPTION:
>
> 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.
>
> .. index:: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY
> .. index:: clear C Program Heap
> diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
> index 1413474..7ffb24a 100644
> --- a/c-user/config/mpci.rst
> +++ b/c-user/config/mpci.rst
> @@ -189,7 +189,7 @@ DEFAULT VALUE:
>
> VALUE CONSTRAINTS:
> The value of this configuration option shall be a pointer to
> - :c:type:`rtems_mpci_table`.
> + ``rtems_mpci_table``.
>
> DESCRIPTION:
> The value of this configuration option initializes the MPCI Configuration
> diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
> index 1359909..23aeb62 100644
> --- a/c-user/config/posix-api.rst
> +++ b/c-user/config/posix-api.rst
> @@ -40,9 +40,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of POSIX
> @@ -84,9 +85,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of key
> @@ -96,8 +98,8 @@ NOTES:
> This object class can be configured in unlimited allocation mode, see
> :ref:`ConfigUnlimitedObjects`.
>
> - 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 NULL, otherwise it is deleted.
>
> .. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
>
> @@ -132,9 +134,10 @@ VALUE CONSTRAINTS:
> not overflow an integer of type ``uintptr_t``.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of POSIX
> @@ -224,9 +227,10 @@ VALUE CONSTRAINTS:
> not overflow an integer of type ``uintptr_t``.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of POSIX
> @@ -236,9 +240,9 @@ NOTES:
> This object class can be configured in unlimited allocation mode, see
> :ref:`ConfigUnlimitedObjects`.
>
> - 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.
>
> .. index:: CONFIGURE_MAXIMUM_POSIX_SHMS
>
> @@ -273,9 +277,10 @@ VALUE CONSTRAINTS:
> not overflow an integer of type ``uintptr_t``.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> DESCRIPTION:
> The value of this configuration option defines the maximum number of POSIX
> @@ -367,9 +372,10 @@ VALUE CONSTRAINTS:
> memory available to the application.
>
> * It 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_resource_unlimited()`` the enable unlimited objects for
> + this object class, if the value passed to
> + ``rtems_resource_unlimited()`` satisfies all other constraints
> + of this configuration option.
>
> * It shall be zero if the POSIX API is not
> enabled (e.g. RTEMS was built without the ``--enable-posix`` build
> diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
> index 546d192..c353f16 100644
> --- a/c-user/config/scheduler-general.rst
> +++ b/c-user/config/scheduler-general.rst
> @@ -149,7 +149,7 @@ VALUE CONSTRAINTS:
>
> * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
>
> - * :c:macro:`RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER`
> + * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
>
> * It shall be a list of exactly
> :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements.
> @@ -305,9 +305,9 @@ 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()``.
>
> - Use :c:func:`rtems_build_name` to define the scheduler name.
> + Use ``rtems_build_name()`` to define the scheduler name.
>
> .. index:: CONFIGURE_SCHEDULER_PRIORITY
>
>
More information about the devel
mailing list