| kernel-doc (f1583922bf9383ce0079dfdded959dfc5585dc5b) | kernel-doc (2875f78708219feadf0956dcf9e936ec25fb7a8b) |
|---|---|
| 1#!/usr/bin/env perl 2# SPDX-License-Identifier: GPL-2.0 3 4use warnings; 5use strict; 6 7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## --- 38 unchanged lines hidden (view full) --- 47and print formatted documentation to standard output. 48 49The documentation comments are identified by the "/**" opening comment mark. 50 51See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. 52 53=cut 54 | 1#!/usr/bin/env perl 2# SPDX-License-Identifier: GPL-2.0 3 4use warnings; 5use strict; 6 7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## --- 38 unchanged lines hidden (view full) --- 47and print formatted documentation to standard output. 48 49The documentation comments are identified by the "/**" opening comment mark. 50 51See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. 52 53=cut 54 |
| 55# more perldoc at the end of the file 56 |
|
| 55# 18/01/2001 - Cleanups 56# Functions prototyped as foo(void) same as foo() 57# Stop eval'ing where we don't need to. 58# -- huggie@earth.li 59 60# 27/06/2001 - Allowed whitespace after initial "/**" and 61# allowed comments before function declarations. 62# -- Christian Kreibich <ck@whoop.org> --- 13 unchanged lines hidden (view full) --- 76 77# 25/07/2012 - Added support for HTML5 78# -- Dan Luedtke <mail@danrl.de> 79 80sub usage { 81 my $message = <<"EOF"; 82Usage: $0 [OPTION ...] FILE ... 83 | 57# 18/01/2001 - Cleanups 58# Functions prototyped as foo(void) same as foo() 59# Stop eval'ing where we don't need to. 60# -- huggie@earth.li 61 62# 27/06/2001 - Allowed whitespace after initial "/**" and 63# allowed comments before function declarations. 64# -- Christian Kreibich <ck@whoop.org> --- 13 unchanged lines hidden (view full) --- 78 79# 25/07/2012 - Added support for HTML5 80# -- Dan Luedtke <mail@danrl.de> 81 82sub usage { 83 my $message = <<"EOF"; 84Usage: $0 [OPTION ...] FILE ... 85 |
| 84Output format selection (mutually exclusive): 85 -man Output troff manual page format. This is the default. 86 -rst Output reStructuredText format. 87 -none Do not output documentation, only warnings. 88 | |
| 89Output format selection modifier (affects only ReST output): 90 91 -sphinx-version Use the ReST C domain dialect compatible with an 92 specific Sphinx Version. 93 If not specified, kernel-doc will auto-detect using 94 the sphinx-build version found on PATH. 95 96Output selection (mutually exclusive): --- 2461 unchanged lines hidden (view full) --- 2558} 2559 2560if ($Werror && $warnings) { 2561 print STDERR "$warnings warnings as Errors\n"; 2562 exit($warnings); 2563} else { 2564 exit($output_mode eq "none" ? 0 : $errors) 2565} | 86Output format selection modifier (affects only ReST output): 87 88 -sphinx-version Use the ReST C domain dialect compatible with an 89 specific Sphinx Version. 90 If not specified, kernel-doc will auto-detect using 91 the sphinx-build version found on PATH. 92 93Output selection (mutually exclusive): --- 2461 unchanged lines hidden (view full) --- 2555} 2556 2557if ($Werror && $warnings) { 2558 print STDERR "$warnings warnings as Errors\n"; 2559 exit($warnings); 2560} else { 2561 exit($output_mode eq "none" ? 0 : $errors) 2562} |
| 2563 2564__END__ 2565 2566=head1 OPTIONS 2567 2568=head2 Output format selection (mutually exclusive): 2569 2570=over 8 2571 2572=item -man 2573 2574Output troff manual page format. 2575 2576=item -rst 2577 2578Output reStructuredText format. This is the default. 2579 2580=item -none 2581 2582Do not output documentation, only warnings. 2583 2584=back 2585 2586=cut |
|