diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-28 09:03:14 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-04-29 21:00:43 +0200 |
commit | 4565256f2433ad899525114985baa1bfb99964e1 (patch) | |
tree | a690be04ebda18f6d8ebc9b87ba624cf16760ae6 /c-user/config/classic-init-task.rst | |
parent | c-user: CONFIGURE_BSP_PREREQUISITE_DRIVERS (diff) | |
download | rtems-docs-4565256f2433ad899525114985baa1bfb99964e1.tar.bz2 |
c-user: Reformat configuration option constraints
If only one constraint is present, then use a single sentence, otherwise
use a list for the constraints. Format the constraints so that the line
length limit is maintained.
Diffstat (limited to 'c-user/config/classic-init-task.rst')
-rw-r--r-- | c-user/config/classic-init-task.rst | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst index 0743929..9c0435b 100644 --- a/c-user/config/classic-init-task.rst +++ b/c-user/config/classic-init-task.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de) .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) .. This file is part of the RTEMS quality process and was automatically @@ -45,8 +45,8 @@ DEFAULT VALUE: The default value is 0. VALUE CONSTRAINTS: - The value of this configuration option shall be a valid integer of type - :c:type:`rtems_task_argument`. + The value of this configuration option shall be convertible to an integer + of type :c:type:`rtems_task_argument`. DESCRIPTION: The value of this configuration option defines task argument of the Classic @@ -107,10 +107,10 @@ VALUE CONSTRAINTS: The value of this configuration option shall satisfy all of the following constraints: - * It shall be greater than or equal to :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. + * It shall be greater than or equal to + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. - * It shall be defined using - :c:func:`RTEMS_TASK_STORAGE_SIZE`. + * It shall be defined using :c:func:`RTEMS_TASK_STORAGE_SIZE`. DESCRIPTION: The value of this configuration option defines the task storage size of the @@ -222,8 +222,8 @@ DEFAULT VALUE: The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``. VALUE CONSTRAINTS: - The value of this configuration option shall be a valid integer of type - :c:type:`rtems_name`. + The value of this configuration option shall be convertible to an integer + of type :c:type:`rtems_name`. DESCRIPTION: The value of this configuration option defines the name of the Classic API @@ -252,7 +252,8 @@ DEFAULT VALUE: VALUE CONSTRAINTS: The value of this configuration option shall be a valid Classic API task - priority. The set of valid task priorities is scheduler-specific. + priority. The set of valid task priorities depends on the scheduler + configuration. DESCRIPTION: The value of this configuration option defines the initial priority of the @@ -283,11 +284,12 @@ VALUE CONSTRAINTS: The value of this configuration option shall satisfy all of the following constraints: - * It shall be greater than or equal to :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. + * It shall be greater than or equal to + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. - * It shall be small enough so that the task - stack space calculation carried out by ``<rtems/confdefs.h>`` does not - overflow an integer of type `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_. + * It shall be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_. DESCRIPTION: The value of this configuration option defines the task stack size of the |