Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
erofs: update the Kconfig description
Refine the description to better highlight its features and use cases.
In addition, add instructions for building it as a module and clarify
the compression option.
Reviewed-by: Chao Yu <chao@kernel.org>
Signed-off-by: Gao Xiang <hsiangkao@linux.alibaba.com>
+29
-14
+29
-14
fs/erofs/Kconfig
+29
-14
fs/erofs/Kconfig
···
16
16
select ZLIB_INFLATE if EROFS_FS_ZIP_DEFLATE
17
17
select ZSTD_DECOMPRESS if EROFS_FS_ZIP_ZSTD
18
18
help
19
-
EROFS (Enhanced Read-Only File System) is a lightweight read-only
20
-
file system with modern designs (e.g. no buffer heads, inline
21
-
xattrs/data, chunk-based deduplication, multiple devices, etc.) for
22
-
scenarios which need high-performance read-only solutions, e.g.
23
-
smartphones with Android OS, LiveCDs and high-density hosts with
24
-
numerous containers;
19
+
EROFS (Enhanced Read-Only File System) is a modern, lightweight,
20
+
secure read-only filesystem for various use cases, such as immutable
21
+
system images, container images, application sandboxes, and datasets.
25
22
26
-
It also provides transparent compression and deduplication support to
27
-
improve storage density and maintain relatively high compression
28
-
ratios, and it implements in-place decompression to temporarily reuse
29
-
page cache for compressed data using proper strategies, which is
30
-
quite useful for ensuring guaranteed end-to-end runtime decompression
23
+
EROFS uses a flexible, hierarchical on-disk design so that features
24
+
can be enabled on demand: the core on-disk format is block-aligned in
25
+
order to perform optimally on all kinds of devices, including block
26
+
and memory-backed devices; the format is easy to parse and has zero
27
+
metadata redundancy, unlike generic filesystems, making it ideal for
28
+
filesystem auditing and remote access; inline data, random-access
29
+
friendly directory data, inline/shared extended attributes and
30
+
chunk-based deduplication ensure space efficiency while maintaining
31
+
high performance.
32
+
33
+
Optionally, it supports multiple devices to reference external data,
34
+
enabling data sharing for container images.
35
+
36
+
It also has advanced encoded on-disk layouts, particularly for data
37
+
compression and fine-grained deduplication. It utilizes fixed-size
38
+
output compression to improve storage density while keeping relatively
39
+
high compression ratios. Furthermore, it implements in-place
40
+
decompression to reuse file pages to keep compressed data temporarily
41
+
with proper strategies, which ensures guaranteed end-to-end runtime
31
42
performance under extreme memory pressure without extra cost.
32
43
33
-
See the documentation at <file:Documentation/filesystems/erofs.rst>
34
-
and the web pages at <https://erofs.docs.kernel.org> for more details.
44
+
For more details, see the web pages at <https://erofs.docs.kernel.org>
45
+
and the documentation at <file:Documentation/filesystems/erofs.rst>.
46
+
47
+
To compile EROFS filesystem support as a module, choose M here. The
48
+
module will be called erofs.
35
49
36
50
If unsure, say N.
37
51
···
119
105
depends on EROFS_FS
120
106
default y
121
107
help
122
-
Enable transparent compression support for EROFS file systems.
108
+
Enable EROFS compression layouts so that filesystems containing
109
+
compressed files can be parsed by the kernel.
123
110
124
111
If you don't want to enable compression feature, say N.
125
112