Skip to content

Commit 8320b75

Browse files
bagasmechucklever
authored andcommitted
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: 3a1ce35 ("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>
1 parent 3a1ce35 commit 8320b75

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

Documentation/filesystems/nfs/nfsd-maintainer-entry-profile.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,15 +182,15 @@ with the following exceptions:
182182
+ static inline functions
183183
+ static functions that are callbacks/virtual functions
184184

185-
- All new function names start with "nfsd_" for non-NFS-version-
185+
- All new function names start with ``nfsd_`` for non-NFS-version-
186186
specific functions.
187187

188188
- New function names that are specific to NFSv2 or NFSv3, or are
189-
used by all minor versions of NFSv4, use "nfsdN_" where N is
189+
used by all minor versions of NFSv4, use ``nfsdN_`` where N is
190190
the version.
191191

192192
- New function names specific to an NFSv4 minor version can be
193-
named with "nfsd4M_" where M is the minor version.
193+
named with ``nfsd4M_`` where M is the minor version.
194194

195195
Patch preparation
196196
~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)