summaryrefslogtreecommitdiffstats
path: root/c-user/config/filesystem.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-27 12:53:09 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-04-01 07:49:12 +0200
commit7bad8940ad05ea1e3b41745012a0dc5391275477 (patch)
tree417974a7eedf1b89c709648c36e1d234934b9ff7 /c-user/config/filesystem.rst
parentc-user: Avoid self references (diff)
downloadrtems-docs-7bad8940ad05ea1e3b41745012a0dc5391275477.tar.bz2
c-user: Use new template for integer config opts
Try to bring all descriptions up to date. Add cross-references to several options. Clarify configuration value constraints. Use this template also for initializer type options. Close #3901.
Diffstat (limited to 'c-user/config/filesystem.rst')
-rw-r--r--c-user/config/filesystem.rst39
1 files changed, 19 insertions, 20 deletions
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 3a7b7fe..b4bccc9 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -70,7 +70,7 @@ DESCRIPTION:
configured.
NOTES:
- Filesystems must be initialized to support file descriptor based device
+ 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.
@@ -421,26 +421,28 @@ CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
CONSTANT:
``CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK``
-DATA TYPE:
- Boolean feature macro.
-
-RANGE:
- Valid values for this configuration parameter are a power of two (2)
- between 16 and 512 inclusive. In other words, valid values are 16, 32, 64,
- 128, 256,and 512.
+OPTION TYPE:
+ This configuration option is an integer define.
DEFAULT VALUE:
- The default IMFS block size is 128 bytes.
+ The default value is 128.
+
+VALUE CONSTRAINTS:
+ The value of this configuration option shall be
+ an element of {16, 32, 64, 128, 256, 512}.
DESCRIPTION:
- This configuration parameter specifies the block size for in-memory files
- managed by the IMFS. 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.
+
+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.
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
@@ -460,9 +462,6 @@ 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: