Those lines is used to generate the bpf-helpers(7) manual page.
They are no-fill lines, since they represent code, which means
that the formatter can't break the line, and instead just runs
across the right margin (in most set-ups this means that the pager
will break the line).
Using <fmt> makes it end exactly at the 80-col right margin, both
in the header file, and also in the manual page, and also seems to
be a sensible name to me.
In the other case, the fix has been to separate the variable
definition and its use, as the kernel coding style recommends.
Nacked-by: Alexei Starovoitov <ast@xxxxxxxxxx>
Cc: bpf <bpf@xxxxxxxxxxxxxxx>
Cc: linux-man <linux-man@xxxxxxxxxxxxxxx>
Cc: Daniel Borkmann <daniel@xxxxxxxxxxxxx>
Cc: Andrii Nakryiko <andrii@xxxxxxxxxx>
Cc: Martin KaFai Lau <kafai@xxxxxx>
Cc: Song Liu <songliubraving@xxxxxx>
Cc: Yonghong Song <yhs@xxxxxx>
Cc: John Fastabend <john.fastabend@xxxxxxxxx>
Cc: KP Singh <kpsingh@xxxxxxxxxx>
Cc: Stanislav Fomichev <sdf@xxxxxxxxxx>
Cc: Hao Luo <haoluo@xxxxxxxxxx>
Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
Cc: Jesper Dangaard Brouer <brouer@xxxxxxxxxx>
Cc: Quentin Monnet <quentin@xxxxxxxxxxxxx>
Cc: Greg KH <gregkh@xxxxxxxxxxxxxxxxxxx>
Cc: "G. Branden Robinson" <g.branden.robinson@xxxxxxxxx>
Signed-off-by: Alejandro Colomar <alx.manpages@xxxxxxxxx>
---
include/uapi/linux/bpf.h | 11 ++++++-----
tools/include/uapi/linux/bpf.h | 11 ++++++-----
2 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index ef78e0e1a754..1443fa2a1915 100644
--- a/include/uapi/linux/bpf.h
+++ b/include/uapi/linux/bpf.h
@@ -1619,7 +1619,7 @@ union bpf_attr {
*
* ::
*
- * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg>
+ * telnet-470 [001] .N.. 419421.045894: 0x00000001: <fmt>
*
* In the above:
*
@@ -1636,8 +1636,7 @@ union bpf_attr {
* * ``419421.045894`` is a timestamp.
* * ``0x00000001`` is a fake value used by BPF for the
* instruction pointer register.
- * * ``<formatted msg>`` is the message formatted with
- * *fmt*.
+ * * ``<fmt>`` is the message formatted with *fmt*.
*
* The conversion specifiers supported by *fmt* are similar, but
* more limited than for printk(). They are **%d**, **%i**,
@@ -3860,8 +3859,10 @@ union bpf_attr {
* void bpf_sys_open(struct pt_regs *ctx)
* {
* char buf[PATHLEN]; // PATHLEN is defined to 256
- * int res = bpf_probe_read_user_str(buf, sizeof(buf),
- * ctx->di);
+ * int res;
+ *
+ * res = bpf_probe_read_user_str(buf, sizeof(buf),
+ * ctx->di);
*
* // Consume buf, for example push it to
* // userspace via bpf_perf_event_output(); we
diff --git a/tools/include/uapi/linux/bpf.h b/tools/include/uapi/linux/bpf.h
index ef78e0e1a754..1443fa2a1915 100644
--- a/tools/include/uapi/linux/bpf.h
+++ b/tools/include/uapi/linux/bpf.h
@@ -1619,7 +1619,7 @@ union bpf_attr {
*
* ::
*
- * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg>
+ * telnet-470 [001] .N.. 419421.045894: 0x00000001: <fmt>
*
* In the above:
*
@@ -1636,8 +1636,7 @@ union bpf_attr {
* * ``419421.045894`` is a timestamp.
* * ``0x00000001`` is a fake value used by BPF for the
* instruction pointer register.
- * * ``<formatted msg>`` is the message formatted with
- * *fmt*.
+ * * ``<fmt>`` is the message formatted with *fmt*.
*
* The conversion specifiers supported by *fmt* are similar, but
* more limited than for printk(). They are **%d**, **%i**,
@@ -3860,8 +3859,10 @@ union bpf_attr {
* void bpf_sys_open(struct pt_regs *ctx)
* {
* char buf[PATHLEN]; // PATHLEN is defined to 256
- * int res = bpf_probe_read_user_str(buf, sizeof(buf),
- * ctx->di);
+ * int res;
+ *
+ * res = bpf_probe_read_user_str(buf, sizeof(buf),
+ * ctx->di);
*
* // Consume buf, for example push it to
* // userspace via bpf_perf_event_output(); we
--
2.37.2
