summaryrefslogtreecommitdiffstats
path: root/c-user/config/filesystem.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-16 08:17:31 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-17 09:08:53 +0100
commit1c8ce332e273bb9f10cdb18e32e977cb9301fbad (patch)
tree8622528cf6fb748d6196ba5b9a46bf8c10b941bc /c-user/config/filesystem.rst
parentc-user: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS (diff)
downloadrtems-docs-1c8ce332e273bb9f10cdb18e32e977cb9301fbad.tar.bz2
c-user: Use rubric for configuration options
Clear the page for each configuration options similar to the directives. Use a rubric instead of a definition list for the application configuration options similar to the directive documentation pages. For direcives and application configuration options use the same rubric order. Generalize value constraints to constraints. This patch does not change hand written content.
Diffstat (limited to '')
-rw-r--r--c-user/config/filesystem.rst952
1 files changed, 558 insertions, 394 deletions
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 05ca826..6e053f2 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -67,6 +67,10 @@ configuration options:
.. Generated from spec:/acfg/if/appl-disable-filesystem
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
.. _CONFIGURE_APPLICATION_DISABLE_FILESYSTEM:
@@ -74,28 +78,37 @@ configuration options:
CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
----------------------------------------
-CONSTANT:
- ``CONFIGURE_APPLICATION_DISABLE_FILESYSTEM``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_APPLICATION_DISABLE_FILESYSTEM``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then a base filesystem and the
- configured filesystems are initialized during system initialization.
+If this configuration option is undefined, then a base filesystem and the
+configured filesystems are initialized during system initialization.
-DESCRIPTION:
- In case this configuration option is defined, then **no base filesystem** is
- initialized during system initialization and **no filesystems** are
- configured.
+.. rubric:: DESCRIPTION:
-NOTES:
- Filesystems shall be initialized to support file descriptor based device
- drivers and basic input/output functions such as :c:func:`printf`.
- Filesystems can be disabled to reduce the memory footprint of an application.
+In case this configuration option is defined, then **no base filesystem** is
+initialized during system initialization and **no filesystems** are
+configured.
+
+.. rubric:: NOTES:
+
+Filesystems shall be initialized to support file descriptor based device
+drivers and basic input/output functions such as :c:func:`printf`.
+Filesystems can be disabled to reduce the memory footprint of an application.
.. Generated from spec:/acfg/if/filesystem-all
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_ALL
.. _CONFIGURE_FILESYSTEM_ALL:
@@ -103,39 +116,44 @@ NOTES:
CONFIGURE_FILESYSTEM_ALL
------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_ALL``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_ALL``
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: OPTION TYPE:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+This configuration option is a boolean feature define.
-DESCRIPTION:
- In case this configuration option is defined, then the following
- configuration options will be defined as well
+.. rubric:: DEFAULT CONFIGURATION:
- * :ref:`CONFIGURE_FILESYSTEM_DOSFS`,
+If this configuration option is undefined, then the described feature is not
+enabled.
- * :ref:`CONFIGURE_FILESYSTEM_FTPFS`,
+.. rubric:: DESCRIPTION:
- * :ref:`CONFIGURE_FILESYSTEM_IMFS`,
+In case this configuration option is defined, then the following
+configuration options will be defined as well
- * :ref:`CONFIGURE_FILESYSTEM_JFFS2`,
+* :ref:`CONFIGURE_FILESYSTEM_DOSFS`,
- * :ref:`CONFIGURE_FILESYSTEM_NFS`,
+* :ref:`CONFIGURE_FILESYSTEM_FTPFS`,
- * :ref:`CONFIGURE_FILESYSTEM_RFS`, and
+* :ref:`CONFIGURE_FILESYSTEM_IMFS`,
- * :ref:`CONFIGURE_FILESYSTEM_TFTPFS`.
+* :ref:`CONFIGURE_FILESYSTEM_JFFS2`,
-NOTES:
- None.
+* :ref:`CONFIGURE_FILESYSTEM_NFS`,
+
+* :ref:`CONFIGURE_FILESYSTEM_RFS`, and
+
+* :ref:`CONFIGURE_FILESYSTEM_TFTPFS`.
.. Generated from spec:/acfg/if/filesystem-dosfs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_DOSFS
.. _CONFIGURE_FILESYSTEM_DOSFS:
@@ -143,27 +161,36 @@ NOTES:
CONFIGURE_FILESYSTEM_DOSFS
--------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_DOSFS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_DOSFS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
+
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DESCRIPTION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+In case this configuration option is defined, then the DOS (FAT) filesystem
+is registered, so that instances of this filesystem can be mounted by the
+application.
-DESCRIPTION:
- In case this configuration option is defined, then the DOS (FAT) filesystem
- is registered, so that instances of this filesystem can be mounted by the
- application.
+.. rubric:: NOTES:
-NOTES:
- This filesystem requires a Block Device Cache configuration, see
- :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`.
+This filesystem requires a Block Device Cache configuration, see
+:ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`.
.. Generated from spec:/acfg/if/filesystem-ftpfs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_FTPFS
.. _CONFIGURE_FILESYSTEM_FTPFS:
@@ -171,26 +198,31 @@ NOTES:
CONFIGURE_FILESYSTEM_FTPFS
--------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_FTPFS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_FTPFS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case this configuration option is defined, then the FTP filesystem (FTP
- client) is registered, so that instances of this filesystem
- can be mounted by the application.
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+In case this configuration option is defined, then the FTP filesystem (FTP
+client) is registered, so that instances of this filesystem
+can be mounted by the application.
.. Generated from spec:/acfg/if/filesystem-imfs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_IMFS
.. _CONFIGURE_FILESYSTEM_IMFS:
@@ -198,28 +230,37 @@ NOTES:
CONFIGURE_FILESYSTEM_IMFS
-------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_IMFS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_IMFS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case this configuration option is defined, then the In-Memory Filesystem
- (IMFS) is registered, so that instances of this filesystem can be mounted by
- the application.
+.. rubric:: DESCRIPTION:
-NOTES:
- Applications will rarely need this configuration option. This configuration
- option is intended for test programs. You do not need to define this
- configuration option for the base filesystem (also known as root filesystem).
+In case this configuration option is defined, then the In-Memory Filesystem
+(IMFS) is registered, so that instances of this filesystem can be mounted by
+the application.
+
+.. rubric:: NOTES:
+
+Applications will rarely need this configuration option. This configuration
+option is intended for test programs. You do not need to define this
+configuration option for the base filesystem (also known as root filesystem).
.. Generated from spec:/acfg/if/filesystem-jffs2
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_JFFS2
.. _CONFIGURE_FILESYSTEM_JFFS2:
@@ -227,26 +268,31 @@ NOTES:
CONFIGURE_FILESYSTEM_JFFS2
--------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_JFFS2``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_JFFS2``
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: OPTION TYPE:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+This configuration option is a boolean feature define.
-DESCRIPTION:
- In case this configuration option is defined, then the JFFS2 filesystem
- is registered, so that instances of this filesystem can be mounted by the
- application.
+.. rubric:: DEFAULT CONFIGURATION:
-NOTES:
- None.
+If this configuration option is undefined, then the described feature is not
+enabled.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the JFFS2 filesystem
+is registered, so that instances of this filesystem can be mounted by the
+application.
.. Generated from spec:/acfg/if/filesystem-nfs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_NFS
.. _CONFIGURE_FILESYSTEM_NFS:
@@ -254,26 +300,31 @@ NOTES:
CONFIGURE_FILESYSTEM_NFS
------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_NFS``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_FILESYSTEM_NFS``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the Network Filesystem
- (NFS) client is registered, so that instances of this filesystem can be
- mounted by the application.
+This configuration option is a boolean feature define.
-NOTES:
- None.
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the Network Filesystem
+(NFS) client is registered, so that instances of this filesystem can be
+mounted by the application.
.. Generated from spec:/acfg/if/filesystem-rfs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_RFS
.. _CONFIGURE_FILESYSTEM_RFS:
@@ -281,27 +332,36 @@ NOTES:
CONFIGURE_FILESYSTEM_RFS
------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_RFS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_RFS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
+
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DESCRIPTION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+In case this configuration option is defined, then the RTEMS Filesystem (RFS)
+is registered, so that instances of this filesystem can be mounted by the
+application.
-DESCRIPTION:
- In case this configuration option is defined, then the RTEMS Filesystem (RFS)
- is registered, so that instances of this filesystem can be mounted by the
- application.
+.. rubric:: NOTES:
-NOTES:
- This filesystem requires a Block Device Cache configuration, see
- :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`.
+This filesystem requires a Block Device Cache configuration, see
+:ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`.
.. Generated from spec:/acfg/if/filesystem-tftpfs
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_FILESYSTEM_TFTPFS
.. _CONFIGURE_FILESYSTEM_TFTPFS:
@@ -309,26 +369,31 @@ NOTES:
CONFIGURE_FILESYSTEM_TFTPFS
---------------------------
-CONSTANT:
- ``CONFIGURE_FILESYSTEM_TFTPFS``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_FILESYSTEM_TFTPFS``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case this configuration option is defined, then the TFTP filesystem (TFTP
- client) is registered, so that instances of this filesystem can be mounted by
- the application.
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+In case this configuration option is defined, then the TFTP filesystem (TFTP
+client) is registered, so that instances of this filesystem can be mounted by
+the application.
.. Generated from spec:/acfg/if/imfs-disable-chmod
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_CHMOD
.. _CONFIGURE_IMFS_DISABLE_CHMOD:
@@ -336,25 +401,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_CHMOD
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_CHMOD``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_CHMOD``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- changing the mode of files.
+.. rubric:: 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`).
+If this configuration option is undefined, then the root IMFS supports
+changing the mode of files.
-NOTES:
- None.
+.. rubric:: 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`).
.. Generated from spec:/acfg/if/imfs-disable-chown
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_CHOWN
.. _CONFIGURE_IMFS_DISABLE_CHOWN:
@@ -362,25 +432,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_CHOWN
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_CHOWN``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_CHOWN``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- changing the ownership of files.
+.. rubric:: 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`).
+If this configuration option is undefined, then the root IMFS supports
+changing the ownership of files.
-NOTES:
- None.
+.. rubric:: 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`).
.. Generated from spec:/acfg/if/imfs-disable-link
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_LINK
.. _CONFIGURE_IMFS_DISABLE_LINK:
@@ -388,25 +463,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_LINK
---------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_LINK``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_LINK``
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: OPTION TYPE:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports hard
- links.
+This configuration option is a boolean feature define.
-DESCRIPTION:
- In case this configuration option is defined, then the root IMFS does not
- support hard links (no support for :c:func:`link`).
+.. rubric:: DEFAULT CONFIGURATION:
-NOTES:
- None.
+If this configuration option is undefined, then the root IMFS supports hard
+links.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support hard links (no support for :c:func:`link`).
.. Generated from spec:/acfg/if/imfs-disable-mknod
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD
.. _CONFIGURE_IMFS_DISABLE_MKNOD:
@@ -414,25 +494,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_MKNOD
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_MKNOD``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_MKNOD``
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: OPTION TYPE:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports making
- files.
+This configuration option is a boolean feature define.
-DESCRIPTION:
- In case this configuration option is defined, then the root IMFS does not
- support making files (no support for :c:func:`mknod`).
+.. rubric:: DEFAULT CONFIGURATION:
-NOTES:
- None.
+If this configuration option is undefined, then the root IMFS supports making
+files.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support making files (no support for :c:func:`mknod`).
.. Generated from spec:/acfg/if/imfs-disable-mknod-device
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE
.. _CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE:
@@ -440,25 +525,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE
-----------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports making
- device files.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the root IMFS does not
- support making device files.
+This configuration option is a boolean feature define.
-NOTES:
- None.
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the root IMFS supports making
+device files.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support making device files.
.. Generated from spec:/acfg/if/imfs-disable-mknod-file
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_MKNOD_FILE
.. _CONFIGURE_IMFS_DISABLE_MKNOD_FILE:
@@ -466,25 +556,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_MKNOD_FILE
---------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_MKNOD_FILE``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_IMFS_DISABLE_MKNOD_FILE``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports making
- regular files.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the root IMFS does not
- support making regular files.
+This configuration option is a boolean feature define.
-NOTES:
- None.
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the root IMFS supports making
+regular files.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support making regular files.
.. Generated from spec:/acfg/if/imfs-disable-mount
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_MOUNT
.. _CONFIGURE_IMFS_DISABLE_MOUNT:
@@ -492,26 +587,31 @@ NOTES:
CONFIGURE_IMFS_DISABLE_MOUNT
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_MOUNT``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_IMFS_DISABLE_MOUNT``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- mounting other filesystems.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- In case this configuration option is defined, then the root IMFS does not
- support mounting other filesystems (no support for
- :c:func:`mount`).
+This configuration option is a boolean feature define.
-NOTES:
- None.
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the root IMFS supports
+mounting other filesystems.
+
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support mounting other filesystems (no support for
+:c:func:`mount`).
.. Generated from spec:/acfg/if/imfs-disable-readdir
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_READDIR
.. _CONFIGURE_IMFS_DISABLE_READDIR:
@@ -519,26 +619,31 @@ NOTES:
CONFIGURE_IMFS_DISABLE_READDIR
------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_READDIR``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``CONFIGURE_IMFS_DISABLE_READDIR``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- reading directories.
+.. rubric:: OPTION TYPE:
-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 possible to open files in a directory.
+This configuration option is a boolean feature define.
-NOTES:
- None.
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the root IMFS supports
+reading directories.
+
+.. rubric:: 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 possible to open files in a directory.
.. Generated from spec:/acfg/if/imfs-disable-readlink
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_READLINK
.. _CONFIGURE_IMFS_DISABLE_READLINK:
@@ -546,25 +651,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_READLINK
-------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_READLINK``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_READLINK``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- reading symbolic links.
+.. rubric:: 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`).
+If this configuration option is undefined, then the root IMFS supports
+reading symbolic links.
-NOTES:
- None.
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support reading symbolic links (no support for :c:func:`readlink`).
.. Generated from spec:/acfg/if/imfs-disable-rename
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_RENAME
.. _CONFIGURE_IMFS_DISABLE_RENAME:
@@ -572,25 +682,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_RENAME
-----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_RENAME``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_RENAME``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- renaming files.
+.. rubric:: 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`).
+If this configuration option is undefined, then the root IMFS supports
+renaming files.
-NOTES:
- None.
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support renaming files (no support for :c:func:`rename`).
.. Generated from spec:/acfg/if/imfs-disable-rmnod
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_RMNOD
.. _CONFIGURE_IMFS_DISABLE_RMNOD:
@@ -598,25 +713,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_RMNOD
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_RMNOD``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_RMNOD``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+This configuration option is a boolean feature define.
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- removing files.
+.. rubric:: 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`).
+If this configuration option is undefined, then the root IMFS supports
+removing files.
-NOTES:
- None.
+.. rubric:: DESCRIPTION:
+
+In case this configuration option is defined, then the root IMFS does not
+support removing files (no support for :c:func:`rmnod`).
.. Generated from spec:/acfg/if/imfs-disable-symlink
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_SYMLINK
.. _CONFIGURE_IMFS_DISABLE_SYMLINK:
@@ -624,25 +744,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_SYMLINK
------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_SYMLINK``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_SYMLINK``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- creating symbolic links.
+If this configuration option is undefined, then the root IMFS supports
+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`).
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+In case this configuration option is defined, then the root IMFS does not
+support creating symbolic links (no support for :c:func:`symlink`).
.. Generated from spec:/acfg/if/imfs-disable-unmount
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_UNMOUNT
.. _CONFIGURE_IMFS_DISABLE_UNMOUNT:
@@ -650,26 +775,31 @@ NOTES:
CONFIGURE_IMFS_DISABLE_UNMOUNT
------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_UNMOUNT``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_UNMOUNT``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- unmounting other filesystems.
+If this configuration option is undefined, then the root IMFS supports
+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`).
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+In case this configuration option is defined, then the root IMFS does not
+support unmounting other filesystems (no support for
+:c:func:`unmount`).
.. Generated from spec:/acfg/if/imfs-disable-utime
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_DISABLE_UTIME
.. _CONFIGURE_IMFS_DISABLE_UTIME:
@@ -677,25 +807,30 @@ NOTES:
CONFIGURE_IMFS_DISABLE_UTIME
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_DISABLE_UTIME``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_DISABLE_UTIME``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS supports
- changing file times.
+If this configuration option is undefined, then the root IMFS supports
+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`).
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+In case this configuration option is defined, then the root IMFS does not
+support changing file times (no support for :c:func:`utime`).
.. Generated from spec:/acfg/if/imfs-enable-mkfifo
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_ENABLE_MKFIFO
.. _CONFIGURE_IMFS_ENABLE_MKFIFO:
@@ -703,25 +838,30 @@ NOTES:
CONFIGURE_IMFS_ENABLE_MKFIFO
----------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_ENABLE_MKFIFO``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_ENABLE_MKFIFO``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the root IMFS does not
- support making FIFOs (no support for :c:func:`mkfifo`).
+If this configuration option is undefined, then the root IMFS does not
+support making FIFOs (no support for :c:func:`mkfifo`).
-DESCRIPTION:
- In case this configuration option is defined, then the root IMFS supports
- making FIFOs.
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+In case this configuration option is defined, then the root IMFS supports
+making FIFOs.
.. Generated from spec:/acfg/if/imfs-memfile-bytes-per-block
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
.. _CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK:
@@ -729,52 +869,62 @@ NOTES:
CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
--------------------------------------
-CONSTANT:
- ``CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is an integer define.
+This configuration option is an integer define.
-DEFAULT VALUE:
- The default value is 128.
+.. rubric:: DEFAULT VALUE:
-VALUE CONSTRAINTS:
- The value of this configuration option shall be equal to 16, 32, 64, 128,
- 256, or 512.
+The default value is 128.
-DESCRIPTION:
- The value of this configuration option defines the block size for in-memory
- files managed by the IMFS.
+.. rubric:: DESCRIPTION:
-NOTES:
- The configured block size has two impacts. The first is the average amount of
- unused memory in the last block of each file. For example, when the block
- size is 512, on average one-half of the last block of each file will remain
- unused and the memory is wasted. In contrast, when the block size is 16, the
- average unused memory per file is only 8 bytes. However, it requires more
- allocations for the same size file and thus more overhead per block for the
- dynamic memory management.
+The value of this configuration option defines the block size for in-memory
+files managed by the IMFS.
- Second, the block size has an impact on the maximum size file that can be
- stored in the IMFS. With smaller block size, the maximum file size is
- correspondingly smaller. The following shows the maximum file size possible
- based on the configured block size:
+.. rubric:: NOTES:
- * when the block size is 16 bytes, the maximum file size is 1,328 bytes.
+The configured block size has two impacts. The first is the average amount of
+unused memory in the last block of each file. For example, when the block
+size is 512, on average one-half of the last block of each file will remain
+unused and the memory is wasted. In contrast, when the block size is 16, the
+average unused memory per file is only 8 bytes. However, it requires more
+allocations for the same size file and thus more overhead per block for the
+dynamic memory management.
- * when the block size is 32 bytes, the maximum file size is 18,656 bytes.
+Second, the block size has an impact on the maximum size file that can be
+stored in the IMFS. With smaller block size, the maximum file size is
+correspondingly smaller. The following shows the maximum file size possible
+based on the configured block size:
- * when the block size is 64 bytes, the maximum file size is 279,488 bytes.
+* when the block size is 16 bytes, the maximum file size is 1,328 bytes.
- * when the block size is 128 bytes, the maximum file size is 4,329,344 bytes.
+* when the block size is 32 bytes, the maximum file size is 18,656 bytes.
- * when the block size is 256 bytes, the maximum file size is 68,173,568 bytes.
+* when the block size is 64 bytes, the maximum file size is 279,488 bytes.
- * when the block size is 512 bytes, the maximum file size is 1,082,195,456
- 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 512 bytes, the maximum file size is 1,082,195,456
+ bytes.
+
+.. rubric:: CONSTRAINTS:
+
+The value of the configuration option shall be equal to 16, 32, 64, 128, 256,
+or 512.
.. Generated from spec:/acfg/if/use-devfs-as-base-filesystem
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
.. _CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM:
@@ -782,57 +932,66 @@ NOTES:
CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM
--------------------------------------
-CONSTANT:
- ``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DEFAULT CONFIGURATION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+If this configuration option is undefined, then the described feature is not
+enabled.
-DESCRIPTION:
- In case this configuration option is defined, then an IMFS with a reduced
- feature set will be the base filesystem (also known as root filesystem).
+.. rubric:: DESCRIPTION:
-NOTES:
- In case this configuration option is defined, then the following
- configuration options will be defined as well
+In case this configuration option is defined, then an IMFS with a reduced
+feature set will be the base filesystem (also known as root filesystem).
- * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
+.. rubric:: NOTES:
- * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
+In case this configuration option is defined, then the following
+configuration options will be defined as well
- * :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
+* :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`,
- * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`,
+* :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`,
- * :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`,
+* :ref:`CONFIGURE_IMFS_DISABLE_LINK`,
- * :ref:`CONFIGURE_IMFS_DISABLE_READDIR`,
+* :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`,
- * :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
+* :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`,
- * :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
+* :ref:`CONFIGURE_IMFS_DISABLE_READDIR`,
- * :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`,
+* :ref:`CONFIGURE_IMFS_DISABLE_READLINK`,
- * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
+* :ref:`CONFIGURE_IMFS_DISABLE_RENAME`,
- * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
+* :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`,
- * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
+* :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`,
- In addition, a simplified path evaluation is enabled. It allows only a look
- up of absolute paths.
+* :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and
- This configuration of the IMFS is basically a device-only filesystem. It is
- comparable in functionality to the pseudo-filesystem name space provided
- before RTEMS release 4.5.0.
+* :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`.
+
+In addition, a simplified path evaluation is enabled. It allows only a look
+up of absolute paths.
+
+This configuration of the IMFS is basically a device-only filesystem. It is
+comparable in functionality to the pseudo-filesystem name space provided
+before RTEMS release 4.5.0.
.. Generated from spec:/acfg/if/use-miniimfs-as-base-filesystem
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
.. _CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM:
@@ -840,36 +999,41 @@ NOTES:
CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM
-----------------------------------------
-CONSTANT:
- ``CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
+
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DESCRIPTION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+In case this configuration option is defined, then an IMFS with a reduced
+feature set will be the base filesystem (also known as root filesystem).
-DESCRIPTION:
- In case this configuration option is defined, then an IMFS with a reduced
- feature set will be the base filesystem (also known as root filesystem).
+.. rubric:: NOTES:
-NOTES:
- In case this configuration option is defined, then the following
- configuration options will be defined as well
+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`.