From: Cruz Julian Bishop Date: Wed, 1 Aug 2012 04:54:17 +0000 (+1000) Subject: staging: android: logger.h: Complete documentation of logger_entry X-Git-Tag: next-20120816~16^2~63 X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=adb913658f5cecc02dd8f36aa9edecb3e9fd3399;p=karo-tx-linux.git staging: android: logger.h: Complete documentation of logger_entry Previously, there were simply comments after each part - Now, it is completed properly according to "Kernel doc" Sorry in advance if I made any mistakes. Signed-off-by: Cruz Julian Bishop Signed-off-by: Greg Kroah-Hartman --- diff --git a/drivers/staging/android/logger.h b/drivers/staging/android/logger.h index 2cb06e9d8f98..9b929a8c7468 100644 --- a/drivers/staging/android/logger.h +++ b/drivers/staging/android/logger.h @@ -20,14 +20,24 @@ #include #include +/** + * struct logger_entry - defines a single entry that is given to a logger + * @len: The length of the payload + * @__pad: Two bytes of padding that appear to be required + * @pid: The generating process' process ID + * @tid: The generating process' thread ID + * @sec: The number of seconds that have elapsed since the Epoch + * @nsec: The number of nanoseconds that have elapsed since @sec + * @msg: The message that is to be logged + */ struct logger_entry { - __u16 len; /* length of the payload */ - __u16 __pad; /* no matter what, we get 2 bytes of padding */ - __s32 pid; /* generating process's pid */ - __s32 tid; /* generating process's tid */ - __s32 sec; /* seconds since Epoch */ - __s32 nsec; /* nanoseconds */ - char msg[0]; /* the entry's payload */ + __u16 len; + __u16 __pad; + __s32 pid; + __s32 tid; + __s32 sec; + __s32 nsec; + char msg[0]; }; #define LOGGER_LOG_RADIO "log_radio" /* radio-related messages */