From: "Tobin C. Harding" <me@tobin.cc>
To: "David S. Miller" <davem@davemloft.net>
Cc: "Tobin C. Harding" <me@tobin.cc>,
Jonathan Corbet <corbet@lwn.net>,
Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>,
Alexei Starovoitov <ast@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
linux-doc@vger.kernel.org, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/4] docs: bpf: Fix RST conversion
Date: Thu, 26 Jul 2018 15:03:01 +1000 [thread overview]
Message-ID: <20180726050305.2147-1-me@tobin.cc> (raw)
Hi Dave,
I'm sending v2 of this to you instead of to Jon. Rationale: BPF is to
do with networking anyways and there is a broken link that requires
conversion of Documentation/networking/filter.txt to fix and that will
go to you. FTR there are no merge conflicts between this set and the
other set I just sent (either can be applied on top of the other)
[PATCH v2 net-next 0/3] docs: net: Convert netdev-FAQ to RST
Recently BPF docs were converted to RST format. A couple of things were
missed.
- Use 'index.rst' instead of 'README.rst'. Although README.rst will
work just fine it is more typical to keep the subdirectory indices
in a file called 'index.rst'.
- Integrate files Documentation/bpf/*.rst into build system using
toctree in Documentation/bpf/index.rst
- Include bpf/index in top level toctree so bpf is indexed in the main
kernel docs.
- Make anal change to heading format (inline with rest of Documentation/).
thanks,
Tobin.
v2:
- Fix typo in commit log s/us/use (thanks Sergei)
Tobin C. Harding (4):
docs: bpf: Rename README.rst to index.rst
docs: bpf: Add toctree to index
docs: Add bpf/index to top level index
docs: bpf: Capitalise document heading
Documentation/bpf/{README.rst => index.rst} | 10 +++++-----
Documentation/index.rst | 1 +
2 files changed, 6 insertions(+), 5 deletions(-)
rename Documentation/bpf/{README.rst => index.rst} (82%)
--
2.17.1
next reply other threads:[~2018-07-26 5:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-26 5:03 Tobin C. Harding [this message]
2018-07-26 5:03 ` [PATCH v2 1/4] docs: bpf: Rename README.rst to index.rst Tobin C. Harding
2018-07-26 5:03 ` [PATCH v2 2/4] docs: bpf: Add toctree to index Tobin C. Harding
2018-07-26 5:03 ` [PATCH v2 3/4] docs: Add bpf/index to top level index Tobin C. Harding
2018-07-26 5:03 ` [PATCH v2 4/4] docs: bpf: Capitalise document heading Tobin C. Harding
2018-07-27 5:25 ` [PATCH v2 0/4] docs: bpf: Fix RST conversion Daniel Borkmann
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=20180726050305.2147-1-me@tobin.cc \
--to=me@tobin.cc \
--cc=ast@kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=davem@davemloft.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=sergei.shtylyov@cogentembedded.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).