Skip to contentSkip to conversation

man/man7/landlock.7: Document whiteout object peculiarities

PATCH In review Günther Noack 2 participants 7 messages Aug 28 – Nov 7 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man/man7/landlock.7: Document whiteout object peculiarities

Bring documentation for LANDLOCK_ACCESS_FS_MAKE_REG in line with the Landlock whiteout patch [1].

---
 man/man7/landlock.7 | 3 +++
 1 file changed, 3 insertions(+)
man/man7/landlock.7 +3 -0
index 880dd50582f3..3642a64ff1f6 100644
@@ -204,6 +204,9 @@ Create (or rename) a directory.
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_REG
 Create (or rename or link) a regular file.
+.IP
+This also guards the creation of whiteout objects
+as used in OverlayFS.
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_SOCK
 Create (or rename or link) a UNIX domain socket.
Signature · 1 line
2.55.0
maintainer Reviewed-by on v1 1/1
#2 lore raw
In reply to Günther Noack

Hi Günther,

Quoted 17 lines

Date: 2026-08-28 18:03:41+0200
From: Günther Noack <[email protected]>

Bring documentation for LANDLOCK_ACCESS_FS_MAKE_REG in line with the Landlock whiteout patch [1].

---
 man/man7/landlock.7 | 3 +++
 1 file changed, 3 insertions(+)
man/man7/landlock.7 +0 -0
index 880dd50582f3..3642a64ff1f6 100644

man/man7/landlock.7 Create (or rename) a directory. · line 209

Quoted 6 lines
man/man7/landlock.7 +3 -0
@@ -204,6 +204,9 @@ Create (or rename) a directory.
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_REG
 Create (or rename or link) a regular file.
+.IP
+This also guards the creation of whiteout objects
+as used in OverlayFS.

I guess this should not be applied yet, right? If it's ready, please let me know.

Have a lovely night!
Alex

Quoted 6 lines
man/man7/landlock.7 +0 -0
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_SOCK
 Create (or rename or link) a UNIX domain socket.
Signature · 1 line
2.55.0
Signature · 1 line
<https://www.alejandro-colomar.es>
#3 lore raw

Hello Alejandro,

Quoted 27 lines · Alejandro Colomar
Quoted 17 lines

Date: 2026-08-28 18:03:41+0200
From: Günther Noack <[email protected]>

Bring documentation for LANDLOCK_ACCESS_FS_MAKE_REG in line with the Landlock whiteout patch [1].

---
 man/man7/landlock.7 | 3 +++
 1 file changed, 3 insertions(+)
man/man7/landlock.7 +0 -0
index 880dd50582f3..3642a64ff1f6 100644

man/man7/landlock.7 Create (or rename) a directory. · line 209

Quoted 6 lines
man/man7/landlock.7 +3 -0
@@ -204,6 +204,9 @@ Create (or rename) a directory.
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_REG
 Create (or rename or link) a regular file.
+.IP
+This also guards the creation of whiteout objects
+as used in OverlayFS.
Quoted 2 lines

I guess this should not be applied yet, right? If it's ready, please let me know.

The whiteout patch has been backported as bugfix to Linux 7.2, 6.18, 6.12, 6.6 and 6.1. Since it is in stable, I think this can be considered ready for the purpose of putting it into man pages? (Otherwise, we can also wait for the 7.3 release.)

–Günther

#4 lore raw

Hi Günther,

Quoted 33 lines

Date: 2026-09-26 16:10:44+0200
From: Günther Noack <[email protected]>

Hello Alejandro,

Quoted 27 lines · Alejandro Colomar
Quoted 17 lines

Date: 2026-08-28 18:03:41+0200
From: Günther Noack <[email protected]>

Bring documentation for LANDLOCK_ACCESS_FS_MAKE_REG in line with the Landlock whiteout patch [1].

---
 man/man7/landlock.7 | 3 +++
 1 file changed, 3 insertions(+)
