netdev - Re: [PATCH bpf-next v3 3/3] tools: bpftool: automate generation for "SEE ALSO" sections in man pages

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] [day] [month] [year] [list]

Message-ID: <CACdoK4+1mbhkJ=uGrfhUF3hRnX3-+Ai2FcMfBkgqs6YB++=mkw@mail.gmail.com>
Date:   Thu, 10 Sep 2020 21:24:55 +0100
From:   Quentin Monnet <quentin@...valent.com>
To:     Alexei Starovoitov <alexei.starovoitov@...il.com>
Cc:     Alexei Starovoitov <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        bpf <bpf@...r.kernel.org>,
        Network Development <netdev@...r.kernel.org>,
        Andrii Nakryiko <andrii.nakryiko@...il.com>,
        Andrii Nakryiko <andriin@...com>
Subject: Re: [PATCH bpf-next v3 3/3] tools: bpftool: automate generation for
 "SEE ALSO" sections in man pages

On Thu, 10 Sep 2020 at 19:18, Alexei Starovoitov
<alexei.starovoitov@...il.com> wrote:
>
> On Wed, Sep 9, 2020 at 9:25 AM Quentin Monnet <quentin@...valent.com> wrote:
> >
> > The "SEE ALSO" sections of bpftool's manual pages refer to bpf(2),
> > bpf-helpers(7), then all existing bpftool man pages (save the current
> > one).
> >
> > This leads to nearly-identical lists being duplicated in all manual
> > pages. Ideally, when a new page is created, all lists should be updated
> > accordingly, but this has led to omissions and inconsistencies multiple
> > times in the past.
> >
> > Let's take it out of the RST files and generate the "SEE ALSO" sections
> > automatically in the Makefile when generating the man pages. The lists
> > are not really useful in the RST anyway because all other pages are
> > available in the same directory.
> >
> > v2:
> > - Use "echo -n" instead of "printf" in Makefile, to avoid any risk of
> >   passing a format string directly to the command.
> >
> > Signed-off-by: Quentin Monnet <quentin@...valent.com>
> > Acked-by: Andrii Nakryiko <andriin@...com>
>
> This patch failed to git am, but I've applied the first two patches.
> Thanks

Right, there is a conflict with the other patchset passing
$(RST2MAN_OPTS) to rst2man when building the doc. I'll rebase and
repost this one. Thank you Alexei.

Quentin