The Kernel documentation guide is currently a single file at the top of
Documentation/ dir. Sphinx works best if the documentation is
inside a subdirectory, as otherwise there's no way to have a PDF book
with its contents, without including everything else.
The first patch on this series address this, by splitting the
kernel-documentation.rst file into the Documentation/doc-guide dir.
The next two patches add the missing documentation for the
parse-headers.pl script, responsible to generate cross-references
between uAPI header files and the Kernel documentation.
Mauro Carvalho Chehab (3):
docs-rst: doc-guide: split the kernel-documentation.rst contents
parse-headers.pl: add documentation for this script
parse-headers.rst: add an introduction to the man page
Documentation/00-INDEX | 2 +-
Documentation/conf.py | 2 +
Documentation/doc-guide/conf.py | 10 +
Documentation/doc-guide/docbook.rst | 90 ++++++
Documentation/doc-guide/index.rst | 20 ++
.../kernel-doc.rst} | 316 ---------------------
Documentation/doc-guide/parse-headers.rst | 208 ++++++++++++++
Documentation/doc-guide/sphinx.rst | 219 ++++++++++++++
Documentation/index.rst | 2 +-
Documentation/kernel-doc-nano-HOWTO.txt | 2 +-
Documentation/process/4.Coding.rst | 4 +-
Documentation/process/coding-style.rst | 4 +-
Documentation/sphinx/parse-headers.pl | 193 ++++++++++++-
Documentation/translations/zh_CN/CodingStyle | 2 +-
14 files changed, 737 insertions(+), 337 deletions(-)
create mode 100644 Documentation/doc-guide/conf.py
create mode 100644 Documentation/doc-guide/docbook.rst
create mode 100644 Documentation/doc-guide/index.rst
rename Documentation/{kernel-documentation.rst => doc-guide/kernel-doc.rst} (53%)
create mode 100644 Documentation/doc-guide/parse-headers.rst
create mode 100644 Documentation/doc-guide/sphinx.rst
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
