kernel-doc (dd803b04b0a0af16e43c2af1a3e67d7ce8e1f899) | kernel-doc (9c77f108f43ae08e560f54c817d4aeb4857dc783) |
---|---|
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> ## --- 69 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 | 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> ## --- 69 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 |
86Output selection (mutually exclusive): 87 -export Only output documentation for symbols that have been 88 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() 89 in any input FILE or -export-file FILE. 90 -internal Only output documentation for symbols that have NOT been 91 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() 92 in any input FILE or -export-file FILE. 93 -function NAME Only output documentation for the given function(s) 94 or DOC: section title(s). All other functions and DOC: 95 sections are ignored. May be specified multiple times. 96 -nosymbol NAME Exclude the specified symbols from the output 97 documentation. May be specified multiple times. 98 | |
99Output selection modifiers: 100 -no-doc-sections Do not output DOC: sections. 101 -enable-lineno Enable output of #define LINENO lines. Only works with 102 reStructuredText format. 103 -export-file FILE Specify an additional FILE in which to look for 104 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with 105 -export or -internal. May be specified multiple times. 106 --- 2479 unchanged lines hidden (view full) --- 2586 2587Use the ReST C domain dialect compatible with a specific Sphinx Version. 2588 2589If not specified, kernel-doc will auto-detect using the sphinx-build version 2590found on PATH. 2591 2592=back 2593 | 86Output selection modifiers: 87 -no-doc-sections Do not output DOC: sections. 88 -enable-lineno Enable output of #define LINENO lines. Only works with 89 reStructuredText format. 90 -export-file FILE Specify an additional FILE in which to look for 91 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with 92 -export or -internal. May be specified multiple times. 93 --- 2479 unchanged lines hidden (view full) --- 2573 2574Use the ReST C domain dialect compatible with a specific Sphinx Version. 2575 2576If not specified, kernel-doc will auto-detect using the sphinx-build version 2577found on PATH. 2578 2579=back 2580 |
2581=head2 Output selection (mutually exclusive): 2582 2583=over 8 2584 2585=item -export 2586 2587Only output documentation for the symbols that have been exported using 2588EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file FILE. 2589 2590=item -internal 2591 2592Only output documentation for the symbols that have NOT been exported using 2593EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file FILE. 2594 2595=item -function NAME 2596 2597Only output documentation for the given function or DOC: section title. 2598All other functions and DOC: sections are ignored. 2599 2600May be specified multiple times. 2601 2602=item -nosymbol NAME 2603 2604Exclude the specified symbol from the output documentation. 2605 2606May be specified multiple times. 2607 2608=back 2609 |
|
2594=cut | 2610=cut |