From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Andrew Morton <akpm@linux-foundation.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 6/7] scripts: get_abi: ignore code blocks for cross-references
Date: Thu, 25 Mar 2021 11:38:27 +0100 [thread overview]
Message-ID: <a590f994f8a5742db333bde69e88241a080e4fe0.1616668017.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1616668017.git.mchehab+huawei@kernel.org>
The script should not generate cross-references inside
literal blocks.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
scripts/get_abi.pl | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/scripts/get_abi.pl b/scripts/get_abi.pl
index e5d1da492c1e..d7aa82094296 100755
--- a/scripts/get_abi.pl
+++ b/scripts/get_abi.pl
@@ -382,8 +382,27 @@ sub output_rest {
# Enrich text by creating cross-references
my $new_desc = "";
+ my $init_indent = -1;
+ my $literal_indent = -1;
+
open(my $fh, "+<", \$desc);
while (my $d = <$fh>) {
+ my $indent = $d =~ m/^(\s+)/;
+ my $spaces = length($indent);
+ $init_indent = $indent if ($init_indent < 0);
+ if ($literal_indent >= 0) {
+ if ($spaces > $literal_indent) {
+ $new_desc .= $d;
+ next;
+ } else {
+ $literal_indent = -1;
+ }
+ } else {
+ if ($d =~ /()::$/ && !($d =~ /^\s*\.\./)) {
+ $literal_indent = $spaces;
+ }
+ }
+
$d =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g;
my @matches = $d =~ m,Documentation/ABI/([\w\/\-]+),g;
--
2.30.2
next prev parent reply other threads:[~2021-03-25 10:39 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-25 10:38 [PATCH v2 0/7] Fix some issues at get_abi.pl script Mauro Carvalho Chehab
2021-03-25 10:38 ` [PATCH v2 1/7] scripts: get_abi.pl: better handle escape chars on what: Mauro Carvalho Chehab
2021-03-25 10:38 ` [PATCH v2 2/7] get_abi.pl: seek for all occurrences for Documentation/ABI Mauro Carvalho Chehab
2021-03-25 10:38 ` [PATCH v2 3/7] get_abi.pl: fix xref boundaries Mauro Carvalho Chehab
2021-03-25 10:38 ` [PATCH v2 4/7] scripts: get_abi.pl: extend xref match to other types Mauro Carvalho Chehab
2021-03-25 10:38 ` [PATCH v2 5/7] scripts: get_abi.pl: parse description line per line Mauro Carvalho Chehab
2021-03-25 10:38 ` Mauro Carvalho Chehab [this message]
2021-03-25 10:38 ` [PATCH v2 7/7] ABI: sysfs-kernel-mm-cma: fix two cross-references Mauro Carvalho Chehab
2021-04-01 21:56 ` John Hubbard
2021-03-25 19:01 ` [PATCH v2 0/7] Fix some issues at get_abi.pl script Jonathan Corbet
2021-03-25 20:36 ` Mauro Carvalho Chehab
2021-03-31 20:02 ` 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=a590f994f8a5742db333bde69e88241a080e4fe0.1616668017.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@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 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).