summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-17 16:05:54 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-17 16:06:38 +0200
commita517a098567ac0c5925bb1fd59242a8e769ba981 (patch)
tree650d3a972fa6d45516b9dda935c6e85aa229a52f
parenteng: Clarify action requirement specification (diff)
downloadrtems-docs-a517a098567ac0c5925bb1fd59242a8e769ba981.tar.bz2
c-user: Use * for list items
-rw-r--r--c-user/config/bsp-related.rst12
-rw-r--r--c-user/config/filesystem.rst66
-rw-r--r--c-user/config/scheduler-general.rst6
-rw-r--r--c-user/config/task-stack-alloc.rst18
4 files changed, 51 insertions, 51 deletions
diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst
index ba5ca93..9e14598 100644
--- a/c-user/config/bsp-related.rst
+++ b/c-user/config/bsp-related.rst
@@ -219,17 +219,17 @@ DESCRIPTION:
In case this configuration option is defined, then the following BSP related
configuration options are undefined:
- - :ref:`BSP_IDLE_TASK_BODY`
+ * :ref:`BSP_IDLE_TASK_BODY`
- - :ref:`BSP_IDLE_TASK_STACK_SIZE`
+ * :ref:`BSP_IDLE_TASK_STACK_SIZE`
- - :ref:`BSP_INITIAL_EXTENSION`
+ * :ref:`BSP_INITIAL_EXTENSION`
- - :ref:`BSP_INTERRUPT_STACK_SIZE`
+ * :ref:`BSP_INTERRUPT_STACK_SIZE`
- - :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
+ * :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
- - :ref:`CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK`
+ * :ref:`CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK`
NOTES:
None.
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index ef37307..b429a4f 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -96,19 +96,19 @@ DESCRIPTION:
In case this configuration option is defined, then the following
configuration options will be defined as well
- - :ref:`CONFIGURE_FILESYSTEM_DOSFS`,
+ * :ref:`CONFIGURE_FILESYSTEM_DOSFS`,
- - :ref:`CONFIGURE_FILESYSTEM_FTPFS`,
+ * :ref:`CONFIGURE_FILESYSTEM_FTPFS`,
- - :ref:`CONFIGURE_FILESYSTEM_IMFS`,
+ * :ref:`CONFIGURE_FILESYSTEM_IMFS`,
- - :ref:`CONFIGURE_FILESYSTEM_JFFS2`,
+ * :ref:`CONFIGURE_FILESYSTEM_JFFS2`,
- - :ref:`CONFIGURE_FILESYSTEM_NFS`,
+ * :ref:`CONFIGURE_FILESYSTEM_NFS`,
- - :ref:`CONFIGURE_FILESYSTEM_RFS`, and
+ * :ref:`CONFIGURE_FILESYSTEM_RFS`, and
- - :ref:`CONFIGURE_FILESYSTEM_TFTPFS`.
+ * :ref:`CONFIGURE_FILESYSTEM_TFTPFS`.
NOTES:
None.
@@ -691,17 +691,17 @@ NOTES:
correspondingly smaller. The following shows the maximum file size possible
based on the configured block size:
- - when the block size is 16 bytes, the maximum file size is 1,328 bytes.
+ * when the block size is 16 bytes, the maximum file size is 1,328 bytes.
- - when the block size is 32 bytes, the maximum file size is 18,656 bytes.
+ * when the block size is 32 bytes, the maximum file size is 18,656 bytes.
- - when the block size is 64 bytes, the maximum file size is 279,488 bytes.
+ * when the block size is 64 bytes, the maximum file size is 279,488 bytes.
- - when the block size is 128 bytes, the maximum file size is 4,329,344 bytes.
+ * when the block size is 128 bytes, the maximum file size is 4,329,344 bytes.
- - when the block size is 256 bytes, the maximum file size is 68,173,568 bytes.
+ * when the block size is 256 bytes, the maximum file size is 68,173,568 bytes.
- - when the block size is 512 bytes, the maximum file size is 1,082,195,456
+ * when the block size is 512 bytes, the maximum file size is 1,082,195,456
bytes.
.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
@@ -729,29 +729,29 @@ NOTES:
In case this configuration option is defined, then the following
configuration options will be defined as well
- - :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
- - :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
- - :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
- - :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`,
- - :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`,
- - :ref:`CONFIGURE_IMFS_DISABLE_READDIR`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_READDIR`,
- - :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
- - :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
- - :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`,
- - :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
- - :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
+ * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
- - :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
+ * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
In addition, a simplified path evaluation is enabled. It allows only a look
up of absolute paths.
@@ -785,18 +785,18 @@ NOTES:
In case this configuration option is defined, then the following
configuration options will be defined as well
- - :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
- - :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
- - :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
- - :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
- - :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
- - :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
+ * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
- - :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
+ * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
- - :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
+ * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index 438e9a3..d274dea 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -543,13 +543,13 @@ NOTES:
scheduling algorithm. If ``CONFIGURE_SCHEDULER_USER`` is defined then the
following additional macros shall be defined:
- - ``CONFIGURE_SCHEDULER`` shall be defined to a static definition of
+ * ``CONFIGURE_SCHEDULER`` shall be defined to a static definition of
the scheduler data structures of the user scheduler.
- - ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` shall be defined to a scheduler
+ * ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` shall be defined to a scheduler
table entry initializer for the user scheduler.
- - ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` shall be defined to the type of
+ * ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` shall be defined to the type of
the per-thread information of the user scheduler.
At this time, the mechanics and requirements for writing a new scheduler
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 005a643..297c624 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -41,11 +41,11 @@ DESCRIPTION:
NOTES:
A correctly configured system shall configure the following to be consistent:
- - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
+ * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
- - `CONFIGURE_TASK_STACK_ALLOCATOR`
+ * `CONFIGURE_TASK_STACK_ALLOCATOR`
- - :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
+ * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
@@ -74,11 +74,11 @@ DESCRIPTION:
NOTES:
A correctly configured system shall configure the following to be consistent:
- - `CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
+ * `CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
- - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
+ * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
- - :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
+ * :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
.. index:: CONFIGURE_TASK_STACK_DEALLOCATOR
.. index:: task stack deallocator
@@ -109,11 +109,11 @@ DESCRIPTION:
NOTES:
A correctly configured system shall configure the following to be consistent:
- - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
+ * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT`
- - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
+ * :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`
- - `CONFIGURE_TASK_STACK_DEALLOCATOR`
+ * `CONFIGURE_TASK_STACK_DEALLOCATOR`
.. index:: CONFIGURE_TASK_STACK_FROM_ALLOCATOR
.. index:: task stack allocator