Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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 <cruzjbishop@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Cruz Julian Bishop and committed by
Greg Kroah-Hartman
adb91365 2258937b

+17 -7
+17 -7
drivers/staging/android/logger.h
··· 20 20 #include <linux/types.h> 21 21 #include <linux/ioctl.h> 22 22 23 + /** 24 + * struct logger_entry - defines a single entry that is given to a logger 25 + * @len: The length of the payload 26 + * @__pad: Two bytes of padding that appear to be required 27 + * @pid: The generating process' process ID 28 + * @tid: The generating process' thread ID 29 + * @sec: The number of seconds that have elapsed since the Epoch 30 + * @nsec: The number of nanoseconds that have elapsed since @sec 31 + * @msg: The message that is to be logged 32 + */ 23 33 struct logger_entry { 24 - __u16 len; /* length of the payload */ 25 - __u16 __pad; /* no matter what, we get 2 bytes of padding */ 26 - __s32 pid; /* generating process's pid */ 27 - __s32 tid; /* generating process's tid */ 28 - __s32 sec; /* seconds since Epoch */ 29 - __s32 nsec; /* nanoseconds */ 30 - char msg[0]; /* the entry's payload */ 34 + __u16 len; 35 + __u16 __pad; 36 + __s32 pid; 37 + __s32 tid; 38 + __s32 sec; 39 + __s32 nsec; 40 + char msg[0]; 31 41 }; 32 42 33 43 #define LOGGER_LOG_RADIO "log_radio" /* radio-related messages */