Skip to content

Commit 36cd95d

Browse files
author
Miklos Szeredi
committed
ovl: update Kconfig texts
Add some hints about overlayfs kernel config options. Enabling NFS export by default is especially recommended against, as it incurs a performance penalty even if the filesystem is not actually exported. Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>
1 parent d1fe96c commit 36cd95d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

fs/overlayfs/Kconfig

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ config OVERLAY_FS_REDIRECT_DIR
2424
an overlay which has redirects on a kernel that doesn't support this
2525
feature will have unexpected results.
2626

27+
If unsure, say N.
28+
2729
config OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW
2830
bool "Overlayfs: follow redirects even if redirects are turned off"
2931
default y
@@ -32,8 +34,13 @@ config OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW
3234
Disable this to get a possibly more secure configuration, but that
3335
might not be backward compatible with previous kernels.
3436

37+
If backward compatibility is not an issue, then it is safe and
38+
recommended to say N here.
39+
3540
For more information, see Documentation/filesystems/overlayfs.txt
3641

42+
If unsure, say Y.
43+
3744
config OVERLAY_FS_INDEX
3845
bool "Overlayfs: turn on inodes index feature by default"
3946
depends on OVERLAY_FS
@@ -51,6 +58,8 @@ config OVERLAY_FS_INDEX
5158
That is, mounting an overlay which has an inodes index on a kernel
5259
that doesn't support this feature will have unexpected results.
5360

61+
If unsure, say N.
62+
5463
config OVERLAY_FS_NFS_EXPORT
5564
bool "Overlayfs: turn on NFS export feature by default"
5665
depends on OVERLAY_FS
@@ -72,3 +81,8 @@ config OVERLAY_FS_NFS_EXPORT
7281
Note, that the NFS export feature is not backward compatible.
7382
That is, mounting an overlay which has a full index on a kernel
7483
that doesn't support this feature will have unexpected results.
84+
85+
Most users should say N here and enable this feature on a case-by-
86+
case basis with the "nfs_export=on" mount option.
87+
88+
Say N unless you fully understand the consequences.

0 commit comments

Comments
 (0)