branch master updated: Rename $index_entries_keys as $index_entries_sort_strings.

[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 68c5a44  Rename $index_entries_keys as $index_entries_sort_strings.
68c5a44 is described below

commit 68c5a4447f25c4a985b401ef97d1c5f5f7b92138
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Sep 4 22:47:03 2021 +0200

    Rename $index_entries_keys as $index_entries_sort_strings.
---
 tp/Texinfo/Convert/HTML.pm      |  8 ++++----
 tp/Texinfo/Convert/IXIN.pm      |  2 +-
 tp/Texinfo/Convert/Plaintext.pm |  4 ++--
 tp/Texinfo/Structuring.pm       | 12 ++++++------
 tp/init/chm.pm                  |  2 +-
 tp/t/test_sort.t                |  8 ++++----
 tp/t/test_utils.pl              |  4 ++--
 7 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/tp/Texinfo/Convert/HTML.pm b/tp/Texinfo/Convert/HTML.pm
index cefbe08..9d8af02 100644
--- a/tp/Texinfo/Convert/HTML.pm
+++ b/tp/Texinfo/Convert/HTML.pm
@@ -6121,10 +6121,10 @@ sub _prepare_index_entries($)
     $self->{'index_names'} = $index_names;
     my $merged_index_entries 
         = Texinfo::Structuring::merge_indices($index_names);
-    my $index_entries_keys;
-    ($self->{'index_entries_by_letter'}, $index_entries_keys)
-      = Texinfo::Structuring::sort_indices($self->{'parser'}, $self,
-                          $self, $merged_index_entries, 'by_letter');
+    my $index_entries_sort_strings;
+    ($self->{'index_entries_by_letter'}, $index_entries_sort_strings)
+            = Texinfo::Structuring::sort_indices($self->{'parser'}, $self,
+                               $self, $merged_index_entries, 'by_letter');
     $self->{'index_entries'} = $merged_index_entries;
 
     foreach my $index_name (sort(keys(%$index_names))) {
diff --git a/tp/Texinfo/Convert/IXIN.pm b/tp/Texinfo/Convert/IXIN.pm
index b2d883f..87b6e42 100644
--- a/tp/Texinfo/Convert/IXIN.pm
+++ b/tp/Texinfo/Convert/IXIN.pm
@@ -612,7 +612,7 @@ sub output_ixin($$)
     my $index_names = $self->{'parser'}->indices_information();
     my $merged_index_entries
         = Texinfo::Structuring::merge_indices($index_names);
-    my ($entries, $index_entries_keys)
+    my ($entries, $index_entries_sort_strings)
       = $self->Texinfo::Structuring::sort_indices($self->{'parser'}, $self,
                                               $self, $merged_index_entries);
     # first do the dts_text as the counts are needed for the dts index
diff --git a/tp/Texinfo/Convert/Plaintext.pm b/tp/Texinfo/Convert/Plaintext.pm
index 13cc761..a773b6b 100644
--- a/tp/Texinfo/Convert/Plaintext.pm
+++ b/tp/Texinfo/Convert/Plaintext.pm
@@ -1192,8 +1192,8 @@ sub _printindex_formatted($$;$)
     my $index_names = $self->{'parser'}->indices_information();
     my $merged_index_entries 
       = Texinfo::Structuring::merge_indices($index_names);
-    my $index_entries_keys;
-    ($self->{'index_entries'}, $index_entries_keys)
+    my $index_entries_sort_strings;
+    ($self->{'index_entries'}, $index_entries_sort_strings)
       = Texinfo::Structuring::sort_indices($self->{'parser'}, $self, $self,
                                            $merged_index_entries);
     $self->{'index_names'} = $index_names;
diff --git a/tp/Texinfo/Structuring.pm b/tp/Texinfo/Structuring.pm
index c0763fa..85f8fc1 100644
--- a/tp/Texinfo/Structuring.pm
+++ b/tp/Texinfo/Structuring.pm
@@ -1667,7 +1667,7 @@ sub sort_indices($$$$;$)
   my ($options, $ignore_chars) = setup_index_entry_keys_formatting($self,
                                              $configuration_informations);
   my $sorted_index_entries;
-  my $index_entry_keys = {};
+  my $index_entries_sort_strings = {};
   foreach my $index_name (keys(%$index_entries)) {
     # used if not $sort_by_letter
     my $sortable_index_entries = [];
@@ -1676,7 +1676,7 @@ sub sort_indices($$$$;$)
     foreach my $entry (@{$index_entries->{$index_name}}) {
       my $entry_key = index_key($entry, {'contents' => $entry->{'content'}},
                                   $entry->{'sortas'}, $options, $ignore_chars);
-      $index_entry_keys->{$entry} = $entry_key;
+      $index_entries_sort_strings->{$entry} = $entry_key;
       if ($entry_key !~ /\S/) {
         $registrar->line_warn($configuration_informations,
                      sprintf(__("empty index key in \@%s"),
@@ -1709,7 +1709,7 @@ sub sort_indices($$$$;$)
           sort _sort_index_entries @{$sortable_index_entries};
     }
   }
-  return $sorted_index_entries, $index_entry_keys;
+  return $sorted_index_entries, $index_entries_sort_strings;
 }
 
 sub merge_indices($)
@@ -2101,7 +2101,7 @@ The I<$merged_entries> returned is a hash reference whose
 keys are the index names and values arrays of index entry structures
 described in details in L<Texinfo::Parser/index_entries>.
 
-=item ($index_entries_sorted, $index_entry_keys) = sort_indices($parser, 
$registrar, $configuration_informations, $merged_index_entries, $sort_by_letter)
+=item ($index_entries_sorted, $index_entries_sort_strings) = 
sort_indices($parser, $registrar, $configuration_informations, 
$merged_index_entries, $sort_by_letter)
 
 If C<$sort_by_letter> is set, sort by letter, otherwise sort all
 entries together.  In both cases, a hash reference with index names
@@ -2115,8 +2115,8 @@ reference of sorted index entries beginning with the 
letter.
 When simply sorting, the array of the sorted index entries is associated
 with the index name.
 
-C<$index_entry_keys> is a hash reference associating the index entries
-with the key that were used to sort them.
+C<$index_entries_sort_strings> is a hash reference associating the index
+entries with the strings that were used to sort them.
 
 Register errors in C<$registrar>.
 
diff --git a/tp/init/chm.pm b/tp/init/chm.pm
index f11f50f..eea117b 100644
--- a/tp/init/chm.pm
+++ b/tp/init/chm.pm
@@ -242,7 +242,7 @@ sub chm_init($)
   }
   print $hhk_fh "</OBJECT>\n";
 
-  my ($index_entries, $index_entries_keys)
+  my ($index_entries, $index_entries_sort_strings)
        = Texinfo::Structuring::sort_indices($self->{'parser'},
                                     $self, $self, $self->{'index_entries'});
   if ($index_entries) {
diff --git a/tp/t/test_sort.t b/tp/t/test_sort.t
index 604470f..dd65388 100644
--- a/tp/t/test_sort.t
+++ b/tp/t/test_sort.t
@@ -48,13 +48,13 @@ my $parser_informations = $parser->global_informations();
 # holding only configuration that is not a parser
 $parser->{'OUTPUT_ENCODING_NAME'} = 
$parser_informations->{'input_encoding_name'};
 $parser->{'ENABLE_ENCODING'} = 1;
-my ($sorted_index_entries, $index_entries_keys)
+my ($sorted_index_entries, $index_entries_sort_strings)
   = Texinfo::Structuring::sort_indices($parser, $registrar, $parser,
                                        $index_entries);
 
 my @entries = ();
 foreach my $entry (@{$sorted_index_entries->{'cp'}}) {
-  push @entries, $index_entries_keys->{$entry};
+  push @entries, $index_entries_sort_strings->{$entry};
 }
 
 use utf8;
@@ -64,7 +64,7 @@ my @entries_ref = ('!', '"', 'aaaaaaaaaaaa', 'e', 'E', 'ł', 
'ẽ');
 
 cmp_deeply (\@entries, \@entries_ref, 'sorted index entries');
 
-my ($sorted_index_entries_by_letter, $by_letter_index_entries_keys)
+my ($sorted_index_entries_by_letter, $by_letter_index_entries_sort_strings)
   = Texinfo::Structuring::sort_indices($parser, $parser, $parser,
                                        $index_entries, 'by_letter');
 
@@ -83,7 +83,7 @@ foreach my $letter 
(@{$sorted_index_entries_by_letter->{'cp'}}) {
   push @letter_entries, $letter_entry;
   foreach my $entry (@{$letter->{'entries'}}) {
     push @{$letter_entry->{$letter->{'letter'}}},
-      $by_letter_index_entries_keys->{$entry};
+      $by_letter_index_entries_sort_strings->{$entry};
   }
 }
 
diff --git a/tp/t/test_utils.pl b/tp/t/test_utils.pl
index b20c264..12729b6 100644
--- a/tp/t/test_utils.pl
+++ b/tp/t/test_utils.pl
@@ -910,9 +910,9 @@ sub test($$)
   $indices->{'index_names'} = $trimmed_index_names
     unless (Data::Compare::Compare($trimmed_index_names, 
$initial_index_names));
 
-  my ($sorted_index_entries, $index_entries_keys);
+  my ($sorted_index_entries, $index_entries_sort_strings);
   if ($merged_index_entries) {
-    ($sorted_index_entries, $index_entries_keys)
+    ($sorted_index_entries, $index_entries_sort_strings)
       = Texinfo::Structuring::sort_indices($parser, $registrar,
                                    $main_configuration,
                                    $merged_index_entries, 'by_letter');