bpf-helpers.7: Remove duplicated words and add missing articles
PATCH 1/1 bpf-helpers.7: Remove duplicated words and add missing articles
--- man7/bpf-helpers.7 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
man7/bpf-helpers.7 +3 -3
@@ -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
Signature · 1 line
2.20.1
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
Quoted 33 lines · Florian Weimer
Signed-off-by Florian Weimer <[email protected]>--- man7/bpf-helpers.7 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)man7/bpf-helpers.7 +3
-4@@ -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
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
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) <[email protected]>
Quoted 67 lines
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 frominclude/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.rstThe 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
Quoted 33 lines · Florian Weimer
Signed-off-by Florian Weimer <[email protected]>--- man7/bpf-helpers.7 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)man7/bpf-helpers.7 +3
-4@@ -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