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.kis...@siemens.com>
Cc: Vegard Nossum <vegar...@ifi.uio.no>
Cc: Pekka Enberg <penb...@kernel.org>
Cc: Catalin Marinas <catalin.mari...@arm.com>
Cc: Andrey Ryabinin <aryabi...@virtuozzo.com>
Cc: Alexander Potapenko <gli...@google.com>
Cc: Dmitry Vyukov <dvyu...@google.com>
Cc: Michal Marek <mma...@suse.com>
Cc: Gilles Muller <gilles.mul...@lip6.fr>
Cc: Nicolas Palix <nicolas.pa...@imag.fr>
Cc: Julia Lawall <julia.law...@lip6.fr>
Cc: Jani Nikula <jani.nik...@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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
