branch master updated: Update Pod Texinfo Perl modules documentation

[Patrice Dumas]

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 5719a55c15 Update Pod Texinfo Perl modules documentation
5719a55c15 is described below

commit 5719a55c150ee070733743c9117190bfb7d07ae2
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Oct 8 22:48:20 2022 +0200

    Update Pod Texinfo Perl modules documentation
---
 doc/customization_api.texi    | 6 +++---
 tp/Texinfo/Commands.pod       | 6 +++---
 tp/Texinfo/Common.pm          | 4 ++--
 tp/Texinfo/Convert/Unicode.pm | 5 +++--
 tp/Texinfo/ParserNonXS.pm     | 4 ++--
 tp/Texinfo/Transformations.pm | 2 +-
 tp/Texinfo/Translations.pm    | 4 ++--
 7 files changed, 16 insertions(+), 15 deletions(-)

diff --git a/doc/customization_api.texi b/doc/customization_api.texi
index d887fa292c..b24eb237d7 100644
--- a/doc/customization_api.texi
+++ b/doc/customization_api.texi
@@ -2443,14 +2443,14 @@ Returns an array containing the block preformatted 
@@-commands such as
 @@ and the HTML attribute class preformatted container names, in order of 
appearance.
 @end deftypefun
 
-The @code{%Texinfo::Common::preformatted_code_commands}
+The @code{%Texinfo::Commands::preformatted_code_commands}
 hash can be used to determine if a preformatted command is to be formatted
