linux-kernel - Re: linux-next: build warning after merge of the xfs tree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240223095509.29024d9d@coco.lan>
Date: Fri, 23 Feb 2024 09:55:09 +0100
From: Mauro Carvalho Chehab <mchehab@...nel.org>
To: Christoph Hellwig <hch@....de>
Cc: Stephen Rothwell <sfr@...b.auug.org.au>, "Darrick J. Wong"
 <djwong@...nel.org>, David Chinner <david@...morbit.com>,
 linux-xfs@...r.kernel.org, Chandan Babu R <chandanbabu@...nel.org>, Linux
 Kernel Mailing List <linux-kernel@...r.kernel.org>, Linux Next Mailing List
 <linux-next@...r.kernel.org>, Jonathan Corbet <corbet@....net>
Subject: Re: linux-next: build warning after merge of the xfs tree

Em Fri, 23 Feb 2024 07:35:54 +0100
Christoph Hellwig <hch@....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