dccp: sort out help text

[paraslash.git] / aft.c

diff --git a/aft.c b/aft.c
index 103373493f8cdadc8a6c5a640041f7453ef1fc30..9a22fe81d67006992d5dbb7e775bc37bbc68e094 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -2458,6 +2458,18 @@ static void afs_stat_callback(int fd, const struct osl_object *query)
        pass_buffer_as_shm(buf, strlen(buf), &fd);
 }
 
+/**
+ * Get the current afs status items from the afs process and send it using RC4.
+ *
+ * \param rc4c The rc4 context for data encryption.
+ * \param parser_friendly Whether parser-friendly output format should be used.
+ *
+ * As the contents of the afs status items change in time and the command
+ * handler only has a COW version created at fork time, it can not send
+ * up-to-date afs status items directly. Therefore the usual callback mechanism
+ * is used to pass the status items from the afs process to the command handler
+ * via a shared memory area and a pipe.
+ */
 int send_afs_status(struct rc4_context *rc4c, int parser_friendly)
 {
        struct osl_object query = {.data = &parser_friendly,