提交 f1583922 编写于 作者: T Tomasz Warniełło 提交者: Jonathan Corbet

scripts: kernel-doc: Translate the DESCRIPTION section

Transition the description section into POD. This is one of the standard
documentation sections. This adjustment makes the section available for
POD and makes it look better.

Notes:
- an article addition
- paragraphing correction
Signed-off-by: NTomasz Warniełło <tomasz.warniello@gmail.com>
Tested-by: NRandy Dunlap <rdunlap@infradead.org>
Acked-by: NRandy Dunlap <rdunlap@infradead.org>
Disliked-by: NAkira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/20220218181628.1411551-4-tomasz.warniello@gmail.comSigned-off-by: NJonathan Corbet <corbet@lwn.net>
上级 43caf1a6
...@@ -41,6 +41,15 @@ kernel-doc - Print formatted kernel documentation to stdout ...@@ -41,6 +41,15 @@ kernel-doc - Print formatted kernel documentation to stdout
Run `kernel-doc -h` for details. Run `kernel-doc -h` for details.
=head1 DESCRIPTION
Read C language source or header FILEs, extract embedded documentation comments,
and print formatted documentation to standard output.
The documentation comments are identified by the "/**" opening comment mark.
See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
=cut =cut
# 18/01/2001 - Cleanups # 18/01/2001 - Cleanups
...@@ -72,12 +81,6 @@ sub usage { ...@@ -72,12 +81,6 @@ sub usage {
my $message = <<"EOF"; my $message = <<"EOF";
Usage: $0 [OPTION ...] FILE ... Usage: $0 [OPTION ...] FILE ...
Read C language source or header FILEs, extract embedded documentation comments,
and print formatted documentation to standard output.
The documentation comments are identified by "/**" opening comment mark. See
Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
Output format selection (mutually exclusive): Output format selection (mutually exclusive):
-man Output troff manual page format. This is the default. -man Output troff manual page format. This is the default.
-rst Output reStructuredText format. -rst Output reStructuredText format.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册