Re: [PATCH] script: get_abi.pl: escape "<" and ">" characters

From: Jonathan Corbet
Date: Wed Mar 24 2021 - 13:13:28 EST


Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> 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