Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1458319

[PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents

Show all headers | View 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

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents Jonathan Corbet <corbet@lwn.net> - 2016-08-09 01:40 +0200
  [PATCH 05/10] docs: sphinixfy gcov.txt and move to dev-tools Jonathan Corbet <corbet@lwn.net> - 2016-08-09 01:40 +0200
  [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Jonathan Corbet <corbet@lwn.net> - 2016-08-09 01:40 +0200
    Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Christoph Hellwig <hch@infradead.org> - 2016-08-09 10:10 +0200
      Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-08-09 10:30 +0200
        Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Christoph Hellwig <hch@infradead.org> - 2016-08-09 10:40 +0200
          Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-08-09 12:10 +0200
          Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Jonathan Corbet <corbet@lwn.net> - 2016-08-10 01:00 +0200
      Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Christoph Hellwig <hch@infradead.org> - 2016-08-09 10:30 +0200
      Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools Jani Nikula <jani.nikula@intel.com> - 2016-08-09 10:30 +0200
  Re: [PATCH 09/10] docs: sphinxify kmemcheck.txt and move to dev-tools Vegard Nossum <vegard.nossum@gmail.com> - 2016-08-09 09:10 +0200
  Re: [PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents Jani Nikula <jani.nikula@intel.com> - 2016-08-09 11:00 +0200

csiph-web