From: Cruz Julian Bishop <cruzjbishop@gmail.com>
To: greg@kroah.com
Cc: swetland@google.com, linux-kernel@vger.kernel.org,
Cruz Julian Bishop <cruzjbishop@gmail.com>
Subject: [PATCH 2/5] Complete documentation of logger_entry in android/logger.h
Date: Wed, 1 Aug 2012 14:54:17 +1000 [thread overview]
Message-ID: <1343796860-7025-3-git-send-email-cruzjbishop@gmail.com> (raw)
In-Reply-To: <1343796860-7025-1-git-send-email-cruzjbishop@gmail.com>
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>
---
drivers/staging/android/logger.h | 24 +++++++++++++++++-------
1 file changed, 17 insertions(+), 7 deletions(-)
diff --git a/drivers/staging/android/logger.h b/drivers/staging/android/logger.h
index 2cb06e9..9b929a8 100644
--- a/drivers/staging/android/logger.h
+++ b/drivers/staging/android/logger.h
@@ -20,14 +20,24 @@
#include <linux/types.h>
#include <linux/ioctl.h>
+/**
+ * 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 */
--
1.7.9.5
next prev parent reply other threads:[~2012-08-01 4:54 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-08-01 4:54 [PATCH 0/5] Android: Small documentation changes and a bug fix Cruz Julian Bishop
2012-08-01 4:54 ` [PATCH 1/5] Fix comment/license formatting in android/ashmem.c Cruz Julian Bishop
2012-08-01 4:54 ` Cruz Julian Bishop [this message]
2012-08-01 4:54 ` [PATCH 3/5] Finish documentation of two structs in android/logger.c Cruz Julian Bishop
2012-08-01 4:54 ` [PATCH 4/5] Redocument some functions " Cruz Julian Bishop
2012-08-14 2:00 ` Greg KH
2012-08-01 4:54 ` [PATCH 5/5] Fixes a potential bug " Cruz Julian Bishop
2012-08-01 23:50 ` Ryan Mallon
2012-08-14 2:01 ` Greg KH
2012-08-14 4:08 ` Cruz Julian Bishop
2012-08-01 5:18 ` [PATCH 0/5] Android: Small documentation changes and a bug fix Cruz Julian Bishop
2012-08-14 2:02 ` Greg KH
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1343796860-7025-3-git-send-email-cruzjbishop@gmail.com \
--to=cruzjbishop@gmail.com \
--cc=greg@kroah.com \
--cc=linux-kernel@vger.kernel.org \
--cc=swetland@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).