From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752185AbcHHXfW (ORCPT ); Mon, 8 Aug 2016 19:35:22 -0400 Received: from tex.lwn.net ([70.33.254.29]:44586 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750979AbcHHXfU (ORCPT ); Mon, 8 Aug 2016 19:35:20 -0400 From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Jani Nikula , Jonathan Corbet , Jan Kiszka , Vegard Nossum , Pekka Enberg , Catalin Marinas , Andrey Ryabinin , Alexander Potapenko , Dmitry Vyukov , Michal Marek , Gilles Muller , Nicolas Palix , Julia Lawall Subject: [PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents Date: Mon, 8 Aug 2016 17:34:52 -0600 Message-Id: <20160808233502.16950-1-corbet@lwn.net> X-Mailer: git-send-email 2.9.2 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 Cc: Vegard Nossum Cc: Pekka Enberg Cc: Catalin Marinas Cc: Andrey Ryabinin Cc: Alexander Potapenko Cc: Dmitry Vyukov Cc: Michal Marek Cc: Gilles Muller Cc: Nicolas Palix Cc: Julia Lawall Cc: Jani Nikula 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