man/man7/landlock.7 +0 -0
index 880dd50582f3..3642a64ff1f6 100644

man/man7/landlock.7 Create (or rename) a directory. · line 209

Quoted 6 lines
man/man7/landlock.7 +3 -0
@@ -204,6 +204,9 @@ Create (or rename) a directory.
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_REG
 Create (or rename or link) a regular file.
+.IP
+This also guards the creation of whiteout objects
+as used in OverlayFS.
Quoted 7 lines
Quoted 2 lines

I guess this should not be applied yet, right? If it's ready, please let me know.

The whiteout patch has been backported as bugfix to Linux 7.2, 6.18, 6.12, 6.6 and 6.1. Since it is in stable, I think this can be considered ready for the purpose of putting it into man pages? (Otherwise, we can also wait for the 7.3 release.)

Yes, it's good for the man pages. Does it need any update regarding version numbers or HISTORY, or should I pick the patch as is?

Have a lovely night!
Alex

Quoted 3 lines

–Günther

Signature · 1 line
<https://www.alejandro-colomar.es>
#5 lore raw

Hello Alejandro!

Quoted 31 lines · Alejandro Colomar
Quoted 31 lines · Alejandro Colomar
Quoted 29 lines
Quoted 17 lines

Date: 2026-08-28 18:03:41+0200
From: Günther Noack <[email protected]>

Bring documentation for LANDLOCK_ACCESS_FS_MAKE_REG in line with the Landlock whiteout patch [1].

---
 man/man7/landlock.7 | 3 +++
 1 file changed, 3 insertions(+)
man/man7/landlock.7 +0 -0
index 880dd50582f3..3642a64ff1f6 100644

man/man7/landlock.7 Create (or rename) a directory. · line 209

Quoted 6 lines
man/man7/landlock.7 +3 -0
@@ -204,6 +204,9 @@ Create (or rename) a directory.
 .TP
 .B LANDLOCK_ACCESS_FS_MAKE_REG
 Create (or rename or link) a regular file.
+.IP
+This also guards the creation of whiteout objects
+as used in OverlayFS.

I guess this should not be applied yet, right? If it's ready, please let me know.

Quoted 7 lines
Quoted 4 lines

The whiteout patch has been backported as bugfix to Linux 7.2, 6.18, 6.12, 6.6 and 6.1. Since it is in stable, I think this can be considered ready for the purpose of putting it into man pages? (Otherwise, we can also wait for the 7.3 release.)

Yes, it's good for the man pages. Does it need any update regarding version numbers or HISTORY, or should I pick the patch as is?

I think it is fine to pick it as it is.

It was a bugfix and it is available on all Landlock ABI versions exposed by stable kernels. So the described behaviour applies on all supported kernels and Landlock ABI versions.

Because it is a behavioural change, callers can probe for the presence of the fix with Landlock's "errata" mechanism, as documented in landlock_create_ruleset(2). The list of the existing errata is best checked in the most up-to-date source in the kernel documentation, which we are also linking from landlock_create_ruleset(2), so that users are encouraged to look for the most up to date list there.

–Günther

#6 lore raw

Hi!

Quoted 3 lines

Date: 2026-10-11 21:44:08+0200
From: Günther Noack <[email protected]>

[...]

Quoted 2 lines

I think it is fine to pick it as it is.

Thanks! I've applied the patch.

Cheers,
Alex

Quoted 14 lines

It was a bugfix and it is available on all Landlock ABI versions exposed by stable kernels. So the described behaviour applies on all supported kernels and Landlock ABI versions.

Because it is a behavioural change, callers can probe for the presence of the fix with Landlock's "errata" mechanism, as documented in landlock_create_ruleset(2). The list of the existing errata is best checked in the most up-to-date source in the kernel documentation, which we are also linking from landlock_create_ruleset(2), so that users are encouraged to look for the most up to date list there.

–Günther

Signature · 1 line
<https://www.alejandro-colomar.es>