[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm (_
|
From: |
Patrice Dumas |
|
Subject: |
branch master updated: * Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm (_convert_pod) (%standard_headers): prepend the module name to first level section names only if in a list of standard headers taken from perlpodstyle and perldocstyle. |
|
Date: |
Tue, 08 Feb 2022 10:45:00 -0500 |
This is an automated email from the git hooks/post-receive script.
pertusus pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new 4be685f866 * Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm
(_convert_pod) (%standard_headers): prepend the module name to first level
section names only if in a list of standard headers taken from perlpodstyle and
perldocstyle.
4be685f866 is described below
commit 4be685f86693ece588f7f21f7db307c251fbd572
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Tue Feb 8 16:44:45 2022 +0100
* Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm (_convert_pod)
(%standard_headers): prepend the module name to first level
section names only if in a list of standard headers taken
from perlpodstyle and perldocstyle.
* tp/Texinfo/*.pm, tp/Texinfo/Convert/*.pm: use the standard NOTES
header instead of DISCLAIMER in Pod.
---
ChangeLog | 10 ++++++++++
Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm | 20 ++++++++++++++++++--
Pod-Simple-Texinfo/pod2texi.pl | 2 +-
doc/pod2texi.texi | 4 ++--
tp/Texinfo/Common.pm | 2 +-
tp/Texinfo/Convert/Converter.pm | 2 +-
tp/Texinfo/Convert/DocBook.pm | 2 +-
tp/Texinfo/Convert/HTML.pm | 2 +-
tp/Texinfo/Convert/Info.pm | 2 +-
tp/Texinfo/Convert/NodeNameNormalization.pm | 2 +-
tp/Texinfo/Convert/Plaintext.pm | 2 +-
tp/Texinfo/Convert/Texinfo.pm | 2 +-
tp/Texinfo/Convert/TexinfoXML.pm | 2 +-
tp/Texinfo/Convert/Text.pm | 2 +-
tp/Texinfo/Convert/Unicode.pm | 2 +-
tp/Texinfo/Convert/Utils.pm | 2 +-
tp/Texinfo/Encoding.pm | 2 +-
tp/Texinfo/ParserNonXS.pm | 2 +-
tp/Texinfo/Report.pm | 2 +-
tp/Texinfo/Structuring.pm | 2 +-
tp/Texinfo/Transformations.pm | 2 +-
tp/Texinfo/Translations.pm | 2 +-
tp/maintain/template.pod | 2 +-
23 files changed, 50 insertions(+), 24 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 8dd39ee5ec..8f9f556f8b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2022-02-08 Patrice Dumas <pertusus@free.fr>
+
+ * Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm (_convert_pod)
+ (%standard_headers): prepend the module name to first level
+ section names only if in a list of standard headers taken
+ from perlpodstyle and perldocstyle.
+
+ * tp/Texinfo/*.pm, tp/Texinfo/Convert/*.pm: use the standard NOTES
+ header instead of DISCLAIMER in Pod.
+
2022-02-08 Patrice Dumas <pertusus@free.fr>
Include pod2texi Pod converted to Texinfo by pod2texi in manual
diff --git a/Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm
b/Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm
index 8591b2c8d7..4dc423042c 100644
--- a/Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm
+++ b/Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm
@@ -49,6 +49,21 @@ $VERSION = '0.01';
# perl -w -MPod::Simple::Texinfo -e Pod::Simple::Texinfo::go thingy.pod
sub go { Pod::Simple::Texinfo->parse_from_file(@ARGV); exit 0 }
+my %standard_headers;
+# from the main list of perlpodstyle
+foreach my $standard_header ('NAME', 'SYNOPSIS', 'DESCRIPTION', 'OPTIONS',
+ 'RETURN VALUE', 'ERRORS', 'DIAGNOSTICS', 'EXAMPLES', 'ENVIRONMENT',
+ 'FILES', 'CAVEATS', 'WARNINGS', 'BUGS', 'RESTRICTIONS', 'NOTES', 'AUTHOR',
+ 'AUTHORS', 'HISTORY', 'COPYRIGHT AND LICENSE', 'SEE ALSO',
+# additional text after the list.
+# 'CONFORMING TO' and 'MT-LEVEL' ignored as they seem to be very specific.
+ 'CONSTRUCTORS', 'METHODS', 'CLASS METHODS', 'INSTANCE METHODS', 'FUNCTIONS',
+ 'OVERVIEW',
+# from perldocstyle
+ 'CONTRIBUTORS', 'COPYRIGHT', 'LICENSE') {
+ $standard_headers{lc($standard_header)} = 1;
+}
+
my %pod_head_commands_level;
foreach my $level (1 .. 4) {
$pod_head_commands_level{'head'.$level} = $level;
@@ -682,7 +697,8 @@ sub _convert_pod($)
}
if ($pod_head_commands_level{$tagname}
- and $pod_head_commands_level{$tagname} == 1) {
+ and $pod_head_commands_level{$tagname} == 1
+ and $standard_headers{lc($result)}) {
# prepend the manual name for the top level texinfo section name
for
# internal manuals, otherwise the section name does not
# allow to understand which module the following text refers to,
@@ -902,7 +918,7 @@ parser.
L<Pod::Simple>. L<Pod::Simple::PullParser>. The Texinfo manual.
-=head1 COPYRIGHT
+=head1 COPYRIGHT AND LICENSE
Copyright (C) 2011, 2012 Free Software Foundation, Inc.
diff --git a/Pod-Simple-Texinfo/pod2texi.pl b/Pod-Simple-Texinfo/pod2texi.pl
index ca17645e27..9668371988 100755
--- a/Pod-Simple-Texinfo/pod2texi.pl
+++ b/Pod-Simple-Texinfo/pod2texi.pl
@@ -617,7 +617,7 @@ Display version information and exit.
L<Pod::Simple::Texinfo>. L<perlpod>. The Texinfo manual.
Texinfo home page: L<http://www.gnu.org/software/texinfo/>
-=head1 COPYRIGHT
+=head1 COPYRIGHT AND LICENSE
Copyright 2012-2022 Free Software Foundation, Inc.
diff --git a/doc/pod2texi.texi b/doc/pod2texi.texi
index 6c4feafcb3..12ee5296d0 100644
--- a/doc/pod2texi.texi
+++ b/doc/pod2texi.texi
@@ -128,8 +128,8 @@ Display version information and exit.
@ref{,,, Pod-Simple-Texinfo}. @ref{,,, perlpod}. The Texinfo manual.
Texinfo home page: @url{http://www.gnu.org/software/texinfo/}
-@subsubheading pod2texi COPYRIGHT
-@anchor{pod2texi COPYRIGHT}
+@subsubheading pod2texi COPYRIGHT AND LICENSE
+@anchor{pod2texi COPYRIGHT AND LICENSE}
Copyright 2012-2022 Free Software Foundation, Inc.
diff --git a/tp/Texinfo/Common.pm b/tp/Texinfo/Common.pm
index 42d24d3636..1a7894c806 100644
--- a/tp/Texinfo/Common.pm
+++ b/tp/Texinfo/Common.pm
@@ -2788,7 +2788,7 @@ Texinfo::Common - Classification of commands and
miscellaneous methods
print STDERR "$a_command is an accent command\n";
}
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Converter.pm b/tp/Texinfo/Convert/Converter.pm
index 497ad06586..beadacd46b 100644
--- a/tp/Texinfo/Convert/Converter.pm
+++ b/tp/Texinfo/Convert/Converter.pm
@@ -1627,7 +1627,7 @@ Texinfo::Convert::Converter - Parent class for Texinfo
tree converters
{'parser' => $parser});
$converter->output($texinfo_tree);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/DocBook.pm b/tp/Texinfo/Convert/DocBook.pm
index a75f1b5d36..8b71221f55 100644
--- a/tp/Texinfo/Convert/DocBook.pm
+++ b/tp/Texinfo/Convert/DocBook.pm
@@ -1485,7 +1485,7 @@ Texinfo::Convert::DocBook - Convert Texinfo tree to
DocBook
$converter->convert($tree);
$converter->convert_tree($tree);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/HTML.pm b/tp/Texinfo/Convert/HTML.pm
index a70f96e31e..6225a897fc 100644
--- a/tp/Texinfo/Convert/HTML.pm
+++ b/tp/Texinfo/Convert/HTML.pm
@@ -10184,7 +10184,7 @@ Texinfo::Convert::HTML - Convert Texinfo tree to HTML
$converter->convert_tree($tree);
$converter->output_internal_links(); # HTML only
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Info.pm b/tp/Texinfo/Convert/Info.pm
index 3f162be8c6..7de96d0c7c 100644
--- a/tp/Texinfo/Convert/Info.pm
+++ b/tp/Texinfo/Convert/Info.pm
@@ -578,7 +578,7 @@ Texinfo::Convert::Info - Convert Texinfo tree to Info
$converter->convert($tree);
$converter->convert_tree($tree);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/NodeNameNormalization.pm
b/tp/Texinfo/Convert/NodeNameNormalization.pm
index 91ec62dfab..7d78a24a75 100644
--- a/tp/Texinfo/Convert/NodeNameNormalization.pm
+++ b/tp/Texinfo/Convert/NodeNameNormalization.pm
@@ -371,7 +371,7 @@ Texinfo::Convert::NodeNameNormalization - Normalize and
transliterate Texinfo tr
my $file_name = transliterate_texinfo({'contents'
=> $section_contents});
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Plaintext.pm b/tp/Texinfo/Convert/Plaintext.pm
index 59eb55ea81..187a100769 100644
--- a/tp/Texinfo/Convert/Plaintext.pm
+++ b/tp/Texinfo/Convert/Plaintext.pm
@@ -3325,7 +3325,7 @@ Texinfo::Convert::Plaintext - Convert Texinfo tree to
Plaintext
$converter->convert($tree);
$converter->convert_tree($tree);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Texinfo.pm b/tp/Texinfo/Convert/Texinfo.pm
index 38222cae60..44ef52554b 100644
--- a/tp/Texinfo/Convert/Texinfo.pm
+++ b/tp/Texinfo/Convert/Texinfo.pm
@@ -249,7 +249,7 @@ Texinfo::Convert::Texinfo - Convert a Texinfo tree to
Texinfo code
my $texinfo_text = convert_to_texinfo($tree);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/TexinfoXML.pm b/tp/Texinfo/Convert/TexinfoXML.pm
index 5ef491e7ef..8d1ebda082 100644
--- a/tp/Texinfo/Convert/TexinfoXML.pm
+++ b/tp/Texinfo/Convert/TexinfoXML.pm
@@ -1729,7 +1729,7 @@ Texinfo::Convert::TexinfoXML - Convert Texinfo tree to
TexinfoXML
$converter->convert($tree);
$converter->convert_tree($tree);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Text.pm b/tp/Texinfo/Convert/Text.pm
index da7df8264a..f3b44083f1 100644
--- a/tp/Texinfo/Convert/Text.pm
+++ b/tp/Texinfo/Convert/Text.pm
@@ -833,7 +833,7 @@ Texinfo::Convert::Text - Convert Texinfo tree to simple text
my $result_accent_text = ascii_accent('e', $accent_command);
my $accents_text = text_accents($accents, 'utf-8');
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Unicode.pm b/tp/Texinfo/Convert/Unicode.pm
index 290352cbdc..d43b3c7671 100644
--- a/tp/Texinfo/Convert/Unicode.pm
+++ b/tp/Texinfo/Convert/Unicode.pm
@@ -1592,7 +1592,7 @@ Texinfo::Convert::Unicode - Representation as Unicode
characters
my $accent_text = unicode_accent('e', $accent_command);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Convert/Utils.pm b/tp/Texinfo/Convert/Utils.pm
index 0bfa149df9..bc79df3abb 100644
--- a/tp/Texinfo/Convert/Utils.pm
+++ b/tp/Texinfo/Convert/Utils.pm
@@ -314,7 +314,7 @@ Texinfo::Convert::Utils - miscellaneous functions usable in
all converters
my $verbatiminclude_tree
= expand_verbatiminclude(undef, $converter, $verbatiminclude);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Encoding.pm b/tp/Texinfo/Encoding.pm
index 1046bf872c..67e33d410f 100644
--- a/tp/Texinfo/Encoding.pm
+++ b/tp/Texinfo/Encoding.pm
@@ -106,7 +106,7 @@ Texinfo::Encoding - Encodings and encoding aliases
my ($canonical_texinfo_encoding, $perl_encoding,
$canonical_output_encoding) = encoding_alias($encoding);
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/ParserNonXS.pm b/tp/Texinfo/ParserNonXS.pm
index b2f73ab029..4c581a629d 100644
--- a/tp/Texinfo/ParserNonXS.pm
+++ b/tp/Texinfo/ParserNonXS.pm
@@ -5996,7 +5996,7 @@ Texinfo::Parser - Parse Texinfo code into a Perl tree
# input file name, dircategory and direntry list, for example).
my $global_information = $parser->global_information();
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Report.pm b/tp/Texinfo/Report.pm
index 49ffb66708..833403a138 100644
--- a/tp/Texinfo/Report.pm
+++ b/tp/Texinfo/Report.pm
@@ -236,7 +236,7 @@ Texinfo::Report - Error storing for Texinfo modules
warn $error_message->{'error_line'};
}
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Structuring.pm b/tp/Texinfo/Structuring.pm
index 389db82149..6eaa853d1e 100644
--- a/tp/Texinfo/Structuring.pm
+++ b/tp/Texinfo/Structuring.pm
@@ -1737,7 +1737,7 @@ Texinfo::Structuring - information on Texinfo::Parser tree
}
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Transformations.pm b/tp/Texinfo/Transformations.pm
index 50c73a0451..ad52c3c56e 100644
--- a/tp/Texinfo/Transformations.pm
+++ b/tp/Texinfo/Transformations.pm
@@ -846,7 +846,7 @@ __END__
Texinfo::Transformations - transformations of Texinfo Perl tree
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/Texinfo/Translations.pm b/tp/Texinfo/Translations.pm
index 97928b6550..e0fea7ab6f 100644
--- a/tp/Texinfo/Translations.pm
+++ b/tp/Texinfo/Translations.pm
@@ -413,7 +413,7 @@ Texinfo::Translations - Translations of output documents
strings for Texinfo mod
'book' => {'text' => $book_name}});
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
diff --git a/tp/maintain/template.pod b/tp/maintain/template.pod
index a7838e555e..b03d65d572 100644
--- a/tp/maintain/template.pod
+++ b/tp/maintain/template.pod
@@ -14,7 +14,7 @@ Texinfo::Convert::OUTFORMAT - Convert Texinfo tree to
OUTFORMAT
$converter->convert_tree($tree);
__HTML $converter->output_internal_links(); # HTML only
-=head1 DISCLAIMER
+=head1 NOTES
The Texinfo Perl module main purpose is to be used in C<texi2any> to convert
Texinfo to other formats. There is no promise of API stability.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm (_convert_pod) (%standard_headers): prepend the module name to first level section names only if in a list of standard headers taken from perlpodstyle and perldocstyle.,
Patrice Dumas <=