Received-SPF: pass (google.com: domain of linux-kernel+bounces-77958-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Fri, 23 Feb 2024 09:55:09 +0100
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Christoph Hellwig <hch@lst.de>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>, "Darrick J. Wong"
 <djwong@kernel.org>, David Chinner <david@fromorbit.com>,
 linux-xfs@vger.kernel.org, Chandan Babu R <chandanbabu@kernel.org>, Linux
 Kernel Mailing List <linux-kernel@vger.kernel.org>, Linux Next Mailing List
 <linux-next@vger.kernel.org>, Jonathan Corbet <corbet@lwn.net>
Subject: Re: linux-next: build warning after merge of the xfs tree
Message-ID: <20240223095509.29024d9d@coco.lan>
In-Reply-To: <20240223063554.GA10956@lst.de>
References: <20240223153636.41358be5@canb.auug.org.au>
	<20240223063554.GA10956@lst.de>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit

Em Fri, 23 Feb 2024 07:35:54 +0100
Christoph Hellwig <hch@lst.de> escreveu:

> On Fri, Feb 23, 2024 at 03:36:36PM +1100, Stephen Rothwell wrote:
> > Hi all,
> > 
> > After merging the xfs tree, today's linux-next build (htmldocs) produced
> > this warning:
> > 
> > Documentation/core-api/mm-api:130: mm/shmem.c:2155: WARNING: Inline emphasis start-string without end-string.
> > Documentation/core-api/mm-api:130: mm/shmem.c:2156: WARNING: Inline emphasis start-string without end-string.  
> 
> Thanks for the headsup.  Looks like kernel-doc doesn't like the
> pointer dereferene * operator.  Any good idea how to write this instead?

Asterisks there are used to do *italic* or **bold**. To have an
asterisk as-is, it needs to be escaped. This would work:

	\*foo

but it is very weird for the ones reading the text file. So, what
we do instead for pointers is to escape the entire declaration, like:

	``*inode``
	``struct inode *inode``

I hope that helps.

Thanks,
Mauro