| 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
| ||
|
Date: Wed, 4 Oct 2017 13:02:38 -0700
From: Jakub Kicinski <jakub.kicinski@...ronome.com>
To: Jesper Dangaard Brouer <brouer@...hat.com>
Cc: netdev@...r.kernel.org, alexei.starovoitov@...il.com,
daniel@...earbox.net, dsahern@...il.com, oss-drivers@...ronome.com,
David Beckett <david.beckett@...ronome.com>,
"linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>
Subject: Re: [PATCH net-next v3 3/3] tools: bpftool: add documentation
On Wed, 4 Oct 2017 20:36:42 +0200, Jesper Dangaard Brouer wrote:
> On Wed, 4 Oct 2017 08:40:32 -0700
> Jakub Kicinski <jakub.kicinski@...ronome.com> wrote:
>
> > Add documentation for bpftool. Separate files for each subcommand.
> > Use rst format. Documentation is compiled into man pages using
> > rst2man.
> >
> > Signed-off-by: David Beckett <david.beckett@...ronome.com>
> > Signed-off-by: Jakub Kicinski <jakub.kicinski@...ronome.com>
> > Acked-by: Alexei Starovoitov <ast@...nel.org>
> > Acked-by: Daniel Borkmann <daniel@...earbox.net>
> > ---
> > tools/bpf/bpftool/Documentation/Makefile | 34 +++++++
> > tools/bpf/bpftool/Documentation/bpftool-map.txt | 110 +++++++++++++++++++++++
> > tools/bpf/bpftool/Documentation/bpftool-prog.txt | 79 ++++++++++++++++
> > tools/bpf/bpftool/Documentation/bpftool.txt | 34 +++++++
>
> RST-format files are usually called .rst and not .txt
>
> This is useful when people happen to browse the code via github, then they get formatted nicely e.g.:
> https://github.com/torvalds/linux/blob/master/samples/bpf/README.rst
I was following perf's example. Are perf's docs not RST?
Powered by blists - more mailing lists