Skip to content

Commit 938c418

Browse files
committed
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>
1 parent c23df30 commit 938c418

1 file changed

Lines changed: 30 additions & 15 deletions

File tree

fs/erofs/Kconfig

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,36 @@ config EROFS_FS
1616
select ZLIB_INFLATE if EROFS_FS_ZIP_DEFLATE
1717
select ZSTD_DECOMPRESS if EROFS_FS_ZIP_ZSTD
1818
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;
25-
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
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.
22+
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
3142
performance under extreme memory pressure without extra cost.
3243

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.
3549

3650
If unsure, say N.
3751

@@ -105,7 +119,8 @@ config EROFS_FS_ZIP
105119
depends on EROFS_FS
106120
default y
107121
help
108-
Enable transparent compression support for EROFS file systems.
122+
Enable EROFS compression layouts so that filesystems containing
123+
compressed files can be parsed by the kernel.
109124

110125
If you don't want to enable compression feature, say N.
111126

0 commit comments

Comments
 (0)