linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] NFS: nfsd-maintainer-entry-profile: Inline function name prefixes
@ 2025-11-17 10:24 Bagas Sanjaya
  2025-11-17 13:47 ` Chuck Lever
  0 siblings, 1 reply; 2+ messages in thread
From: Bagas Sanjaya @ 2025-11-17 10:24 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation, Linux NFS
  Cc: Trond Myklebust, Anna Schumaker, Chuck Lever, Jeff Layton,
	NeilBrown, Olga Kornievskaia, Dai Ngo, Tom Talpey,
	Jonathan Corbet, Bagas Sanjaya, Stephen Rothwell

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>
---
 .../filesystems/nfs/nfsd-maintainer-entry-profile.rst       | 6 +++---
 1 file 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 cebbbdad871042..4d6b57dbab2a24 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
 ~~~~~~~~~~~~~~~~~

base-commit: 377c0011055db83991c430961b639465d29ffb23
-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] NFS: nfsd-maintainer-entry-profile: Inline function name prefixes
  2025-11-17 10:24 [PATCH] NFS: nfsd-maintainer-entry-profile: Inline function name prefixes Bagas Sanjaya
@ 2025-11-17 13:47 ` Chuck Lever
  0 siblings, 0 replies; 2+ messages in thread
From: Chuck Lever @ 2025-11-17 13:47 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation, Linux NFS,
	Bagas Sanjaya
  Cc: Chuck Lever, Trond Myklebust, Anna Schumaker, Jeff Layton,
	NeilBrown, Olga Kornievskaia, Dai Ngo, Tom Talpey,
	Jonathan Corbet, Stephen Rothwell

From: Chuck Lever <chuck.lever@oracle.com>

On Mon, 17 Nov 2025 17:24:17 +0700, Bagas Sanjaya wrote:
> 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.
> 
> [...]

Applied to nfsd-next, thanks!

[1/1] NFS: nfsd-maintainer-entry-profile: Inline function name prefixes
      commit: 8320b75b2b8bf94d4d4f1b59f75ec8dd7188dc76

--
Chuck Lever


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-11-17 13:47 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-17 10:24 [PATCH] NFS: nfsd-maintainer-entry-profile: Inline function name prefixes Bagas Sanjaya
2025-11-17 13:47 ` Chuck Lever

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).