From: Jani Nikula <jani.nikula@intel.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Jani Nikula <jani.nikula@intel.com>,
Markus Heiser <markus.heiser@darmarit.de>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Grant Likely <grant.likely@secretlab.ca>,
Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
Keith Packard <keithp@keithp.com>,
LKML <linux-kernel@vger.kernel.org>,
linux-doc@vger.kernel.org, Hans Verkuil <hverkuil@xs4all.nl>
Subject: [PATCH v2 38/38] doc/sphinx: Track line-number of starting blocks
Date: Sat, 4 Jun 2016 14:37:39 +0300 [thread overview]
Message-ID: <d90368f2fa7ded7c56d214aef087e88bba5199e7.1465031816.git.jani.nikula@intel.com> (raw)
In-Reply-To: <cover.1465031816.git.jani.nikula@intel.com>
In-Reply-To: <cover.1465031816.git.jani.nikula@intel.com>
From: Daniel Vetter <daniel.vetter@ffwll.ch>
Design is pretty simple: kernel-doc inserts breadcrumbs with line
numbers, and sphinx picks them up. At first I went with a sphinx
comment, but inserting those at random places seriously upsets the
parser, and must be filtered. Hence why this version now uses "#define
LINEO " since one of these ever escape into output it's pretty clear
there is a bug.
It seems to work well, and at least the 2-3 errors where sphinx
complained about something that was not correct in kernel-doc text the
line numbers matched up perfectly.
v2: Instead of noodling around in the parser state machine, create
a ViewList and parse it ourselves. This seems to be the recommended
way, per Jani's suggestion.
v3:
- Split out ViewList pach. Splitting the kernel-doc changes from the
sphinx ones isn't possible, since emitting the LINENO lines wreaks
havoc with the rst formatting. We must filter them.
- Improve the regex per Jani's suggestions, and compile it just once
for speed.
- Now that LINENO lines are eaten, also add them to function parameter
descriptions. Much less content and offset than for in-line struct
member descriptions, but still nice to know which exact continuation
line upsets sphinx.
- Simplify/clarify the line +/-1 business a bit.
v4: Split out the scripts/kernel-doc changes and make line-numbers
opt-in, as suggested by Jani.
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
Documentation/sphinx/kernel-doc.py | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/Documentation/sphinx/kernel-doc.py b/Documentation/sphinx/kernel-doc.py
index bd422870101e..4adfb0e91ecc 100644
--- a/Documentation/sphinx/kernel-doc.py
+++ b/Documentation/sphinx/kernel-doc.py
@@ -30,6 +30,7 @@
import os
import subprocess
import sys
+import re
from docutils import nodes, statemachine
from docutils.statemachine import ViewList
@@ -50,7 +51,7 @@ class KernelDocDirective(Directive):
def run(self):
env = self.state.document.settings.env
- cmd = [env.config.kerneldoc_bin, '-rst']
+ cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
@@ -93,7 +94,19 @@ class KernelDocDirective(Directive):
sys.stderr.write(err)
lines = statemachine.string2lines(out, tab_width, convert_whitespace=True)
- result = ViewList(lines, source)
+ result = ViewList()
+
+ lineoffset = 0;
+ line_regex = re.compile("^#define LINENO ([0-9]+)$")
+ for line in lines:
+ match = line_regex.search(line)
+ if match:
+ # sphinx counts lines from 0
+ lineoffset = int(match.group(1)) - 1
+ # we must eat our comments since the upset the markup
+ else:
+ result.append(line, source, lineoffset)
+ lineoffset += 1
node = nodes.section()
node.document = self.state.document
--
2.1.4
next prev parent reply other threads:[~2016-06-04 11:41 UTC|newest]
Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-04 11:37 [PATCH v2 00/38] Documentation/sphinx Jani Nikula
2016-06-04 11:37 ` [PATCH v2 01/38] kernel-doc/rst: fix use of uninitialized value Jani Nikula
2016-06-04 11:37 ` [PATCH v2 02/38] kernel-doc: support printing exported and non-exported symbols Jani Nikula
2016-06-04 11:37 ` [PATCH v2 03/38] Documentation/sphinx: add basic working Sphinx configuration and build Jani Nikula
2016-06-04 11:37 ` [PATCH v2 04/38] Documentation: add .gitignore Jani Nikula
2016-06-04 11:37 ` [PATCH v2 05/38] Documentation/sphinx: add Sphinx kernel-doc directive extension Jani Nikula
2016-06-04 11:37 ` [PATCH v2 06/38] Documentation/sphinx: configure the kernel-doc extension Jani Nikula
2016-06-04 11:37 ` [PATCH v2 07/38] Documentation/sphinx: set version and release properly Jani Nikula
2016-06-04 11:37 ` [PATCH v2 08/38] sphinx: cheesy script to convert .tmpl files Jani Nikula
2016-06-04 11:37 ` [PATCH v2 09/38] sphinx: update docbook->rst conversion script match C domain spec Jani Nikula
2016-06-04 11:37 ` [PATCH v2 10/38] Documentation/sphinx: nicer referencing of struct in docbook->rst conversion Jani Nikula
2016-06-04 11:37 ` [PATCH v2 11/38] kernel-doc: add names for states and substates Jani Nikula
2016-06-04 11:37 ` [PATCH v2 12/38] kernel-doc: add names for output selection Jani Nikula
2016-06-04 11:37 ` [PATCH v2 13/38] kernel-doc/rst: do not output DOC: section titles for requested ones Jani Nikula
2016-06-04 11:37 ` [PATCH v2 14/38] kernel-doc/rst: reference functions according to C domain spec Jani Nikula
2016-06-04 11:37 ` [PATCH v2 15/38] kernel-doc/rst: &foo references are more universal than structs Jani Nikula
2016-06-04 11:37 ` [PATCH v2 16/38] kernel-doc/rst: add support for &union foo and &typedef foo references Jani Nikula
2016-06-04 11:37 ` [PATCH v2 17/38] kernel-doc/rst: add support for struct/union/enum member references Jani Nikula
2016-06-04 11:37 ` [PATCH v2 18/38] kernel-doc/rst: drop redundant unescape in highlighting Jani Nikula
2016-06-04 11:37 ` [PATCH v2 19/38] kernel-doc/rst: highlight function/struct/enum purpose lines too Jani Nikula
2016-06-04 11:37 ` [PATCH v2 20/38] kernel-doc: do not regard $, %, or & prefixes as special in section names Jani Nikula
2016-06-04 11:37 ` [PATCH v2 21/38] kernel-doc: fix wrong code indentation Jani Nikula
2016-06-04 11:37 ` [PATCH v2 22/38] kernel-doc/rst: blank lines in output are not needed Jani Nikula
2016-06-04 11:37 ` [PATCH v2 23/38] kernel-doc: strip leading blank lines from inline doc comments Jani Nikula
2016-06-04 11:37 ` [PATCH v2 24/38] kernel-doc/rst: change the output layout Jani Nikula
2016-06-04 11:37 ` [PATCH v2 25/38] kernel-doc: improve handling of whitespace on the first line param description Jani Nikula
2016-06-04 11:37 ` [PATCH v2 26/38] kernel-doc: strip leading whitespace from continued param descs Jani Nikula
2016-06-04 11:37 ` [PATCH v2 27/38] kernel-doc/rst: use *undescribed* instead of _undescribed_ Jani Nikula
2016-06-04 11:37 ` [PATCH v2 28/38] kernel-doc/rst: remove fixme comment Jani Nikula
2016-06-04 11:37 ` [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few Jani Nikula
2016-06-09 15:03 ` Jonathan Corbet
2016-06-09 16:39 ` Jani Nikula
2016-06-04 11:37 ` [PATCH v2 30/38] kernel-doc: concatenate contents of colliding sections Jani Nikula
2016-06-04 11:37 ` [PATCH v2 31/38] kernel-doc: reset contents and section harder Jani Nikula
2016-06-04 11:37 ` [PATCH v2 32/38] Documentation/sphinx: fix kernel-doc extension on python3 Jani Nikula
2016-06-04 11:37 ` [PATCH v2 33/38] doc/sphinx: Pass right filename as source Jani Nikula
2016-06-04 11:37 ` [PATCH v2 34/38] scripts/kernel-doc: Remove duplicated DOC: start handling Jani Nikula
2016-06-04 11:37 ` [PATCH v2 35/38] doc/sphinx: Stop touching state_machine internals Jani Nikula
2016-06-04 11:37 ` [PATCH v2 36/38] scripts/kernel-doc: Also give functions symbolic names Jani Nikula
2016-06-04 11:37 ` [PATCH v2 37/38] scripts/kernel-doc: Add option to inject line numbers Jani Nikula
2016-06-04 11:37 ` Jani Nikula [this message]
2016-06-04 12:15 ` [PATCH v2 00/38] Documentation/sphinx Daniel Vetter
2016-06-09 19:55 ` Jonathan Corbet
2016-06-10 18:17 ` Daniel Vetter
2016-06-10 20:41 ` Dave Airlie
2016-06-14 8:15 ` Daniel Vetter
2016-06-14 19:23 ` Jonathan Corbet
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=d90368f2fa7ded7c56d214aef087e88bba5199e7.1465031816.git.jani.nikula@intel.com \
--to=jani.nikula@intel.com \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=grant.likely@secretlab.ca \
--cc=hverkuil@xs4all.nl \
--cc=keithp@keithp.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@osg.samsung.com \
/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).