]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
NFS: nfsd-maintainer-entry-profile: Inline function name prefixes
authorBagas Sanjaya <bagasdotme@gmail.com>
Mon, 17 Nov 2025 10:24:17 +0000 (17:24 +0700)
committerChuck Lever <chuck.lever@oracle.com>
Mon, 17 Nov 2025 13:46:06 +0000 (08:46 -0500)
Sphinx reports htmldocs warnings:

Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst:185: ERROR: Unknown target name: "nfsd". [docutils]
Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst:188: ERROR: Unknown target name: "nfsdn". [docutils]
Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst:192: ERROR: Unknown target name: "nfsd4m". [docutils]

These are due to Sphinx confusing function name prefixes for external
link syntax. Fix the warnings by inlining the prefixes.

Fixes: 3a1ce35030e1e0 ("NFSD: Add a subsystem policy document")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251117174218.29365f30@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst

index cebbbdad871042fbc76be8f26b94b2efeb39404c..4d6b57dbab2a249711f33b554b9779531c850955 100644 (file)
@@ -182,15 +182,15 @@ with the following exceptions:
   + static inline functions
   + static functions that are callbacks/virtual functions
 
-- All new function names start with "nfsd_" for non-NFS-version-
+- All new function names start with ``nfsd_`` for non-NFS-version-
   specific functions.
 
 - New function names that are specific to NFSv2 or NFSv3, or are
-  used by all minor versions of NFSv4, use "nfsdN_" where N is
+  used by all minor versions of NFSv4, use ``nfsdN_`` where N is
   the version.
 
 - New function names specific to an NFSv4 minor version can be
-  named with "nfsd4M_" where M is the minor version.
+  named with ``nfsd4M_`` where M is the minor version.
 
 Patch preparation
 ~~~~~~~~~~~~~~~~~