Skip to contentSkip to conversation

rxrpc: mention that client key payloads are not arbitrary

PATCH In review Ben Boeckel 2 participants 2 messages Sep 27, 2018

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

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

---
 net/rxrpc/key.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
net/rxrpc/key.c +2 -2
index e7f6b8823eb6..51fb50541397 100644
@@ -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",
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 4 lines · Ben Boeckel

- * 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