doc: document the kernel-doc conventions for kernel hackers grammar fixes
PATCH v2 1/1 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(-)
Documentation/kernel-doc-nano-HOWTO.txt +2 -2
@@ -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
Signature · 3 lines
I won't rest till it's the best ...
Programmer, Linux Scalability
Paul Jackson <[email protected]> 1.650.933.1373