texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

branch master updated: * doc/refcard/txivarcheck (read_refman), util/txi


From: Patrice Dumas
Subject: branch master updated: * doc/refcard/txivarcheck (read_refman), util/txicustomvars: get customization variables from "Invoking \@command{texi2any}" node too in txivarcheck, and output program_cmdline_options and converter_cmdline_options in txicustomvars.
Date: Sat, 06 Apr 2024 07:42:07 -0400

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 fdc9653fa8 * doc/refcard/txivarcheck (read_refman), 
util/txicustomvars: get customization variables from "Invoking 
\@command{texi2any}" node too in txivarcheck, and output 
program_cmdline_options and converter_cmdline_options in txicustomvars.
fdc9653fa8 is described below

commit fdc9653fa8adf13ad3da1eef8611f87354464079
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Apr 6 13:41:58 2024 +0200

    * doc/refcard/txivarcheck (read_refman), util/txicustomvars: get
    customization variables from "Invoking \@command{texi2any}" node too
    in txivarcheck, and output program_cmdline_options and
    converter_cmdline_options in txicustomvars.
    
    * doc/refcard/txivarcheck (read_tp): filter out the 'SILENT'
    customization variable that is not interesting to document as it does
    nothing, and the customization variables starting with XS_ that are
    not documented on purpose.
---
 ChangeLog               | 12 ++++++++++++
 doc/refcard/txivarcheck | 30 +++++++++++++++++++++---------
 util/txicustomvars      |  2 ++
 3 files changed, 35 insertions(+), 9 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index ffed88e2d3..7575203169 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2024-04-06  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/refcard/txivarcheck (read_refman), util/txicustomvars: get
+       customization variables from "Invoking \@command{texi2any}" node too
+       in txivarcheck, and output program_cmdline_options and
+       converter_cmdline_options in txicustomvars.
+
+       * doc/refcard/txivarcheck (read_tp): filter out the 'SILENT'
+       customization variable that is not interesting to document as it does
+       nothing, and the customization variables starting with XS_ that are
+       not documented on purpose.
+
 2024-04-06  Patrice Dumas  <pertusus@free.fr>
 
        * doc/texinfo.texi (Other Formats Customization Variables): add
diff --git a/doc/refcard/txivarcheck b/doc/refcard/txivarcheck
index dd6eb139d9..1e3502cd6e 100755
--- a/doc/refcard/txivarcheck
+++ b/doc/refcard/txivarcheck
@@ -87,9 +87,9 @@ sub main {
 
 
 
-# Return customization variable names from the section in the reference
-# manual.  We assume their names are all uppercase, to avoid returning
-# numerous non-variables.
+# Return customization variable names from the relevant sections in
+# the reference manual.  We assume their names are all uppercase, to
+# avoid returning numerous non-variables.
 #
 sub read_refman {
   my ($fname) = @_;
@@ -100,10 +100,10 @@ sub read_refman {
   my $FILE = $fname;
   open (FILE, $FILE) || die "open($FILE) failed: $!";
 
-  # since we have to look at generic commands like @item, at least
-  # ignore until right section to reduce chance of false matches.
+  # since we have to look at generic commands like @item, ignore until
+  # the first relevant section to reduce chance of false matches.
   while (<FILE>) {
-    last if /^\@section Customization Variables$/;
+    last if /^\@section Invoking \@command{texi2any} from a Shell$/;
   }
 
   while (<FILE>) {
@@ -124,14 +124,22 @@ sub read_refman {
       next;
     }
 
+    # end of section with command-line customization variables
+    if (/^\@section Environment Variables Recognized by \@command{texi2any}/) {
+      # Skip to next relevant node
+      while (<FILE>) {
+        last if /^\@section Customization Variables$/;
+      }
+    }
+
+    # end of main section on customization variables
     if (/^\@node Internationalization of Document Strings/) {
-      # Skip to next node
+      # Skip to next relevant node
       while (<FILE>) {
         last if /^\@section HTML Output Customization/;
       }
     }
 
-
     # Stop looking for cust.var names after those nodes are done.
     last if /^\@node Command Syntax/;
 
@@ -163,7 +171,11 @@ sub read_tp {
     chomp;
 
     my $var = $_;
-    next if $var eq "OUTPUT_PERL_ENCODING";  # not for users
+    # not for users
+    next if ($var eq "OUTPUT_PERL_ENCODING"
+             or $var =~ /^XS_/
+             # not interesting to document/classify
+             or $var eq "SILENT");
 
     push (@ret, $var);
   }
diff --git a/util/txicustomvars b/util/txicustomvars
index 6151645ebe..3bd5bf2563 100755
--- a/util/txicustomvars
+++ b/util/txicustomvars
@@ -52,5 +52,7 @@ my @parser_string_non_command_customization
 
 print join("\n",
      sort(@parser_string_non_command_customization,
+          keys(%Texinfo::Options::program_cmdline_options),
+          keys(%Texinfo::Options::converter_cmdline_options),
           keys(%Texinfo::Options::program_customization_options),
           keys(%Texinfo::Options::converter_customization_options)));



reply via email to

[Prev in Thread] Current Thread [Next in Thread]