mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix
PATCH 1/1 mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix
Spell "run time" in two words, as documented in man-pages(7).
--- man2/mount_setattr.2 | 2 +- man2/openat2.2 | 2 +- man7/bpf-helpers.7 | 2 +- man7/landlock.7 | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)
man2/mount_setattr.2 +1 -1
@@ -862,7 +862,7 @@ may change in the future user-space applications should zero-fill .I struct mount_attr to ensure that recompiling the program with new headers will not result in -spurious errors at runtime. +spurious errors at run time. The simplest way is to use a designated initializer: .PP .in +4n
man2/openat2.2 +1 -1
@@ -545,7 +545,7 @@ may change in the future (with new fields being added when system headers are updated), user-space applications should zero-fill .I struct open_how to ensure that recompiling the program with new headers will not result in -spurious errors at runtime. +spurious errors at run time. The simplest way is to use a designated initializer: .PP
man7/bpf-helpers.7 +1 -1
@@ -3025,7 +3025,7 @@ copied and the last byte is set to NUL. On success, returns the number of bytes that were written, including the terminal NUL. This makes this helper useful in tracing programs for reading strings, and more importantly to -get its length at runtime. See the following snippet: +get its length at run time. See the following snippet: .INDENT 7.0 .INDENT 3.5 .sp
man7/landlock.7 +1 -1
@@ -251,7 +251,7 @@ will stay enforced on all this thread's descendants. This allows creating standalone and modular security policies per application, which will automatically be composed between themselves -according to their runtime parent policies. +according to their run time parent policies. .\" .SS Ptrace restrictions A sandboxed process has less privileges than a non-sandboxed process and
base-commit: 59e44e4511391a98f531c08aaba17391f3b7075b
Signature · 1 line
2.40.0
Hi Günther,
Quoted 15 lines · Günther Noack
Spell "run time" in two words, as documented in man-pages(7).
Signed-off-by Günther Noack <[email protected]>--- man2/mount_setattr.2 | 2 +- man2/openat2.2 | 2 +- man7/bpf-helpers.7 | 2 +- man7/landlock.7 | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)man2/mount_setattr.2 +0
-0
man2/mount_setattr.2 may change in the future · line 865
Quoted 5 lines
man2/mount_setattr.2 +1
-1@@ -862,7 +862,7 @@ may change in the future user-space applications should zero-fill .I struct mount_attr to ensure that recompiling the program with new headers will not result in -spurious errors at runtime. +spurious errors at run time.
Good.
man2/openat2.2 may change in the future (with new fields being added when system headers are · line 548
Quoted 13 lines
man2/mount_setattr.2 +0
-0The simplest way is to use a designated initializer: .PP .in +4nman2/openat2.2 +1
-1@@ -545,7 +545,7 @@ may change in the future (with new fields being added when system headers are updated), user-space applications should zero-fill .I struct open_how to ensure that recompiling the program with new headers will not result in -spurious errors at runtime. +spurious errors at run time.
Good.
man7/bpf-helpers.7 copied and the last byte is set to NUL. · line 3028
Quoted 13 lines
man2/openat2.2 +0
-0The simplest way is to use a designated initializer: .PPman7/bpf-helpers.7 +1
-1@@ -3025,7 +3025,7 @@ copied and the last byte is set to NUL. On success, returns the number of bytes that were written, including the terminal NUL. This makes this helper useful in tracing programs for reading strings, and more importantly to -get its length at runtime. See the following snippet: +get its length at run time. See the following snippet:
Good, but bpf-helpers.7 is generated from kernel sources. This one will depend on what kernel developers want. I CCed Quentin, since he's nice and might be able to tell if BPF guys are interested in this kind of wording fixes.
man7/landlock.7 will stay enforced on all this thread's descendants. · line 254
Quoted 13 lines
man7/bpf-helpers.7 +0
-0.INDENT 7.0 .INDENT 3.5 .spman7/landlock.7 +1
-1@@ -251,7 +251,7 @@ will stay enforced on all this thread's descendants. This allows creating standalone and modular security policies per application, which will automatically be composed between themselves -according to their runtime parent policies. +according to their run time parent policies.
In this case, since it works as an adjective, it should be "run-time", with a hyphen.
Cheers,
Alex
Quoted 5 lines
man7/landlock.7 +0
-0.\" .SS Ptrace restrictions A sandboxed process has less privileges than a non-sandboxed process andbase-commit:
59e44e4511391a98f531c08aaba17391f3b7075b
Signature · 2 lines
<http://www.alejandro-colomar.es/> GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5
Quoted 7 lines · Alejandro Colomar
Quoted 7 lines
man7/bpf-helpers.7 +0
-0@@ -3025,7 +3025,7 @@ copied and the last byte is set to NUL. On success, returns the number of bytes that were written, including the terminal NUL. This makes this helper useful in
Quoted 8 lines
man7/bpf-helpers.7 copied and the last byte is set to NUL. · line 3028
Quoted 3 lines
man7/bpf-helpers.7 +1
-1tracing programs for reading strings, and more importantly to -get its length at runtime. See the following snippet: +get its length at run time. See the following snippet:Good, but bpf-helpers.7 is generated from kernel sources. This one will depend on what kernel developers want. I CCed Quentin, since he's nice and might be able to tell if BPF guys are interested in this kind of wording fixes.
Hi Günther, Alejandro,
Yes, this page is generated from the comments in include/uapi/linux/bpf.h, in the kernel repository. From the root of the repo, you can visualise the changes with:
$ ./scripts/bpf_doc.py | rst2man | man -l -
I can't speak for the rest of BPF folks, but personally I'm OK with the patch, especially if it makes spelling more consistent between man pages. Patches for this file should target the bpf-next tree
(https://docs.kernel.org/bpf/bpf_devel_QA.html#submitting-patches).
Thanks,
Quentin
Quoted 14 lines · Alejandro Colomar
man7/bpf-helpers.7 copied and the last byte is set to NUL. · line 3028
Quoted 8 lines · Günther Noack
man7/bpf-helpers.7 +1
-1@@ -3025,7 +3025,7 @@ copied and the last byte is set to NUL. On success, returns the number of bytes that were written, including the terminal NUL. This makes this helper useful in tracing programs for reading strings, and more importantly to -get its length at runtime. See the following snippet: +get its length at run time. See the following snippet:Good, but bpf-helpers.7 is generated from kernel sources. This one will depend on what kernel developers want. I CCed Quentin, since he's nice and might be able to tell if BPF guys are interested in this kind of wording fixes.
Ah, whoops, that's a good point.
I'll remove that part of the patch then, because the fix would have to go in the kernel source.
Quoted 11 lines
man7/landlock.7 will stay enforced on all this thread's descendants. · line 254
Quoted 8 lines
man7/landlock.7 +1
-1@@ -251,7 +251,7 @@ will stay enforced on all this thread's descendants. This allows creating standalone and modular security policies per application, which will automatically be composed between themselves -according to their runtime parent policies. +according to their run time parent policies.In this case, since it works as an adjective, it should be "run-time", with a hyphen.
Thanks, good point. Fixed.
–Günther