SUNRPC: Fix comments for transport class registration
authorChuck Lever <chuck.lever@oracle.com>
Mon, 12 Jun 2023 14:14:04 +0000 (10:14 -0400)
committerChuck Lever <chuck.lever@oracle.com>
Sat, 17 Jun 2023 17:18:07 +0000 (13:18 -0400)
The preceding block comment before svc_register_xprt_class() is
not related to that function.

While we're here, add proper documenting comments for these two
publicly-visible functions.

Reviewed-by: Jeff Layton <jlayton@kernel.org>
Acked-by: Tom Talpey <tom@talpey.com>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
net/sunrpc/svc_xprt.c

index 79b8888..5a3512b 100644 (file)
@@ -74,6 +74,13 @@ static LIST_HEAD(svc_xprt_class_list);
  *               that no other thread will be using the transport or will
  *               try to set XPT_DEAD.
  */
+
+/**
+ * svc_reg_xprt_class - Register a server-side RPC transport class
+ * @xcl: New transport class to be registered
+ *
+ * Returns zero on success; otherwise a negative errno is returned.
+ */
 int svc_reg_xprt_class(struct svc_xprt_class *xcl)
 {
        struct svc_xprt_class *cl;
@@ -96,6 +103,11 @@ out:
 }
 EXPORT_SYMBOL_GPL(svc_reg_xprt_class);
 
+/**
+ * svc_unreg_xprt_class - Unregister a server-side RPC transport class
+ * @xcl: Transport class to be unregistered
+ *
+ */
 void svc_unreg_xprt_class(struct svc_xprt_class *xcl)
 {
        dprintk("svc: Removing svc transport class '%s'\n", xcl->xcl_name);