* [PATCH v2] doc: document the kernel-doc conventions for kernel hackers grammar fixes
@ 2008-05-31 0:57 Paul Jackson
0 siblings, 0 replies; only message in thread
From: Paul Jackson @ 2008-05-31 0:57 UTC (permalink / raw)
To: Andrew Morton; +Cc: Alan Cox, Randy Dunlap, Paul Jackson, linux-kernel
---
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@sgi.com> 1.650.933.1373
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2008-05-31 0:57 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-05-31 0:57 [PATCH v2] doc: document the kernel-doc conventions for kernel hackers grammar fixes Paul Jackson
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®