netdev - Re: [PATCH bpf-next] bpftool: work-around rst2man conversion bug

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: <CAEf4BzboNRcqaeZ7drGCDiMqRRHjCipAG992rnn46fBSfcnxbQ@mail.gmail.com>
Date:   Wed, 18 Dec 2019 16:40:53 -0800
From:   Andrii Nakryiko <andrii.nakryiko@...il.com>
To:     Yonghong Song <yhs@...com>
Cc:     Andrii Nakryiko <andriin@...com>,
        "bpf@...r.kernel.org" <bpf@...r.kernel.org>,
        "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        Alexei Starovoitov <ast@...com>,
        "daniel@...earbox.net" <daniel@...earbox.net>,
        Kernel Team <Kernel-team@...com>
Subject: Re: [PATCH bpf-next] bpftool: work-around rst2man conversion bug

On Wed, Dec 18, 2019 at 3:35 PM Yonghong Song <yhs@...com> wrote:
>
>
>
> On 12/18/19 2:17 PM, Andrii Nakryiko wrote:
> > Work-around what appears to be a bug in rst2man convertion tool, used to
> > create man pages out of reStructureText-formatted documents. If text line
> > starts with dot, rst2man will put it in resulting man file verbatim. This
> > seems to cause man tool to interpret it as a directive/command (e.g., `.bs`), and
> > subsequently not render entire line because it's unrecognized one.
> >
> > Enclose '.xxx' words in extra formatting to work around.
> >
> > Fixes: cb21ac588546 ("bpftool: Add gen subcommand manpage")
> > Reported-by: Alexei Starovoitov <ast@...nel.org>
> > Signed-off-by: Andrii Nakryiko <andriin@...com>
> > ---
> >   tools/bpf/bpftool/Documentation/bpftool-gen.rst | 15 ++++++++-------
> >   1 file changed, 8 insertions(+), 7 deletions(-)
> >
> > diff --git a/tools/bpf/bpftool/Documentation/bpftool-gen.rst b/tools/bpf/bpftool/Documentation/bpftool-gen.rst
> > index b6a114bf908d..86a87da97d0b 100644
> > --- a/tools/bpf/bpftool/Documentation/bpftool-gen.rst
> > +++ b/tools/bpf/bpftool/Documentation/bpftool-gen.rst
> > @@ -112,13 +112,14 @@ DESCRIPTION
> >
> >                 If BPF object has global variables, corresponding structs
> >                 with memory layout corresponding to global data data section
> > -               layout will be created. Currently supported ones are: .data,
> > -               .bss, .rodata, and .extern structs/data sections. These
> > -               data sections/structs can be used to set up initial values of
> > -               variables, if set before **example__load**. Afterwards, if
> > -               target kernel supports memory-mapped BPF arrays, same
> > -               structs can be used to fetch and update (non-read-only)
> > -               data from userspace, with same simplicity as for BPF side.
> > +               layout will be created. Currently supported ones are: *.data*,
> > +               *.bss*, *.rodata*, and *.kconfig* structs/data sections.
> > +               These data sections/structs can be used to set up initial
> > +               values of variables, if set before **example__load**.
> > +               Afterwards, if target kernel supports memory-mapped BPF
> > +               arrays, same structs can be used to fetch and update
> > +               (non-read-only) data from userspace, with same simplicity
> > +               as for BPF side.
>
> Still does not look right.
>
> After build, I did `man ./bpftool-gen.8`, and I got the following,
>
>                   sponding to global data data section layout will be
> created. Currently supported ones
>                   are: .data, data sections/structs can be used to set
> up initial values of  variables,
>
> .bss, .rodata .kconfig etc. are missing. I am using:
>

looks like stale man page, can you please try re-building? Double
checked on my side, it looks good here.

> -bash-4.4$ man --version
> man 2.6.3
>
> >
> >       **bpftool gen help**
> >                 Print short help message.
> >