[no subject]

[Patrice Dumas]

branch: master
commit 3b7691603511e9d2f416f07a3141c18da07ae497
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Jan 27 20:37:29 2024 +0100

    * doc/texinfo.texi (Invoking @command{texi2any})
    (Customization Variables and Options), tp/Texinfo/options_data.txt,
    tp/texi2any.pl: rename SHOW_INCLUDE_FILE_PATHS as TRACE_INCLUDES
    and add --trace-includes command-line option.  Name from Gavin.
---
 ChangeLog                   | 7 +++++++
 doc/texinfo.texi            | 9 +++++++++
 tp/TODO                     | 3 ---
 tp/Texinfo/options_data.txt | 2 +-
 tp/texi2any.pl              | 5 ++++-
 5 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 24ba500a12..bb5ae044c8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2024-01-27  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texinfo.texi (Invoking @command{texi2any})
+       (Customization Variables and Options), tp/Texinfo/options_data.txt,
+       tp/texi2any.pl: rename SHOW_INCLUDE_FILE_PATHS as TRACE_INCLUDES
+       and add --trace-includes command-line option.  Name from Gavin.
+
 2024-01-27  Patrice Dumas  <pertusus@free.fr>
 
        * tp/texi2any.pl: avoid \n in translated strings, split each option in
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 8031d1feee..4fd7a4f115 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -15151,6 +15151,13 @@ Keep Info files to at most @var{num} characters if 
possible; default
 is 300,000.  (However, a single node will never be split across Info
 files.)
 
+@item --trace-includes
+@opindex --trace-includes
+@vindex TRACE_INCLUDES
+Instead of generating an output format, show directly and indirectly
+included file paths, taking into account @option{-I}.  An include file
+is shown only if found.  Each included file is output on a line.
+
 @item --transliterate-file-names
 @opindex --transliterate-file-names
 @vindex TRANSLITERATE_FILE_NAMES
@@ -15452,6 +15459,8 @@ meaning of the options.
 @item
 @option{--split-size}        @tab @code{SPLIT_SIZE}
 @item
+@option{--trace-includes}    @tab @code{TRACE_INCLUDES}
+@item
 @option{--transliterate-file-names} @tab @code{TRANSLITERATE_FILE_NAMES}
 @item
 @option{--verbose}           @tab @code{VERBOSE}
diff --git a/tp/TODO b/tp/TODO
index 9a7eec76d3..f2197e999a 100644
--- a/tp/TODO
+++ b/tp/TODO
@@ -10,9 +10,6 @@ This is the todo list for texi2any
 Before next release
 ===================
 
-Ask on mailing list what the interface to include paths list should
-be.  Depending on the issue, document SHOW_INCLUDE_FILE_PATHS.
-
 
 Bugs
 ====
diff --git a/tp/Texinfo/options_data.txt b/tp/Texinfo/options_data.txt
index 56369ff4b1..09046c7201 100644
--- a/tp/Texinfo/options_data.txt
+++ b/tp/Texinfo/options_data.txt
@@ -156,10 +156,10 @@ CHECK_MISSING_MENU_ENTRY     program_customization 1      
   integer
 DUMP_TREE                    program_customization undef     integer
 DUMP_TEXI                    program_customization undef     integer
 SHOW_BUILTIN_CSS_RULES       program_customization 0         integer
-SHOW_INCLUDE_FILE_PATHS      program_customization 0         integer
 SORT_ELEMENT_COUNT           program_customization undef     char
 SORT_ELEMENT_COUNT_WORDS     program_customization undef     integer
 TEXI2DVI                     program_customization texi2dvi  char
+TRACE_INCLUDES               program_customization 0         integer
 TREE_TRANSFORMATIONS         program_customization undef     char
 
 
diff --git a/tp/texi2any.pl b/tp/texi2any.pl
index 4115fb9bf6..e44900cedb 100755
--- a/tp/texi2any.pl
+++ b/tp/texi2any.pl
@@ -791,6 +791,8 @@ the behavior is identical, and does not depend on the 
installed name.\n")
 .__("      --init-file=FILE        load FILE to modify the default 
behavior.")."\n"
 .__("  -c, --set-customization-variable VAR=VAL  set customization variable VAR
                                 to value VAL.")."\n"
+.__("      --trace-includes        instead of generating an output format
+                                show included files.")."\n"
 .__("  -v, --verbose               explain what is being done.")."\n"
 .__("      --version               display version information and exit.")."\n"
 ."\n";
@@ -1073,6 +1075,7 @@ There is NO WARRANTY, to the extent permitted by 
law.\n"), "2023");
                      },
  'disable-encoding' => sub {set_from_cmdline('ENABLE_ENCODING', 0);
                      },
+ 'trace-includes' => sub {set_from_cmdline('TRACE_INCLUDES', 1);},
  'internal-links=s' => sub {set_from_cmdline('INTERNAL_LINKS', $_[1]);},
  'force|F' => sub {set_from_cmdline('FORCE', $_[1]);},
  'commands-in-node-names' => sub { ;},
@@ -1504,7 +1507,7 @@ while(@input_files) {
   }
 
   my $document_information = $document->global_information();
-  if (get_conf('SHOW_INCLUDE_FILE_PATHS')) {
+  if (get_conf('TRACE_INCLUDES')) {
     handle_errors($registrar, $error_count, \@opened_files);
     my $included_file_paths = $document_information->{'included_files'};
     if (defined($included_file_paths)) {