-as code (@pxref{Texinfo::Common %preformatted_code_commands,,,tp_api}).
+as code (@pxref{Texinfo::Commands %preformatted_code_commands,,,tp_api}).
 
 @example
 my @@pre_classes = $converter->preformatted_classes_stack();
 foreach my $pre_class (@@pre_classes) @{
-  if ($Texinfo::Common::preformatted_code_commands@{$pre_class@}) @{
+  if ($Texinfo::Commands::preformatted_code_commands@{$pre_class@}) @{
     $result = '<code>' .$result. '</code>';
     last;
   @}
diff --git a/tp/Texinfo/Commands.pod b/tp/Texinfo/Commands.pod
index 133f672e52..c1265ebc9d 100644
--- a/tp/Texinfo/Commands.pod
+++ b/tp/Texinfo/Commands.pod
@@ -5,7 +5,7 @@ Texinfo::Commands - Classification of commands
 =head1 SYNOPSIS
 
   use Texinfo::Commands;
-  if ($Texinfo::Common::accent_commands{$a_command}) {
+  if ($Texinfo::Commands::accent_commands{$a_command}) {
     print STDERR "$a_command is an accent command\n";
   }
 
@@ -16,7 +16,7 @@ Texinfo to other formats.  There is no promise of API 
stability.
 
 =head1 DESCRIPTION
 
-Texinfo::Common holds a few hashes with information on @-commands 
+Texinfo::Commands holds a few hashes with information on @-commands
 and hashes classifying Texinfo @-commands.
 
 =head1 @-COMMAND INFORMATION
@@ -189,7 +189,7 @@ X<C<%nobrace_commands>>
 
 Command that do not take braces, do not have argument on their line and
 are not block commands either.  The value is I<symbol> for single character
-non-alphabetical @-commands such as C<@@>, C<@ > or @C<@:>.  Other commands in 
that hash
+non-alphabetical @-commands such as C<@@>, C<@ > or C<@:>.  Other commands in 
that hash
 include C<@indent>, C<@tab> or C<@thissection>.
 
 Note that C<@item> is in C<%nobrace_commands> for its role in C<@multitable>,
diff --git a/tp/Texinfo/Common.pm b/tp/Texinfo/Common.pm
index 332e0743aa..de7bf356a9 100644
--- a/tp/Texinfo/Common.pm
+++ b/tp/Texinfo/Common.pm
@@ -1161,7 +1161,7 @@ sub locate_include_file($$)
   #print STDERR "$customization_information $input_file_path ".
   # @{$customization_information->get_conf('INCLUDE_DIRECTORIES')}\n";
   # If the path is absolute or begins with . or .., do not search in
-  # include directories.
+  # include directories.  This is consistent with Kpathsea for Texinfo TeX.
   if (File::Spec->file_name_is_absolute($input_file_path)) {
     $ignore_include_directories = 1;
   } else {
@@ -2618,7 +2618,7 @@ check the element itself, in addition to the parent 
context.
 Encode the I<$file_name> text string to a binary string I<$encoded_file_name>
 based on I<$input_encoding>.  Also returns the I<$encoding> name actually
 used which may have undergone some normalization.  This function is mostly
-a wrapper around L<Encode::encode> which avoids calling the module if not
+a wrapper around L<Encode::encode|Encode/encode> which avoids calling the 
module if not
 needed.  Do nothing if I<$input_encoding> is C<undef>.
 
 =item $text = enumerate_item_representation($specification, $number)
diff --git a/tp/Texinfo/Convert/Unicode.pm b/tp/Texinfo/Convert/Unicode.pm
index a135f83900..fc83a381a3 100644
--- a/tp/Texinfo/Convert/Unicode.pm
+++ b/tp/Texinfo/Convert/Unicode.pm
@@ -1642,7 +1642,7 @@ X<C<brace_no_arg_command>>
 
 Return the Unicode representation of a command with brace and no argument
 I<$command_name> (like C<@bullet{}>, C<@aa{}> or C<@guilsinglleft{}>),
-or C<undef> if there the Unicode representation cannot be converted to encoding
+or C<undef> if the Unicode representation cannot be converted to encoding
 I<$encoding>.
 
 =item $possible_conversion = check_unicode_point_conversion($arg, 
$output_debug)
@@ -1701,7 +1701,8 @@ X<C<unicode_point_decoded_in_encoding>>
 Return true if the I<$unicode_point> will be encoded in the encoding
 I<$encoding>.  The I<$unicode_point> should be specified as a four letter
 string describing an hexadecimal number with letters in upper case
-(such as C<201D>).
+(such as C<201D>).  Tables are used to determine if the I<$unicode_point>
+will be encoded, when the encoding does not cover the whole Unicode range.
 
 If the encoding is not supported in Texinfo, the result will always be false.
 
diff --git a/tp/Texinfo/ParserNonXS.pm b/tp/Texinfo/ParserNonXS.pm
index e02f1f3ee4..89a7e9f097 100644
--- a/tp/Texinfo/ParserNonXS.pm
+++ b/tp/Texinfo/ParserNonXS.pm
@@ -6966,7 +6966,7 @@ The user macro name the @-command is expanded from.
 =item extra
 
 A hash reference holding any other information.
-See L</Information available in the extra key>.
+See L</Information available in the C<extra> key>.
 
 =back
 
@@ -7539,7 +7539,7 @@ I<code> is set depending on the context and 
C<@kbdinputstyle>.
 I<invalid_syntax> is set if there was an error on the C<@macro>
 line.  I<arg_line> holds the line after C<@macro>.
 
-=item <menu_entry>
+=item C<menu_entry>
 
 The I<menu_entry_description> and I<menu_entry_name> keys
 are associated with the corresponding tree elements. The
diff --git a/tp/Texinfo/Transformations.pm b/tp/Texinfo/Transformations.pm
index 7136dea511..9ab3ead39b 100644
--- a/tp/Texinfo/Transformations.pm
+++ b/tp/Texinfo/Transformations.pm
@@ -1000,7 +1000,7 @@ C<get_conf>.  If both I<$registrar> and 
I<$customization_information> are
 defined they are used for error reporting in case an hash character could not
 be protected because it appeared in a raw environment.
 
-=item $modified_tree reference_to_arg_in_tree($tree)
+=item $modified_tree = reference_to_arg_in_tree($tree)
 X<C<reference_to_arg_in_tree>>
 
 Modify I<$tree> by converting reference @-commands to simple text using one of
diff --git a/tp/Texinfo/Translations.pm b/tp/Texinfo/Translations.pm
index d4c819cb3a..fb98164cd1 100644
--- a/tp/Texinfo/Translations.pm
+++ b/tp/Texinfo/Translations.pm
@@ -28,7 +28,7 @@ use Locale::Messages;
 
 # note that there is a circular dependency with the parser module, as
 # the parser uses complete_indices() from this modules, while this modules
-# can use a parser.  There is not problematic, however, as the
+# can use a parser.  This is not problematic, however, as the
 # modules do not setup data such that their order of loading is not
 # important, as long as they load after their dependencies.
 
@@ -420,7 +420,7 @@ Texinfo to other formats.  There is no promise of API 
stability.
 The C<Texinfo::Translations> module helps with translations
 in output documents.
 
-Translation of error messages uses another interface which
+Translation of error messages uses another interface, which
 is the classical gettext based perl interface.  It is not
 described as it is described in details elsewhere, some
 elements are in L<Texinfo::Common C<__> and 
C<__p>|Texinfo::Common/$translated_string = __($msgid)>.