All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: gregkh@linuxfoundation.org
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH v4 07/15] docs: kernel_abi.py: use --enable-lineno for get_abi.pl
Date: Wed, 17 Jul 2019 09:28:11 -0300	[thread overview]
Message-ID: <cab91970bbef3616fc140bdaaf0e199abe1f30b3.1563365880.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1563365880.git.mchehab+samsung@kernel.org>

Just like kernel-doc extension, we need to be able to identify
what part of an imported document has issues, as reporting them
as:

	get_abi.pl rest --dir $srctree/Documentation/ABI/obsolete --rst-source:1689: ERROR: Unexpected indentation.

Makes a lot harder for someone to fix.

It should be noticed that it the line which will be reported is
the line where the "What:" definition is, and not the line
with actually has an error.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/sphinx/kernel_abi.py | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py
index 0b2a89d4c12d..615b3773bb62 100644
--- a/Documentation/sphinx/kernel_abi.py
+++ b/Documentation/sphinx/kernel_abi.py
@@ -35,6 +35,7 @@ import codecs
 import os
 import subprocess
 import sys
+import re
 
 from os import path
 
@@ -92,7 +93,7 @@ class KernelCmd(Directive):
 
         env = doc.settings.env
         cwd = path.dirname(doc.current_source)
-        cmd = "get_abi.pl rest --dir "
+        cmd = "get_abi.pl rest --enable-lineno --dir "
         cmd += self.arguments[0]
 
         srctree = path.abspath(os.environ["srctree"])
@@ -136,7 +137,7 @@ class KernelCmd(Directive):
                               % (self.name, ErrorString(exc)))
         return out
 
-    def nestedParse(self, lines, fname):
+    def nestedParse(self, lines, f):
         content = ViewList()
         node    = nodes.section()
 
@@ -146,8 +147,17 @@ class KernelCmd(Directive):
                 code_block += "\n    " + l
             lines = code_block + "\n\n"
 
-        for c, l in enumerate(lines.split("\n")):
-            content.append(l, fname, c)
+        line_regex = re.compile("^#define LINENO (\S+)\#([0-9]+)$")
+        ln = 0
+
+        for line in lines.split("\n"):
+            match = line_regex.search(line)
+            if match:
+                f = match.group(1)
+                # sphinx counts lines from 0
+                ln = int(match.group(2)) - 1
+            else:
+                content.append(line, f, ln)
 
         buf  = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
 
-- 
2.21.0


  parent reply	other threads:[~2019-07-17 12:28 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1563365880.git.mchehab+samsung@kernel.org>
2019-07-17 12:28 ` [PATCH v4 03/15] docs: kernellog.py: add support for info() Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 04/15] docs: kernel_abi.py: add a script to parse ABI documentation Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 05/15] docs: kernel_abi.py: fix UTF-8 support Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 06/15] docs: kernel_abi.py: make it compatible with Sphinx 1.7+ Mauro Carvalho Chehab
2019-07-17 12:28 ` Mauro Carvalho Chehab [this message]
2019-07-17 12:28 ` [PATCH v4 08/15] docs: kernel_abi.py: allow passing ABI files in a transparent way Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 09/15] docs: kernel_abi.py: Sphinx has a lazy parser... workaround it Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 10/15] docs: add ABI documentation to the admin-guide book Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 12/15] docs: ABI: stable: make files ReST compatible Mauro Carvalho Chehab
2019-07-17 12:28   ` [Xen-devel] " Mauro Carvalho Chehab
2019-07-17 12:28   ` Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 13/15] docs: ABI: testing: make the files compatible with ReST output Mauro Carvalho Chehab
2019-07-17 12:28   ` [Xen-devel] " Mauro Carvalho Chehab
2019-07-17 12:28   ` Mauro Carvalho Chehab
2019-07-17 16:13   ` Jonathan Cameron
2019-07-17 16:13     ` [Xen-devel] " Jonathan Cameron
2019-07-17 16:13     ` Jonathan Cameron
2019-07-17 16:13     ` Jonathan Cameron
2019-07-17 12:28 ` [PATCH v4 14/15] docs: ABI: obsolete, removed: don't escape ReST-incompatible chars Mauro Carvalho Chehab
2019-07-17 12:28 ` [PATCH v4 15/15] docs: Kconfig/Makefile: add a check for broken ABI files Mauro Carvalho Chehab

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=cab91970bbef3616fc140bdaaf0e199abe1f30b3.1563365880.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.