* [PATCH] script: get_abi.pl: escape "<" and ">" characters [not found] <20210317142238.228fb1e8@coco.lan> @ 2021-03-24 17:06 ` Mauro Carvalho Chehab 2021-03-24 17:12 ` Jonathan Corbet 0 siblings, 1 reply; 3+ messages in thread From: Mauro Carvalho Chehab @ 2021-03-24 17:06 UTC (permalink / raw) To: Linux Doc Mailing List, Jonathan Corbet Cc: Mauro Carvalho Chehab, Cezary Rojewski, Finn Behrens, Greg Kroah-Hartman, Suzuki K Poulose, linux-kernel, Stephen Rothwell After merging the akpm-current tree, today's linux-next build (htmldocs) produced this warning: Documentation/ABI/testing/sysfs-kernel-mm-cma:2: WARNING: Inline interpreted text or phrase reference start-string without end-string. Introduced by commit 439d477342a3 ("mm: cma: support sysfs") As pointed by Jonathan, the problem is this text in sysfs-kernel-mm-cma: Each CMA heap subdirectory (that is, each /sys/kernel/mm/cma/<cma-heap-name> directory) contains the following items: Is not parsed well, becase the major/minor signs need to be escaped, when converted into cross-references. Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Reported-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- scripts/get_abi.pl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/get_abi.pl b/scripts/get_abi.pl index 92d9aa6cc4f5..79d195b48652 100755 --- a/scripts/get_abi.pl +++ b/scripts/get_abi.pl @@ -305,7 +305,7 @@ sub output_rest { } my $w = $what; - $w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g; + $w =~ s/([\(\)\_\-\*\=\^\~\\\<\>])/\\$1/g; if ($type ne "File") { my $cur_part = $what; -- 2.30.2 ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] script: get_abi.pl: escape "<" and ">" characters 2021-03-24 17:06 ` [PATCH] script: get_abi.pl: escape "<" and ">" characters Mauro Carvalho Chehab @ 2021-03-24 17:12 ` Jonathan Corbet 2021-03-24 18:17 ` Mauro Carvalho Chehab 0 siblings, 1 reply; 3+ messages in thread From: Jonathan Corbet @ 2021-03-24 17:12 UTC (permalink / raw) To: Mauro Carvalho Chehab, Linux Doc Mailing List Cc: Mauro Carvalho Chehab, Cezary Rojewski, Finn Behrens, Greg Kroah-Hartman, Suzuki K Poulose, linux-kernel, Stephen Rothwell Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes: > After merging the akpm-current tree, today's linux-next build (htmldocs) > produced this warning: > > Documentation/ABI/testing/sysfs-kernel-mm-cma:2: WARNING: Inline interpreted text or phrase reference start-string without end-string. > > Introduced by commit 439d477342a3 ("mm: cma: support sysfs") > > As pointed by Jonathan, the problem is this text in > sysfs-kernel-mm-cma: > > Each CMA heap subdirectory (that is, each > /sys/kernel/mm/cma/<cma-heap-name> directory) contains the > following items: > > Is not parsed well, becase the major/minor signs need to be > escaped, when converted into cross-references. Sorry, I kind of dropped the ball on this, and everything else really; a bit of a challenging time here. This makes the warning go away, but I have to wonder if it's the right fix - wouldn't it be better to avoid trying to create a cross-reference entirely in cases where it clearly won't work? Or am I missing something here? Thanks, jon ^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] script: get_abi.pl: escape "<" and ">" characters 2021-03-24 17:12 ` Jonathan Corbet @ 2021-03-24 18:17 ` Mauro Carvalho Chehab 0 siblings, 0 replies; 3+ messages in thread From: Mauro Carvalho Chehab @ 2021-03-24 18:17 UTC (permalink / raw) To: Jonathan Corbet Cc: Linux Doc Mailing List, Cezary Rojewski, Finn Behrens, Greg Kroah-Hartman, Suzuki K Poulose, linux-kernel, Stephen Rothwell Em Wed, 24 Mar 2021 11:12:37 -0600 Jonathan Corbet <corbet@lwn.net> escreveu: > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes: > > > After merging the akpm-current tree, today's linux-next build (htmldocs) > > produced this warning: > > > > Documentation/ABI/testing/sysfs-kernel-mm-cma:2: WARNING: Inline interpreted text or phrase reference start-string without end-string. > > > > Introduced by commit 439d477342a3 ("mm: cma: support sysfs") > > > > As pointed by Jonathan, the problem is this text in > > sysfs-kernel-mm-cma: > > > > Each CMA heap subdirectory (that is, each > > /sys/kernel/mm/cma/<cma-heap-name> directory) contains the > > following items: > > > > Is not parsed well, becase the major/minor signs need to be > > escaped, when converted into cross-references. > > Sorry, I kind of dropped the ball on this, and everything else really; a > bit of a challenging time here. > > This makes the warning go away, but I have to wonder if it's the right > fix There's indeed an issue on another part of the script. I'm testing a second version using a better and more generic regex set. > - wouldn't it be better to avoid trying to create a cross-reference > entirely in cases where it clearly won't work? Or am I missing > something here? The cross-reference logic on this script is somewhat smart: it will only create cross-references if the symbol exists. If not, it keeps the symbol as-is. The problem was actually on another part of the logic: there is a symbol "/sys/kernel/mm/cma". The script is currently thinking that the "<" character at: /sys/kernel/mm/cma/<cma-heap-name> is a bondary. So, it ended converting the first part ("/sys/kernel/mm/cma/") into a cross reference. This patch fixed it by dropping the reference for the non-existent symbol "/sys/kernel/mm/cma/" (the reference should be, instead, to /sys/kernel/mm/cma/<cma-heap-name>/foo), but there's still a hidden bug, which causes that a reference for /sys/kernel/mm/cma/<cma-heap-name>/alloc_pages_success to be broken. I have already a new patch. I'm checking right now if everything is ok after the regex change. I should be sending a version 2 probably in a few. Thanks, Mauro ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-03-24 18:18 UTC | newest] Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- [not found] <20210317142238.228fb1e8@coco.lan> 2021-03-24 17:06 ` [PATCH] script: get_abi.pl: escape "<" and ">" characters Mauro Carvalho Chehab 2021-03-24 17:12 ` Jonathan Corbet 2021-03-24 18:17 ` Mauro Carvalho Chehab
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).