All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Cezary Rojewski <cezary.rojewski@intel.com>,
	Finn Behrens <me@kloenk.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	linux-kernel@vger.kernel.org,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH] script: get_abi.pl: escape "<" and ">" characters
Date: Wed, 24 Mar 2021 11:12:37 -0600	[thread overview]
Message-ID: <87sg4kcw6y.fsf@meer.lwn.net> (raw)
In-Reply-To: <e02449ee86d89cd45313627b52500a6892ea37ae.1616605512.git.mchehab+huawei@kernel.org>

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

  reply	other threads:[~2021-03-24 17:13 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-15  5:35 linux-next: build warning after merge of the akpm-current tree Stephen Rothwell
2021-03-16 18:18 ` Minchan Kim
2021-03-16 21:49   ` Stephen Rothwell
2021-03-16 23:09     ` Jonathan Corbet
2021-03-17 13:22       ` Mauro Carvalho Chehab
2021-03-24 17:06         ` [PATCH] script: get_abi.pl: escape "<" and ">" characters Mauro Carvalho Chehab
2021-03-24 17:12           ` Jonathan Corbet [this message]
2021-03-24 18:17             ` Mauro Carvalho Chehab

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=87sg4kcw6y.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=cezary.rojewski@intel.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=me@kloenk.de \
    --cc=sfr@canb.auug.org.au \
    --cc=suzuki.poulose@arm.com \
    /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.