[PATCH 3/5] rxrpc: mention that client key payloads are not arbitrary

[PATCH 3/5] rxrpc: mention that client key payloads are not arbitrary

[Ben Boeckel]

Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
---
 net/rxrpc/key.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/net/rxrpc/key.c b/net/rxrpc/key.c
index e7f6b8823eb6..51fb50541397 100644
--- a/net/rxrpc/key.c
+++ b/net/rxrpc/key.c
@@ -38,8 +38,8 @@ static void rxrpc_describe(const struct key *, struct seq_file *);
 static long rxrpc_read(const struct key *, char __user *, size_t);
 
 /*
- * rxrpc defined keys take an arbitrary string as the description and an
- * arbitrary blob of data as the payload
+ * rxrpc defined keys take an arbitrary string as the description. See
+ * rxrpc_preparse for the payload format.
  */
 struct key_type key_type_rxrpc = {
 	.name		= "rxrpc",
-- 
2.17.1

Re: [PATCH 3/5] rxrpc: mention that client key payloads are not arbitrary

[David Howells]

Ben Boeckel <mathstuf@gmail.com> wrote:

> - * rxrpc defined keys take an arbitrary string as the description and an
> - * arbitrary blob of data as the payload
> + * rxrpc defined keys take an arbitrary string as the description. See
> + * rxrpc_preparse for the payload format.

I think this change is unnecessary.  Someone who knows what they're looking at
should know that.  Better would be to describe it in Documentation somewhere.
Might be worth just deleting that particular comment entirely.

David