From: Chuck Lever <chuck.lever@oracle.com>
Date: Mon, 12 Sep 2022 21:22:50 +0000 (-0400)
Subject: SUNRPC: Clarify comment that documents svc_max_payload()
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=f18d8afbf2fae507fb7246f09fe1de5297c9f11a;p=linux.git

SUNRPC: Clarify comment that documents svc_max_payload()

Note the function returns a per-transport value, not a per-request
value (eg, one that is related to the size of the available send or
receive buffer space).

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

diff --git a/net/sunrpc/svc.c b/net/sunrpc/svc.c
index 32a537f852fec..149171774bc63 100644
--- a/net/sunrpc/svc.c
+++ b/net/sunrpc/svc.c
@@ -1554,8 +1554,12 @@ out:
 EXPORT_SYMBOL_GPL(bc_svc_process);
 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
 
-/*
- * Return (transport-specific) limit on the rpc payload.
+/**
+ * svc_max_payload - Return transport-specific limit on the RPC payload
+ * @rqstp: RPC transaction context
+ *
+ * Returns the maximum number of payload bytes the current transport
+ * allows.
  */
 u32 svc_max_payload(const struct svc_rqst *rqstp)
 {