Re: [PATCH] bpf-helpers.7: Remove duplicated words and add missing articles

["Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>]

Hi Florian,

This page is autogenerated from text in the kernel source. See
man-pages commit 53666f6c30451cde

[[
    Generating the page itself is a two-step process. First, the
    documentation is extracted from include/uapi/linux/bpf.h, and converted
    to a RST (reStructuredText-formatted) page, with the relevant script
    from Linux sources:

          $ ./scripts/bpf_helpers_doc.py > /tmp/bpf-helpers.rst

    The second step consists in turning the RST document into the final man
    page, with rst2man:

          $ rst2man /tmp/bpf-helpers.rst > bpf-helpers.7
]]

I've just refreshed this manual page as per the above steps, and the
typos you note below are still present.

You'd need to craft a patch against the kernel source file
include/uapi/linux/bpf.h. Or perhaps Quentin or Daniel (who I think
roughly own this file) might make the changes directly.

Thanks,

Michael


On Tue, 12 Nov 2019 at 22:45, Florian Weimer <fw@deneb.enyo.de> wrote:
>
> Signed-off-by: Florian Weimer <fw@deneb.enyo.de>
> ---
>  man7/bpf-helpers.7 | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/man7/bpf-helpers.7 b/man7/bpf-helpers.7
> index 6f07f476e..0ac569c1d 100644
> --- a/man7/bpf-helpers.7
> +++ b/man7/bpf-helpers.7
> @@ -1546,8 +1546,8 @@ Where t_enabled is the time enabled for event and t_running is
>  the time running for event since last normalization. The
>  enabled and running times are accumulated since the perf event
>  open. To achieve scaling factor between two invocations of an
> -eBPF program, users can can use CPU id as the key (which is
> -typical for perf array usage model) to remember the previous
> +eBPF program, users can use the CPU id as the key (which is
> +typical for the perf array usage model) to remember the previous
>  value and do the calculation inside the eBPF program.
>  .TP
>  .B Return
> @@ -1605,7 +1605,7 @@ the return value of the probed function, and to set it to \fIrc\fP\&.
>  The first argument is the context \fIregs\fP on which the kprobe
>  works.
>  .sp
> -This helper works by setting setting the PC (program counter)
> +This helper works by setting the PC (program counter)
>  to an override function which is run in place of the original
>  probed function. This means the probed function is not run at
>  all. The replacement function just returns with the required
> --
> 2.20.1
>


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/