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

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

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
head:   cc3aa43b44bdb43dfbac0fcb51c56594a11338a8
commit: 977de00dfcf87e8d95f55dfc247955dc2f9da14d [1503/2671] VFS: move dentry_create() from fs/open.c to fs/namei.c
reproduce: (https://download.01.org/0day-ci/archive/20260101/202601011410.4vVaIDB9-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202601011410.4vVaIDB9-lkp@intel.com/

All warnings (new ones prefixed by >>):

   ERROR: Cannot find file ./include/linux/dcache.h
   WARNING: No kernel-doc for file ./include/linux/dcache.h
   WARNING: ./fs/inode.c:1607 function parameter 'isnew' not described in 'ilookup5_nowait'
   WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
   WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead
>> Documentation/filesystems/api-summary:56: ./fs/namei.c:4953: WARNING: Inline emphasis start-string without end-string. [docutils]
   Documentation/filesystems/api-summary:56: ./fs/namei.c:4943: ERROR: Unknown target name: "o". [docutils]
   ERROR: Cannot find file ./include/linux/buffer_head.h
   WARNING: No kernel-doc for file ./include/linux/buffer_head.h
   ERROR: Cannot find file ./include/linux/fscache-cache.h
   WARNING: No kernel-doc for file ./include/linux/fscache-cache.h

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

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]

Benjamin,

On 1/1/26 5:27 AM, kernel test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
> head:   cc3aa43b44bdb43dfbac0fcb51c56594a11338a8
> commit: 977de00dfcf87e8d95f55dfc247955dc2f9da14d [1503/2671] VFS: move dentry_create() from fs/open.c to fs/namei.c
> reproduce: (https://download.01.org/0day-ci/archive/20260101/202601011410.4vVaIDB9-lkp@intel.com/reproduce)
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202601011410.4vVaIDB9-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
>    ERROR: Cannot find file ./include/linux/dcache.h
>    WARNING: No kernel-doc for file ./include/linux/dcache.h
>    WARNING: ./fs/inode.c:1607 function parameter 'isnew' not described in 'ilookup5_nowait'
>    WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
>    WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead
>>> Documentation/filesystems/api-summary:56: ./fs/namei.c:4953: WARNING: Inline emphasis start-string without end-string. [docutils]
>    Documentation/filesystems/api-summary:56: ./fs/namei.c:4943: ERROR: Unknown target name: "o". [docutils]
>    ERROR: Cannot find file ./include/linux/buffer_head.h
>    WARNING: No kernel-doc for file ./include/linux/buffer_head.h
>    ERROR: Cannot find file ./include/linux/fscache-cache.h
>    WARNING: No kernel-doc for file ./include/linux/fscache-cache.h

fs/open.c is not used in Documentation/ (where the lines were moved _from_).

fs/namei.c needs changes like:

---
 fs/namei.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20251219.orig/fs/namei.c
+++ linux-next-20251219/fs/namei.c
@@ -4938,7 +4938,7 @@ EXPORT_SYMBOL(start_creating_user_path);
 /**
  * dentry_create - Create and open a file
  * @path: path to create
- * @flags: O_ flags
+ * @flags: O_* flags
  * @mode: mode bits for new file
  * @cred: credentials to use
  *
@@ -4949,7 +4949,7 @@ EXPORT_SYMBOL(start_creating_user_path);
  * the new file is to be created. The parent directory and the
  * negative dentry must reside on the same filesystem instance.
  *
- * On success, returns a "struct file *". Otherwise a ERR_PTR
+ * On success, returns a "struct file \*". Otherwise a ERR_PTR
  * is returned.
  */
 struct file *dentry_create(struct path *path, int flags, umode_t mode,


Or                         &struct file \*.
without the quotation marks.

-- 
~Randy

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]

[Matthew Wilcox]

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?

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

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]

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

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]

[Gopi Krishna Menon]

On Thu, Jan 01, 2026 at 07:36:48PM -0800, Randy Dunlap wrote:

> Benjamin,
> 
> On 1/1/26 5:27 AM, kernel test robot wrote:
> > tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
> > head:   cc3aa43b44bdb43dfbac0fcb51c56594a11338a8
> > commit: 977de00dfcf87e8d95f55dfc247955dc2f9da14d [1503/2671] VFS: move dentry_create() from fs/open.c to fs/namei.c
> > reproduce: (https://download.01.org/0day-ci/archive/20260101/202601011410.4vVaIDB9-lkp@intel.com/reproduce)
> > 
> > If you fix the issue in a separate patch/commit (i.e. not just a new version of
> > the same patch/commit), kindly add following tags
> > | Reported-by: kernel test robot <lkp@intel.com>
> > | Closes: https://lore.kernel.org/oe-kbuild-all/202601011410.4vVaIDB9-lkp@intel.com/
> > 
> > All warnings (new ones prefixed by >>):
> > 
> >    ERROR: Cannot find file ./include/linux/dcache.h
> >    WARNING: No kernel-doc for file ./include/linux/dcache.h
> >    WARNING: ./fs/inode.c:1607 function parameter 'isnew' not described in 'ilookup5_nowait'
> >    WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
> >    WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead
> >>> Documentation/filesystems/api-summary:56: ./fs/namei.c:4953: WARNING: Inline emphasis start-string without end-string. [docutils]
> >    Documentation/filesystems/api-summary:56: ./fs/namei.c:4943: ERROR: Unknown target name: "o". [docutils]
> >    ERROR: Cannot find file ./include/linux/buffer_head.h
> >    WARNING: No kernel-doc for file ./include/linux/buffer_head.h
> >    ERROR: Cannot find file ./include/linux/fscache-cache.h
> >    WARNING: No kernel-doc for file ./include/linux/fscache-cache.h
> 
> fs/open.c is not used in Documentation/ (where the lines were moved _from_).
> 
> fs/namei.c needs changes like:
> 
> ---
>  fs/namei.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux-next-20251219.orig/fs/namei.c
> +++ linux-next-20251219/fs/namei.c
> @@ -4938,7 +4938,7 @@ EXPORT_SYMBOL(start_creating_user_path);
>  /**
>   * dentry_create - Create and open a file
>   * @path: path to create
> - * @flags: O_ flags
> + * @flags: O_* flags
>   * @mode: mode bits for new file
>   * @cred: credentials to use
>   *
> @@ -4949,7 +4949,7 @@ EXPORT_SYMBOL(start_creating_user_path);
>   * the new file is to be created. The parent directory and the
>   * negative dentry must reside on the same filesystem instance.
>   *
> - * On success, returns a "struct file *". Otherwise a ERR_PTR
> + * On success, returns a "struct file \*". Otherwise a ERR_PTR
>   * is returned.
>   */
>  struct file *dentry_create(struct path *path, int flags, umode_t mode,
> 
> 
> Or                         &struct file \*.
> without the quotation marks.
> 
> -- 
> ~Randy
> 

Hi Randy,

I have already sent a patch for this here :

https://lore.kernel.org/all/20251231153851.7523-1-krishnagopi487@gmail.com/

Gopi Krishna Menon