Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-10 14:11:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

scripts: get_abi.pl: update its documentation

Browse Source 
The current highlight schema is not working properly. So, use,
instead, Pod::Text.

While here, also update the copyright in order to reflect the latest
changes and the e-mail I'm currently using.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/89fcd301e065ed86dfd8670725144b196266b6a4.1632750315.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Mauro Carvalho Chehab 2021-09-27 15:49:51 +02:00 committed by Greg Kroah-Hartman
parent 87b58c6fae
commit 42f09848cf
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
scripts/get_abi.pl
View File

@ -1,10 +1,12 @@
#!/usr/bin/env perl #!/usr/bin/env perl
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
BEGIN { $Pod::Usage::Formatter = 'Pod::Text::Termcap'; }
use strict; use strict;
use warnings; use warnings;
use utf8; use utf8;
use Pod::Usage; use Pod::Usage qw(pod2usage);
use Getopt::Long; use Getopt::Long;
use File::Find; use File::Find;
use Fcntl ':mode'; use Fcntl ':mode';
@ -47,7 +49,7 @@ GetOptions(
) or pod2usage(2); ) or pod2usage(2);
pod2usage(1) if $help; pod2usage(1) if $help;
pod2usage(-exitstatus => 0, -verbose => 2) if $man; pod2usage(-exitstatus => 0, -noperldoc, -verbose => 2) if $man;
pod2usage(2) if (scalar @ARGV < 1 || @ARGV > 2); pod2usage(2) if (scalar @ARGV < 1 || @ARGV > 2);
@ -923,18 +925,18 @@ B<abi_book.pl> [--debug <level>] [--enable-lineno] [--man] [--help]
[--search-string <regex>] [--search-string <regex>]
<COMAND> [<ARGUMENT>] <COMAND> [<ARGUMENT>]
Where <COMMAND> can be: Where B<COMMAND> can be:
=over 8 =over 8
B<search> [SEARCH_REGEX] - search for [SEARCH_REGEX] inside ABI B<search> I<SEARCH_REGEX> - search for I<SEARCH_REGEX> inside ABI
B<rest> - output the ABI in ReST markup language B<rest> - output the ABI in ReST markup language
B<validate> - validate the ABI contents B<validate> - validate the ABI contents
B<undefined> - existing symbols at the system that aren't B<undefined> - existing symbols at the system that aren't
defined at Documentation/ABI defined at Documentation/ABI
=back =back
@ -950,9 +952,9 @@ the Documentation/ABI directory.
=item B<--rst-source> and B<--no-rst-source> =item B<--rst-source> and B<--no-rst-source>
The input file may be using ReST syntax or not. Those two options allow The input file may be using ReST syntax or not. Those two options allow
selecting between a rst-compliant source ABI (--rst-source), or a selecting between a rst-compliant source ABI (B<--rst-source>), or a
plain text that may be violating ReST spec, so it requres some escaping plain text that may be violating ReST spec, so it requres some escaping
logic (--no-rst-source). logic (B<--no-rst-source>).
=item B<--enable-lineno> =item B<--enable-lineno>
@ -972,7 +974,7 @@ following bitmask:
Show hints about possible definitions for the missing ABI symbols. Show hints about possible definitions for the missing ABI symbols.
Used only when B<undefined>. Used only when B<undefined>.
=item B<--search-string> [regex string] =item B<--search-string> I<regex string>
Show only occurences that match a search string. Show only occurences that match a search string.
Used only when B<undefined>. Used only when B<undefined>.
@ -1021,11 +1023,11 @@ $ scripts/get_abi.pl rest --dir Documentation/ABI/obsolete
=head1 BUGS =head1 BUGS
Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Report bugs to Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
=head1 COPYRIGHT =head1 COPYRIGHT
Copyright (c) 2016-2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>. Copyright (c) 2016-2021 by Mauro Carvalho Chehab <mchehab+huawei@kernel.org>.
License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>. License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.