From 0c09aaba917c3a9a36645864ec3fadea56278970 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 25 Nov 2007 23:20:31 +0100 Subject: [PATCH] afs.h: Add more documentation. --- afs.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/afs.h b/afs.h index 4c171a8e..c7fecd88 100644 --- a/afs.h +++ b/afs.h @@ -110,6 +110,7 @@ struct ls_data { int make_status_items(struct ls_data *d, struct para_buffer *pb); void make_empty_status_items(char *buf); +/** At most that many bytes will be passed from afs to para_server. */ #define VERBOSE_LS_OUTPUT_SIZE 4096 /* @@ -161,6 +162,14 @@ struct pattern_match_data { }; /* afs */ +/** + * Afs command handlers run as a process which is not related to the afs + * process, i.e. they can not change the address space of afs directly. + * Therefore afs commands typically consist of two functions: The command + * handler and the corresponding callback function that runs in afs context. + * + * \sa send_callback_request(). + */ typedef int callback_function(const struct osl_object *, struct osl_object *); __noreturn void afs_init(uint32_t cookie, int socket_fd); void afs_event(enum afs_events event, struct para_buffer *pb, -- 2.39.5