From: Jesper Dangaard Brouer <brouer@redhat.com>
To: Jakub Kicinski <jakub.kicinski@netronome.com>
Cc: brouer@redhat.com, netdev@vger.kernel.org,
alexei.starovoitov@gmail.com, daniel@iogearbox.net,
dsahern@gmail.com, oss-drivers@netronome.com,
David Beckett <david.beckett@netronome.com>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>
Subject: Re: [PATCH net-next v3 3/3] tools: bpftool: add documentation
Date: Wed, 4 Oct 2017 20:36:42 +0200 [thread overview]
Message-ID: <20171004203642.699f5f1a@redhat.com> (raw)
In-Reply-To: <20171004154032.11413-4-jakub.kicinski@netronome.com>
On Wed, 4 Oct 2017 08:40:32 -0700
Jakub Kicinski <jakub.kicinski@netronome.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@netronome.com>
> Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
> Acked-by: Alexei Starovoitov <ast@kernel.org>
> Acked-by: Daniel Borkmann <daniel@iogearbox.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
--
Best regards,
Jesper Dangaard Brouer
MSc.CS, Principal Kernel Engineer at Red Hat
LinkedIn: http://www.linkedin.com/in/brouer
next prev parent reply other threads:[~2017-10-04 18:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-04 15:40 [PATCH net-next v3 0/3] tools: add bpftool Jakub Kicinski
2017-10-04 15:40 ` [PATCH net-next v3 1/3] tools: rename tools/net directory to tools/bpf Jakub Kicinski
2017-10-04 15:40 ` [PATCH net-next v3 2/3] tools: bpf: add bpftool Jakub Kicinski
2017-10-04 15:40 ` [PATCH net-next v3 3/3] tools: bpftool: add documentation Jakub Kicinski
2017-10-04 18:36 ` Jesper Dangaard Brouer [this message]
2017-10-04 20:02 ` Jakub Kicinski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171004203642.699f5f1a@redhat.com \
--to=brouer@redhat.com \
--cc=alexei.starovoitov@gmail.com \
--cc=daniel@iogearbox.net \
--cc=david.beckett@netronome.com \
--cc=dsahern@gmail.com \
--cc=jakub.kicinski@netronome.com \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=oss-drivers@netronome.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.