From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Jani Nikula <jani.nikula@intel.com>,
Jonathan Corbet <corbet@lwn.net>,
Jan Kiszka <jan.kiszka@siemens.com>,
Vegard Nossum <vegardno@ifi.uio.no>,
Pekka Enberg <penberg@kernel.org>,
Catalin Marinas <catalin.marinas@arm.com>,
Andrey Ryabinin <aryabinin@virtuozzo.com>,
Alexander Potapenko <glider@google.com>,
Dmitry Vyukov <dvyukov@google.com>,
Michal Marek <mmarek@suse.com>,
Gilles Muller <Gilles.Muller@lip6.fr>,
Nicolas Palix <nicolas.palix@imag.fr>,
Julia Lawall <julia.lawall@lip6.fr>
Subject: [PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents
Date: Mon, 8 Aug 2016 17:34:52 -0600 [thread overview]
Message-ID: <20160808233502.16950-1-corbet@lwn.net> (raw)
This series of patches collects a number of documents related to kernel
development tools, converts them to the Sphinx format, and puts them
together into the dev-tools directory. The resulting formatted
documentation can be seen at:
http://static.lwn.net/kerneldoc/dev-tools/tools.html
I've not made any textual changes, so this is far from having created a
truly coherent document, but it is a step in the right direction and shows
the sort of change I have in mind for the documentation directory in
general.
FWIW, the sphinx conversion was trivially easy - these documents were
nearly in reStructuredText already!
Cc: Jan Kiszka <jan.kiszka@siemens.com>
Cc: Vegard Nossum <vegardno@ifi.uio.no>
Cc: Pekka Enberg <penberg@kernel.org>
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Andrey Ryabinin <aryabinin@virtuozzo.com>
Cc: Alexander Potapenko <glider@google.com>
Cc: Dmitry Vyukov <dvyukov@google.com>
Cc: Michal Marek <mmarek@suse.com>
Cc: Gilles Muller <Gilles.Muller@lip6.fr>
Cc: Nicolas Palix <nicolas.palix@imag.fr>
Cc: Julia Lawall <julia.lawall@lip6.fr>
Cc: Jani Nikula <jani.nikula@intel.com>
Jonathan Corbet (10):
docs: create a new dev-tools directory
docs: sphinxify coccinelle.txt and add it to dev-tools
docs: sphinxify sparse.txt and move to dev-tools
docs: sphinxify kcov.txt and move to dev-tools
docs: sphinixfy gcov.txt and move to dev-tools
docs: sphinxify kasan.txt and move to dev-tools
docs: sphinxify ubsan.txt and move it to dev-tools
docs: sphinxify kmemleak.txt and move it to dev-tools
docs: sphinxify kmemcheck.txt and move to dev-tools
docs: Sphinxify gdb-kernel-debugging.txt and move to dev-tools
.../{coccinelle.txt => dev-tools/coccinelle.rst} | 359 +++++-----
Documentation/dev-tools/gcov.rst | 256 +++++++
.../gdb-kernel-debugging.rst} | 77 ++-
Documentation/dev-tools/kasan.rst | 173 +++++
Documentation/dev-tools/kcov.rst | 111 +++
Documentation/dev-tools/kmemcheck.rst | 733 ++++++++++++++++++++
.../{kmemleak.txt => dev-tools/kmemleak.rst} | 93 +--
Documentation/{sparse.txt => dev-tools/sparse.rst} | 61 +-
Documentation/dev-tools/tools.rst | 25 +
Documentation/{ubsan.txt => dev-tools/ubsan.rst} | 42 +-
Documentation/gcov.txt | 257 -------
Documentation/index.rst | 1 +
Documentation/kasan.txt | 171 -----
Documentation/kcov.txt | 111 ---
Documentation/kmemcheck.txt | 754 ---------------------
MAINTAINERS | 10 +-
16 files changed, 1647 insertions(+), 1587 deletions(-)
rename Documentation/{coccinelle.txt => dev-tools/coccinelle.rst} (56%)
create mode 100644 Documentation/dev-tools/gcov.rst
rename Documentation/{gdb-kernel-debugging.txt => dev-tools/gdb-kernel-debugging.rst} (73%)
create mode 100644 Documentation/dev-tools/kasan.rst
create mode 100644 Documentation/dev-tools/kcov.rst
create mode 100644 Documentation/dev-tools/kmemcheck.rst
rename Documentation/{kmemleak.txt => dev-tools/kmemleak.rst} (73%)
rename Documentation/{sparse.txt => dev-tools/sparse.rst} (61%)
create mode 100644 Documentation/dev-tools/tools.rst
rename Documentation/{ubsan.txt => dev-tools/ubsan.rst} (78%)
delete mode 100644 Documentation/gcov.txt
delete mode 100644 Documentation/kasan.txt
delete mode 100644 Documentation/kcov.txt
delete mode 100644 Documentation/kmemcheck.txt
--
2.9.2
next reply other threads:[~2016-08-08 23:35 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-08 23:34 Jonathan Corbet [this message]
2016-08-08 23:34 ` [PATCH 01/10] docs: create a new dev-tools directory Jonathan Corbet
2016-08-08 23:34 ` [PATCH 02/10] docs: sphinxify coccinelle.txt and add it to dev-tools Jonathan Corbet
2016-08-09 5:18 ` Julia Lawall
2016-08-09 13:08 ` Nicolas Palix (LIG)
2016-08-08 23:34 ` [PATCH 03/10] docs: sphinxify sparse.txt and move " Jonathan Corbet
2016-08-09 8:07 ` Christoph Hellwig
2016-08-09 8:19 ` Jani Nikula
2016-08-09 8:22 ` Christoph Hellwig
2016-08-09 8:28 ` Daniel Vetter
2016-08-09 8:31 ` Christoph Hellwig
2016-08-09 10:00 ` Daniel Vetter
2016-08-09 22:53 ` Jonathan Corbet
2016-08-18 23:46 ` Jonathan Corbet
2016-08-19 2:27 ` Christoph Hellwig
2016-08-08 23:34 ` [PATCH 04/10] docs: sphinxify kcov.txt " Jonathan Corbet
2016-08-08 23:34 ` [PATCH 05/10] docs: sphinixfy gcov.txt " Jonathan Corbet
2016-08-08 23:34 ` [PATCH 06/10] docs: sphinxify kasan.txt " Jonathan Corbet
2016-08-09 9:09 ` Alexander Potapenko
2016-08-17 15:49 ` Andrey Ryabinin
2016-08-08 23:34 ` [PATCH 07/10] docs: sphinxify ubsan.txt and move it " Jonathan Corbet
2016-08-17 15:50 ` Andrey Ryabinin
2016-08-08 23:35 ` [PATCH 08/10] docs: sphinxify kmemleak.txt " Jonathan Corbet
2016-08-10 14:37 ` Catalin Marinas
2016-08-08 23:35 ` [PATCH 09/10] docs: sphinxify kmemcheck.txt and move " Jonathan Corbet
2016-08-09 7:04 ` Vegard Nossum
2016-08-08 23:35 ` [PATCH 10/10] docs: Sphinxify gdb-kernel-debugging.txt " Jonathan Corbet
2016-08-10 7:03 ` Jan Kiszka
2016-08-09 8:50 ` [PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents Jani Nikula
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=20160808233502.16950-1-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=Gilles.Muller@lip6.fr \
--cc=aryabinin@virtuozzo.com \
--cc=catalin.marinas@arm.com \
--cc=dvyukov@google.com \
--cc=glider@google.com \
--cc=jan.kiszka@siemens.com \
--cc=jani.nikula@intel.com \
--cc=julia.lawall@lip6.fr \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mmarek@suse.com \
--cc=nicolas.palix@imag.fr \
--cc=penberg@kernel.org \
--cc=vegardno@ifi.uio.no \
/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).