Re: [linux-next:master 1503/2671] htmldocs: Documentation/filesystems/api-summary:56: ./fs/namei.c:4953: WARNING: Inline emphasis start-string without end-string. [docutils]

[Randy Dunlap <rdunlap@infradead.org>]

On 1/1/26 7:44 PM, Matthew Wilcox wrote:
> On Thu, Jan 01, 2026 at 07:36:48PM -0800, Randy Dunlap wrote:
>> fs/open.c is not used in Documentation/ (where the lines were moved _from_).
> 
> That seems like it might be worth a patch?
> 
> +++ b/Documentation/filesystems/api-summary.rst
> @@ -56,6 +56,9 @@ Other Functions
>  .. kernel-doc:: fs/namei.c
>     :export:
> 
> +.. kernel-doc:: fs/open.c
> +   :export:
> +
>  .. kernel-doc:: block/bio.c
>     :export:
> 
> 
> ... of course, then someone would have to check it didn't introduce new
> errors, so it's a bit more work than that.  Perhaps you'd like to take
> care of it?

It seems safe enough unless -Wall or -Wreturn is used (these are not used
by default AFAICT), yielding these warnings:
Warning: fs/open.c:1046 No description found for return value of 'finish_open'
Warning: fs/open.c:1069 No description found for return value of 'finish_no_open'
Warning: fs/open.c:1089 No description found for return value of 'vfs_open'
Warning: fs/open.c:1330 No description found for return value of 'file_open_name'
Warning: fs/open.c:1351 No description found for return value of 'filp_open'
Warning: fs/open.c:1046 No description found for return value of 'finish_open'
Warning: fs/open.c:1069 No description found for return value of 'finish_no_open'
Warning: fs/open.c:1089 No description found for return value of 'vfs_open'
Warning: fs/open.c:1330 No description found for return value of 'file_open_name'
Warning: fs/open.c:1351 No description found for return value of 'filp_open'


Sure, I'll send that patch.

> (and don't we have a script that flags files that have kernel-doc that's
> not included in rst files?)

tools/doc/find-unused-docs.sh

-- 
~Randy