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>,
linux-kernel@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
John Hubbard <jhubbard@nvidia.com>,
Minchan Kim <minchan@kernel.org>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH v2 0/7] Fix some issues at get_abi.pl script
Date: Thu, 25 Mar 2021 11:38:21 +0100 [thread overview]
Message-ID: <cover.1616668017.git.mchehab+huawei@kernel.org> (raw)
This series replace this patch:
https://lore.kernel.org/linux-doc/20210324191722.08d352e4@coco.lan/T/#t
It turns that there were multiple bugs at the get_abi.pl code that
create cross-references.
Patches 1 to 6 fix those issues, and should apply cleanly on the top of
the docs tree (although I tested against next-20210323).
Patch 7 is optional, and independent from the other patches. It is meant
to be applied against akpm's tree. It makes the description (IMHO)
clearer, while producing cross references for the two mentioned symbols.
The fix patches are:
patch 1: fix some regexes that match the symbols that need to be
escaped when parsing "What:". The same regex is also used when
generating cross-references;
patch 2: makes the check for Documentation/ABI references more
robust, as right now, it stops at the first occurrence;
patch 3: fix the parser for /sys/foo -> xref conversion. Basically,
the logic that seeks for start and end boundaries were broken.
The new logic is a way more robust.
patch 4: generate cross-references for /config/foo and other less
common ABI occurrences;
patch 5 and 6: don't generate cross-references inside literal blocks.
Right now, there are a couple of places that would otherwise
generate references, producing a bad output.
Mauro Carvalho Chehab (7):
scripts: get_abi.pl: better handle escape chars on what:
get_abi.pl: seek for all occurrences for Documentation/ABI
get_abi.pl: fix xref boundaries
scripts: get_abi.pl: extend xref match to other types
scripts: get_abi.pl: parse description line per line
scripts: get_abi: ignore code blocks for cross-references
ABI: sysfs-kernel-mm-cma: fix two cross-references
Documentation/ABI/testing/sysfs-kernel-mm-cma | 8 +-
scripts/get_abi.pl | 76 +++++++++++++------
2 files changed, 57 insertions(+), 27 deletions(-)
--
2.30.2
next 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 Mauro Carvalho Chehab [this message]
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 ` [PATCH v2 6/7] scripts: get_abi: ignore code blocks for cross-references Mauro Carvalho Chehab
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=cover.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=jhubbard@nvidia.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=minchan@kernel.org \
--cc=sfr@canb.auug.org.au \
/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).