diff options
| author | Bagas Sanjaya <bagasdotme@gmail.com> | 2025-11-17 17:24:17 +0700 |
|---|---|---|
| committer | Chuck Lever <chuck.lever@oracle.com> | 2025-11-17 08:46:06 -0500 |
| commit | 8320b75b2b8bf94d4d4f1b59f75ec8dd7188dc76 (patch) | |
| tree | 8e9c3ba62799f0420204e7dfc0e185438fd6642b | |
| parent | 3a1ce35030e1e0e35bc38db5e0be0165945f7e7f (diff) | |
NFS: nfsd-maintainer-entry-profile: Inline function name prefixes
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>
| -rw-r--r-- | Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst b/Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst index cebbbdad8710..4d6b57dbab2a 100644 --- a/Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst +++ b/Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst @@ -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 ~~~~~~~~~~~~~~~~~ |