* [PATCH] bpf-helpers.7: Remove duplicated words and add missing articles @ 2019-11-12 21:45 Florian Weimer 2019-11-19 11:48 ` Michael Kerrisk (man-pages) 0 siblings, 1 reply; 3+ messages in thread From: Florian Weimer @ 2019-11-12 21:45 UTC (permalink / raw) To: linux-man 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 ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] bpf-helpers.7: Remove duplicated words and add missing articles 2019-11-12 21:45 [PATCH] bpf-helpers.7: Remove duplicated words and add missing articles Florian Weimer @ 2019-11-19 11:48 ` Michael Kerrisk (man-pages) 2019-11-19 11:55 ` Quentin Monnet 0 siblings, 1 reply; 3+ messages in thread From: Michael Kerrisk (man-pages) @ 2019-11-19 11:48 UTC (permalink / raw) To: Florian Weimer; +Cc: linux-man, Quentin Monnet, Daniel Borkmann 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/ ^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] bpf-helpers.7: Remove duplicated words and add missing articles 2019-11-19 11:48 ` Michael Kerrisk (man-pages) @ 2019-11-19 11:55 ` Quentin Monnet 0 siblings, 0 replies; 3+ messages in thread From: Quentin Monnet @ 2019-11-19 11:55 UTC (permalink / raw) To: mtk.manpages, Florian Weimer; +Cc: linux-man, Daniel Borkmann Hi Florian, Michael, Sure, I would be glad to help or even to submit the changes against bpf-next tree if it is easier for you. Just let me know. And thank you for the fix! Best, Quentin 2019-11-19 12:48 UTC+0100 ~ 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 >> > > ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-11-19 11:55 UTC | newest] Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2019-11-12 21:45 [PATCH] bpf-helpers.7: Remove duplicated words and add missing articles Florian Weimer 2019-11-19 11:48 ` Michael Kerrisk (man-pages) 2019-11-19 11:55 ` Quentin Monnet
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).