[PATCH] mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix

[PATCH] mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix

[Günther Noack]

Spell "run time" in two words, as documented in man-pages(7).

Signed-off-by: Günther Noack <gnoack3000@gmail.com>
---
 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(-)

diff --git a/man2/mount_setattr.2 b/man2/mount_setattr.2
index 24801a4bd..8df02641a 100644
--- a/man2/mount_setattr.2
+++ b/man2/mount_setattr.2
@@ -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
diff --git a/man2/openat2.2 b/man2/openat2.2
index e90211fad..182851089 100644
--- a/man2/openat2.2
+++ b/man2/openat2.2
@@ -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
diff --git a/man7/bpf-helpers.7 b/man7/bpf-helpers.7
index 26ddf8369..663dfd1d1 100644
--- a/man7/bpf-helpers.7
+++ b/man7/bpf-helpers.7
@@ -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
diff --git a/man7/landlock.7 b/man7/landlock.7
index b6c9d3821..250b69635 100644
--- a/man7/landlock.7
+++ b/man7/landlock.7
@@ -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
-- 
2.40.0

Re: [PATCH] mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 3065 bytes --]

Hi Günther,

On 4/21/23 17:05, Günther Noack wrote:
> Spell "run time" in two words, as documented in man-pages(7).
> 
> Signed-off-by: Günther Noack <gnoack3000@gmail.com>
> ---
>  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(-)
> 
> diff --git a/man2/mount_setattr.2 b/man2/mount_setattr.2
> index 24801a4bd..8df02641a 100644
> --- a/man2/mount_setattr.2
> +++ b/man2/mount_setattr.2
> @@ -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.

>  The simplest way is to use a designated initializer:
>  .PP
>  .in +4n
> diff --git a/man2/openat2.2 b/man2/openat2.2
> index e90211fad..182851089 100644
> --- a/man2/openat2.2
> +++ b/man2/openat2.2
> @@ -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.

>  The simplest way is to use a designated
>  initializer:
>  .PP
> diff --git a/man7/bpf-helpers.7 b/man7/bpf-helpers.7
> index 26ddf8369..663dfd1d1 100644
> --- a/man7/bpf-helpers.7
> +++ b/man7/bpf-helpers.7
> @@ -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.

>  .INDENT 7.0
>  .INDENT 3.5
>  .sp
> diff --git a/man7/landlock.7 b/man7/landlock.7
> index b6c9d3821..250b69635 100644
> --- a/man7/landlock.7
> +++ b/man7/landlock.7
> @@ -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

>  .\"
>  .SS Ptrace restrictions
>  A sandboxed process has less privileges than a non-sandboxed process and
> 
> base-commit: 59e44e4511391a98f531c08aaba17391f3b7075b

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix

[Quentin Monnet]

On Fri, 21 Apr 2023 at 20:45, Alejandro Colomar <alx.manpages@gmail.com> wrote:

> > diff --git a/man7/bpf-helpers.7 b/man7/bpf-helpers.7
> > index 26ddf8369..663dfd1d1 100644
> > --- a/man7/bpf-helpers.7
> > +++ b/man7/bpf-helpers.7
> > @@ -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.

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

Re: [PATCH] mount_setattr.2, openat2.2, bpf-helpers.7, landlock.7: wfix

[Günther Noack]

On Fri, Apr 21, 2023 at 09:45:15PM +0200, Alejandro Colomar wrote:
> On 4/21/23 17:05, Günther Noack wrote:
> > --- a/man7/bpf-helpers.7
> > +++ b/man7/bpf-helpers.7
> > @@ -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.

> > --- a/man7/landlock.7
> > +++ b/man7/landlock.7
> > @@ -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