diff mbox series

[v1,04/12] SUNRPC: Clarify comment that documents svc_max_payload()

Message ID 166301777040.89884.17493610305295762804.stgit@oracle-102.nfsv4.dev (mailing list archive)
State New, archived
Headers show
Series Short NFSD clean-ups | expand

Commit Message

Chuck Lever Sept. 12, 2022, 9:22 p.m. UTC
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>
---
 net/sunrpc/svc.c |    8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/net/sunrpc/svc.c b/net/sunrpc/svc.c
index 32a537f852fe..149171774bc6 100644
--- a/net/sunrpc/svc.c
+++ b/net/sunrpc/svc.c
@@ -1554,8 +1554,12 @@  bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
 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)
 {