From: Markus Heiser <markus.heiser@darmarit.de>
To: Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Jani Nikula <jani.nikula@intel.com>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Matthew Wilcox <mawilcox@microsoft.com>
Cc: Markus Heiser <markus.heiser@darmarit.de>,
"linux-doc @ vger . kernel . org List"
<linux-doc@vger.kernel.org>,
"linux-kernel @ vger . kernel . org List"
<linux-kernel@vger.kernel.org>
Subject: [RFC PATCH v1 0/6] pure python kernel-doc parser and more
Date: Tue, 24 Jan 2017 20:52:38 +0100 [thread overview]
Message-ID: <1485287564-24205-1-git-send-email-markus.heiser@darmarit.de> (raw)
Hi Jon,
here is my RFC, replacing the kernel-doc parser perl script with a python
implementation. The parser is implemented as module and is used by several
kernel-doc applications:
* kerneldoc : the parser
* kerneldoc-lint : liniting
* kerneldoc-src2rst : autodoc source tree
* manKernelDoc.py : a builder generating man-pages
All this is mainly merged 1:1 from my POC at:
https://github.com/return42/linuxdoc commit 3991d3c
Since it is merged 1:1, you will notice it's CodingStyle is (ATM) not kernel
compliant and it lacks a user doc ('Documentation/doc-guide'). Take this as a
starting point to play around and gain some experience with the parser and its
applications. CodingStyle and user documentation will be patched when the
community agreed about functionalities.
Thanks
-- Markus --
[1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg09002.html
Markus Heiser (6):
kernel-doc: pure python kernel-doc parser (preparation)
kernel-doc: replace kernel-doc perl parser with a pure python one (WIP)
kernel-doc: add kerneldoc-lint command
kernel-doc: insert TODOs on kernel-doc errors
kernel-doc: add kerneldoc-src2rst command
kernel-doc: add man page builder (target mandocs)
Documentation/Makefile.sphinx | 8 +-
Documentation/admin-guide/conf.py | 2 +
Documentation/admin-guide/index.rst | 2 +
Documentation/conf.py | 8 +-
Documentation/core-api/conf.py | 2 +
Documentation/core-api/index.rst | 2 +
Documentation/dev-tools/conf.py | 2 +
Documentation/dev-tools/index.rst | 2 +
Documentation/doc-guide/conf.py | 2 +
Documentation/doc-guide/index.rst | 2 +
Documentation/driver-api/conf.py | 2 +
Documentation/driver-api/index.rst | 2 +
Documentation/gpu/conf.py | 2 +
Documentation/gpu/index.rst | 2 +
Documentation/media/Makefile | 1 +
Documentation/media/conf.py | 2 +
Documentation/media/index.rst | 2 +
Documentation/process/conf.py | 2 +
Documentation/process/index.rst | 2 +
Documentation/security/conf.py | 2 +
Documentation/security/index.rst | 9 +
Documentation/sphinx/fspath.py | 435 +++++
Documentation/sphinx/kernel_doc.py | 2908 ++++++++++++++++++++++++++++++++++
Documentation/sphinx/kerneldoc.py | 149 --
Documentation/sphinx/lint.py | 121 ++
Documentation/sphinx/manKernelDoc.py | 408 +++++
Documentation/sphinx/rstKernelDoc.py | 560 +++++++
Documentation/sphinx/src2rst.py | 229 +++
scripts/kerneldoc | 11 +
scripts/kerneldoc-lint | 11 +
scripts/kerneldoc-src2rst | 11 +
31 files changed, 4748 insertions(+), 155 deletions(-)
create mode 100644 Documentation/sphinx/fspath.py
create mode 100755 Documentation/sphinx/kernel_doc.py
delete mode 100644 Documentation/sphinx/kerneldoc.py
create mode 100755 Documentation/sphinx/lint.py
create mode 100755 Documentation/sphinx/manKernelDoc.py
create mode 100755 Documentation/sphinx/rstKernelDoc.py
create mode 100755 Documentation/sphinx/src2rst.py
create mode 100755 scripts/kerneldoc
create mode 100755 scripts/kerneldoc-lint
create mode 100755 scripts/kerneldoc-src2rst
--
2.7.4
next reply other threads:[~2017-01-24 19:53 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-24 19:52 Markus Heiser [this message]
2017-01-24 19:52 ` [RFC PATCH v1 1/6] kernel-doc: pure python kernel-doc parser (preparation) Markus Heiser
2017-01-24 19:52 ` [RFC PATCH v1 2/6] kernel-doc: replace kernel-doc perl parser with a pure python one (WIP) Markus Heiser
2017-01-25 0:13 ` Jonathan Corbet
2017-01-25 6:37 ` Daniel Vetter
2017-01-25 7:37 ` Markus Heiser
2017-01-25 10:24 ` Jani Nikula
2017-01-25 10:35 ` Daniel Vetter
2017-01-25 19:07 ` Markus Heiser
2017-01-25 20:59 ` Jani Nikula
2017-01-26 9:54 ` Markus Heiser
2017-01-26 10:16 ` Jani Nikula
2017-01-26 18:50 ` Jonathan Corbet
2017-01-26 19:26 ` Jani Nikula
2017-01-27 9:46 ` Markus Heiser
2017-01-24 19:52 ` [RFC PATCH v1 3/6] kernel-doc: add kerneldoc-lint command Markus Heiser
2017-01-25 6:38 ` Daniel Vetter
2017-01-25 8:21 ` Jani Nikula
2017-01-25 9:34 ` Markus Heiser
2017-01-25 10:08 ` Jani Nikula
2017-01-24 19:52 ` [RFC PATCH v1 4/6] kernel-doc: insert TODOs on kernel-doc errors Markus Heiser
2017-01-24 19:52 ` [RFC PATCH v1 5/6] kernel-doc: add kerneldoc-src2rst command Markus Heiser
2017-01-24 19:52 ` [RFC PATCH v1 6/6] kernel-doc: add man page builder (target mandocs) Markus Heiser
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=1485287564-24205-1-git-send-email-markus.heiser@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mawilcox@microsoft.com \
--cc=mchehab@infradead.org \
/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).