[<prev] [next>] [day] [month] [year] [list]
Message-Id: <20080531005749.2232.66620.sendpatchset@jackhammer.engr.sgi.com>
Date: Fri, 30 May 2008 17:57:49 -0700
From: Paul Jackson <pj@....com>
To: "Andrew Morton" <akpm@...ux-foundation.org>
Cc: "Alan Cox" <alan@...rguk.ukuu.org.uk>,
"Randy Dunlap" <rdunlap@...otime.net>, Paul Jackson <pj@....com>,
linux-kernel@...r.kernel.org
Subject: [PATCH v2] doc: document the kernel-doc conventions for kernel hackers grammar fixes
---
Documentation/kernel-doc-nano-HOWTO.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--- linux-2.6.orig/Documentation/kernel-doc-nano-HOWTO.txt 2008-05-30 17:54:54.508884185 -0700
+++ linux-2.6/Documentation/kernel-doc-nano-HOWTO.txt 2008-05-30 17:54:54.868890267 -0700
@@ -4,14 +4,14 @@ kernel-doc nano-HOWTO
How to format kernel-doc comments
---------------------------------
-In order to provide an embedded, 'C' friendly, easy to maintain,
+In order to provide embedded, 'C' friendly, easy to maintain,
but consistent and extractable documentation of the functions and
data structures in the Linux kernel, the Linux kernel has adopted
a consistent style for documenting functions and their parameters,
and structures and their members.
The format for this documentation is called the kernel-doc format.
-It as documented in this Documentation/kernel-doc-nano-HOWTO.txt file.
+It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file.
This style embeds the documentation within the source files, using
a few simple conventions. The scripts/kernel-doc perl script, some
--
I won't rest till it's the best ...
Programmer, Linux Scalability
Paul Jackson <pj@....com> 1.650.933.1373
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists