netdev - Re: [PATCH bpf-next v3] bpftool: fix build failure

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <85A0240D-076D-4686-8A4A-A636AC268557@fb.com>
Date:   Mon, 14 Sep 2020 21:46:11 +0000
From:   Song Liu <songliubraving@...com>
To:     Yonghong Song <yhs@...com>
CC:     bpf <bpf@...r.kernel.org>, Networking <netdev@...r.kernel.org>,
        "Alexei Starovoitov" <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        "Kernel Team" <Kernel-team@...com>,
        Quentin Monnet <quentin@...valent.com>,
        "Andrii Nakryiko" <andrii.nakryiko@...il.com>
Subject: Re: [PATCH bpf-next v3] bpftool: fix build failure



> On Sep 14, 2020, at 11:31 AM, Yonghong Song <yhs@...com> wrote:
> 
> When building bpf selftests like
>  make -C tools/testing/selftests/bpf -j20
> I hit the following errors:
>  ...
>  GEN      /net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-gen.8
>  <stdin>:75: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
>  <stdin>:71: (WARNING/2) Literal block ends without a blank line; unexpected unindent.
>  <stdin>:85: (WARNING/2) Literal block ends without a blank line; unexpected unindent.
>  <stdin>:57: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
>  <stdin>:66: (WARNING/2) Literal block ends without a blank line; unexpected unindent.
>  <stdin>:109: (WARNING/2) Literal block ends without a blank line; unexpected unindent.
>  <stdin>:175: (WARNING/2) Literal block ends without a blank line; unexpected unindent.
>  <stdin>:273: (WARNING/2) Literal block ends without a blank line; unexpected unindent.
>  make[1]: *** [/net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-perf.8] Error 12
>  make[1]: *** Waiting for unfinished jobs....
>  make[1]: *** [/net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-iter.8] Error 12
>  make[1]: *** [/net-next/tools/testing/selftests/bpf/tools/build/bpftool/Documentation/bpftool-struct_ops.8] Error 12
>  ...
> 
> I am using:
>  -bash-4.4$ rst2man --version
>  rst2man (Docutils 0.11 [repository], Python 2.7.5, on linux2)
>  -bash-4.4$
> 
> The Makefile generated final .rst file (e.g., bpftool-cgroup.rst) looks like
>  ...
>      ID       AttachType      AttachFlags     Name
>  \n SEE ALSO\n========\n\t**bpf**\ (2),\n\t**bpf-helpers**\
>  (7),\n\t**bpftool**\ (8),\n\t**bpftool-btf**\
>  (8),\n\t**bpftool-feature**\ (8),\n\t**bpftool-gen**\
>  (8),\n\t**bpftool-iter**\ (8),\n\t**bpftool-link**\
>  (8),\n\t**bpftool-map**\ (8),\n\t**bpftool-net**\
>  (8),\n\t**bpftool-perf**\ (8),\n\t**bpftool-prog**\
>  (8),\n\t**bpftool-struct_ops**\ (8)\n
> 
> The rst2man generated .8 file looks like
> Literal block ends without a blank line; unexpected unindent.
> .sp
> n SEEALSOn========nt**bpf**(2),nt**bpf\-helpers**(7),nt**bpftool**(8),nt**bpftool\-btf**(8),nt**
> bpftool\-feature**(8),nt**bpftool\-gen**(8),nt**bpftool\-iter**(8),nt**bpftool\-link**(8),nt**
> bpftool\-map**(8),nt**bpftool\-net**(8),nt**bpftool\-perf**(8),nt**bpftool\-prog**(8),nt**
> bpftool\-struct_ops**(8)n
> 
> Looks like that particular version of rst2man prefers to have actual new line
> instead of \n.
> 
> Since `echo -e` may not be available in some environment, let us use `printf`.
> Format string "%b" is used for `printf` to ensure all escape characters are
> interpretted properly.
> 
> Cc: Quentin Monnet <quentin@...valent.com>
> Suggested-by: Andrii Nakryiko <andrii.nakryiko@...il.com>
> Fixes: 18841da98100 ("tools: bpftool: Automate generation for "SEE ALSO" sections in man pages")
> Signed-off-by: Yonghong Song <yhs@...com>

Acked-by: Song Liu <songliubraving@...com>