From 5fb9a1c75d708add22f4ca27b3920bd16bbb99c1 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 17 Mar 2020 14:23:03 +0100 Subject: c-user: Add missing configuration option notes Update #3836. --- c-user/config/filesystem.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++ c-user/config/general.rst | 2 +- 2 files changed, 49 insertions(+), 1 deletion(-) (limited to 'c-user') diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst index 687c0b9..0910d1b 100644 --- a/c-user/config/filesystem.rst +++ b/c-user/config/filesystem.rst @@ -97,6 +97,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to change the mode is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_CHOWN .. _CONFIGURE_IMFS_DISABLE_CHOWN: @@ -120,6 +123,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to change the owner is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_LINK .. _CONFIGURE_IMFS_DISABLE_LINK: @@ -143,6 +149,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to create hard links is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_MKNOD .. _CONFIGURE_IMFS_DISABLE_MKNOD: @@ -166,6 +175,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to make directories, devices, regular files and FIFOs is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE .. _CONFIGURE_IMFS_DISABLE_MKNOD_FILE: @@ -189,6 +201,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to make regular files is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_MOUNT .. _CONFIGURE_IMFS_DISABLE_MOUNT: @@ -212,6 +227,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to mount other file systems is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_READDIR .. _CONFIGURE_IMFS_DISABLE_READDIR: @@ -236,6 +254,9 @@ DESCRIPTION: directory is disabled in the root IMFS. It is still possible to open nodes in a directory. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_READLINK .. _CONFIGURE_IMFS_DISABLE_READLINK: @@ -259,6 +280,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to read symbolic links is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_RENAME .. _CONFIGURE_IMFS_DISABLE_RENAME: @@ -282,6 +306,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to rename nodes is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_RMNOD .. _CONFIGURE_IMFS_DISABLE_RMNOD: @@ -305,6 +332,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to remove nodes is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_SYMLINK .. _CONFIGURE_IMFS_DISABLE_SYMLINK: @@ -328,6 +358,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to create symbolic links is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT .. _CONFIGURE_IMFS_DISABLE_UNMOUNT: @@ -351,6 +384,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to unmount file systems is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_DISABLE_UTIME .. _CONFIGURE_IMFS_DISABLE_UTIME: @@ -374,6 +410,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to change times is disabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_ENABLE_MKFIFO .. _CONFIGURE_IMFS_ENABLE_MKFIFO: @@ -397,6 +436,9 @@ DESCRIPTION: In case this configuration option is defined, then the support to make FIFOs is enabled in the root IMFS. +NOTES: + None. + .. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK .. _CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK: @@ -446,6 +488,9 @@ DESCRIPTION: - when the block size is 512 bytes, the maximum file size is 1,082,195,456 bytes. +NOTES: + None. + .. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM .. _CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM: @@ -515,3 +560,6 @@ DESCRIPTION: - ``CONFIGURE_IMFS_DISABLE_RENAME``, and - ``CONFIGURE_IMFS_DISABLE_UNMOUNT``. + +NOTES: + None. diff --git a/c-user/config/general.rst b/c-user/config/general.rst index f5f44d3..bf8dcba 100644 --- a/c-user/config/general.rst +++ b/c-user/config/general.rst @@ -291,7 +291,7 @@ DESCRIPTION: This configuration parameter specifies the maximum thread name size including the terminating `NUL` character. -NOTE: +NOTES: The size of the thread control block is increased by the maximum thread name size. This configuration option is available since RTEMS 5.1. -- cgit v1.2.3