[v2] Fit lines in 80 columns

Commit Message

Alejandro Colomar Aug. 29, 2022, 7:58 p.m. UTC

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 <[e-mail]>
Cc: bpf <[e-mail]>
Cc: linux-man <[e-mail]>
Cc: Daniel Borkmann <[e-mail]>
Cc: Andrii Nakryiko <[e-mail]>
Cc: Martin KaFai Lau <[e-mail]>
Cc: Song Liu <[e-mail]>
Cc: Yonghong Song <[e-mail]>
Cc: John Fastabend <[e-mail]>
Cc: KP Singh <[e-mail]>
Cc: Stanislav Fomichev <[e-mail]>
Cc: Hao Luo <[e-mail]>
Cc: Jiri Olsa <[e-mail]>
Cc: Jesper Dangaard Brouer <[e-mail]>
Cc: Quentin Monnet <[e-mail]>
Cc: Greg KH <[e-mail]>
Cc: "G. Branden Robinson" <[e-mail]>
Signed-off-by: Alejandro Colomar <[e-mail]>
---
 include/uapi/linux/bpf.h       | 11 ++++++-----
 tools/include/uapi/linux/bpf.h | 11 ++++++-----
 2 files changed, 12 insertions(+), 10 deletions(-)

Comments

Daniel Borkmann Aug. 29, 2022, 8:29 p.m. UTC | #1

On 8/29/22 9:58 PM, Alejandro Colomar wrote:
> 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 <[e-mail]>
> Cc: bpf <[e-mail]>
> Cc: linux-man <[e-mail]>
> Cc: Daniel Borkmann <[e-mail]>
> Cc: Andrii Nakryiko <[e-mail]>
> Cc: Martin KaFai Lau <[e-mail]>
> Cc: Song Liu <[e-mail]>
> Cc: Yonghong Song <[e-mail]>
> Cc: John Fastabend <[e-mail]>
> Cc: KP Singh <[e-mail]>
> Cc: Stanislav Fomichev <[e-mail]>
> Cc: Hao Luo <[e-mail]>
> Cc: Jiri Olsa <[e-mail]>
> Cc: Jesper Dangaard Brouer <[e-mail]>
> Cc: Quentin Monnet <[e-mail]>
> Cc: Greg KH <[e-mail]>
> Cc: "G. Branden Robinson" <[e-mail]>
> Signed-off-by: Alejandro Colomar <[e-mail]>
> ---
>   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);
>    *

Aside that this has been Nacked before, this looks really ugly. I'm not applying
this, sorry.

Thanks,
Daniel

Patch

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