afs: Document ->lpr of struct afs_callback_arg.
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 26 Mar 2018 23:23:07 +0000 (01:23 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 8 Apr 2018 12:06:46 +0000 (14:06 +0200)
This should have been documented when the ->lpr member was introduced
two years ago in commit ba0a963f (server: Convert com_add() to lopsub).

afs.h

diff --git a/afs.h b/afs.h
index f506cbf..8beca5a 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -161,6 +161,14 @@ struct afs_callback_arg {
        struct osl_object query;
        /** Will be written on band SBD_OUTPUT, fully buffered. */
        struct para_buffer pbout;
+       /**
+        * Convenience pointer for the deserialized parse result.
+        *
+        * Most afs command handlers call \ref send_lls_callback_request() to
+        * serialize the parse result of the subcommand and pass it to the
+        * callback. In afs context a pointer to the deserialized parse result
+        * is stored here.
+        */
        struct lls_parse_result *lpr;
 };