public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jesper Dangaard Brouer <brouer@redhat.com>
To: Daniel Borkmann <borkmann@iogearbox.net>,
	Alexei Starovoitov <alexei.starovoitov@gmail.com>,
	Jesper Dangaard Brouer <brouer@redhat.com>
Cc: netdev@vger.kernel.org,
	Quentin Monnet <quentin.monnet@netronome.com>,
	linux-man@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [bpf-next PATCH 0/5] bpf, doc: convert Documentation/bpf to RST-formatting
Date: Mon, 14 May 2018 15:42:06 +0200	[thread overview]
Message-ID: <152630528901.29210.9018565600000101307.stgit@firesoul> (raw)

The kernel is moving files under Documentation to use the RST
(reStructuredText) format and Sphinx [1].  This patchset converts the
files under Documentation/bpf/ into RST format.  The Sphinx
integration is left as followup work.

[1] https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html

This patchset have been uploaded as branch bpf_doc10 on github[2], so
reviewers can see how GitHub renders this.

[2] https://github.com/netoptimizer/linux/tree/bpf_doc10/Documentation/bpf

---

Jesper Dangaard Brouer (5):
      bpf, doc: add basic README.rst file
      bpf, doc: rename txt files to rst files
      bpf, doc: convert bpf_design_QA.rst to use RST formatting
      bpf, doc: convert bpf_devel_QA.rst to use RST formatting
      bpf, doc: howto use/run the BPF selftests


 Documentation/bpf/README.rst        |   36 ++
 Documentation/bpf/bpf_design_QA.rst |  221 ++++++++++++
 Documentation/bpf/bpf_design_QA.txt |  156 ---------
 Documentation/bpf/bpf_devel_QA.rst  |  640 +++++++++++++++++++++++++++++++++++
 Documentation/bpf/bpf_devel_QA.txt  |  570 -------------------------------
 5 files changed, 897 insertions(+), 726 deletions(-)
 create mode 100644 Documentation/bpf/README.rst
 create mode 100644 Documentation/bpf/bpf_design_QA.rst
 delete mode 100644 Documentation/bpf/bpf_design_QA.txt
 create mode 100644 Documentation/bpf/bpf_devel_QA.rst
 delete mode 100644 Documentation/bpf/bpf_devel_QA.txt

--
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

             reply	other threads:[~2018-05-14 13:42 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-14 13:42 Jesper Dangaard Brouer [this message]
2018-05-14 13:42 ` [bpf-next PATCH 1/5] bpf, doc: add basic README.rst file Jesper Dangaard Brouer
2018-05-14 13:42 ` [bpf-next PATCH 2/5] bpf, doc: rename txt files to rst files Jesper Dangaard Brouer
2018-05-14 13:42 ` [bpf-next PATCH 3/5] bpf, doc: convert bpf_design_QA.rst to use RST formatting Jesper Dangaard Brouer
2018-05-14 13:42 ` [bpf-next PATCH 4/5] bpf, doc: convert bpf_devel_QA.rst " Jesper Dangaard Brouer
2018-05-14 13:42 ` [bpf-next PATCH 5/5] bpf, doc: howto use/run the BPF selftests Jesper Dangaard Brouer
2018-05-14 15:15   ` Silvan Jegen
2018-05-14 16:05     ` Jesper Dangaard Brouer
2018-05-14 18:46       ` Silvan Jegen
2018-05-15  5:57 ` [bpf-next PATCH 0/5] bpf, doc: convert Documentation/bpf to RST-formatting Y Song
2018-05-15  6:05   ` Alexei Starovoitov

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=152630528901.29210.9018565600000101307.stgit@firesoul \
    --to=brouer@redhat.com \
    --cc=alexei.starovoitov@gmail.com \
    --cc=borkmann@iogearbox.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=quentin.monnet@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox