From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
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: Re: [PATCH v2 0/7] Fix some issues at get_abi.pl script
Date: Thu, 25 Mar 2021 13:01:14 -0600 [thread overview]
Message-ID: <87lfabys5h.fsf@meer.lwn.net> (raw)
In-Reply-To: <cover.1616668017.git.mchehab+huawei@kernel.org>
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 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.
So perhaps this is the best solution to the problem, but I must confess
to not being entirely happy with it. get_abi.pl is becoming another
unreadable perlpile like kerneldoc, and this makes it worse. Doing RST
parsing there seems particularly unwelcome.
Should the cross-reference generation, it now occurs to me, be done in
the automarkup module instead? Then there's no need to interpret RST,
and we'd get cross-references throughout the kernel docs rather than in
just the ABI stuff. Am I completely out to lunch here?
Thanks,
jon
next prev parent reply other threads:[~2021-03-25 19:02 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 ` [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 ` Jonathan Corbet [this message]
2021-03-25 20:36 ` [PATCH v2 0/7] Fix some issues at get_abi.pl script 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=87lfabys5h.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=akpm@linux-foundation.org \
--cc=gregkh@linuxfoundation.org \
--cc=jhubbard@nvidia.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@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 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.