[no subject]

[Patrice Dumas]

branch: master
commit 8314c4e793689939a52d7eae7fe7d36604162236
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sun Nov 19 11:50:56 2023 +0100

    * INSTALL: document TEXINFO_XS_STRUCTURE and TEXINFO_XS_CONVERT use.
---
 ChangeLog |  4 ++++
 INSTALL   | 22 +++++++++++++++++-----
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 343447d0a5..8db7f7b3bc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -3,6 +3,10 @@
        * tp/texi2any.supp: Add variant suppression specification
        for setenv error.
 
+2023-11-19  Patrice Dumas  <pertusus@free.fr>
+
+       * INSTALL: document TEXINFO_XS_STRUCTURE and TEXINFO_XS_CONVERT use.
+
 2023-11-19  Patrice Dumas  <pertusus@free.fr>
 
        * tp/Texinfo/Convert/ConvertXS.pm, tp/Texinfo/Convert/Converter.pm,
diff --git a/INSTALL b/INSTALL
index b03f8a71c3..0e3f38f1c3 100644
--- a/INSTALL
+++ b/INSTALL
@@ -54,9 +54,9 @@ Installation notes specific to Texinfo:
   For that, run configure --disable-install-warnings, or set
   enable_install_warnings=no in the environment.
 
-* The `makeinfo' program is a Perl program that can use extension
-  modules, known as XS modules.  The configure script will attempt to
-  detect whether such modules can be built and loaded on your
+* The `texi2any' (makeinfo) program is a Perl program that can use
+  extension modules, known as XS modules.  The configure script will
+  attempt to detect whether such modules can be built and loaded on your
   installation.  If you want to disable the use of XS modules, you can
   give the --disable-perl-xs flag to `configure'; likewise, to use them
   without checking, give the --enable-perl-xs flag.  Some of the
@@ -68,8 +68,20 @@ Installation notes specific to Texinfo:
   information as the modules are looked for and loaded, TEXINFO_XS=omit
   to disable their use, and TEXINFO_XS=required to force their use.
 
-  If you want to use the XS modules but not the XS parser, you can set
-  the `TEXINFO_XS_PARSER' environment variable to 0.
+  Specific focused XS modules are only controlled by TEXINFO_XS.
+  XS modules replacing perl code for the main processing steps can be
+  controlled more finaly.  Three steps are distinguished: the parsing
+  step, the structure step for the determination of sectioning and node
+  structures, and the conversion step.  If the XS modules are not used
+  for a step, they cannot be used for the following steps.
+      If you want to use the XS modules but not the XS parser, you can
+  set the `TEXINFO_XS_PARSER' environment variable to 0.  If you use
+  the XS parser but do not want to use XS for the structure step, you
+  can set the `TEXINFO_XS_STRUCTURE' environment variable to 0.  For now,
+  the XS modules used for conversion are considered to be experimental,
+  so they are not used in the default case, even if the XS modules are used
+  for the structure step.  If you want to use the XS modules for conversion,
+  you should set the `TEXINFO_XS_CONVERT' environment variable to 1.
 
 * For instructions on compiling this distribution with DJGPP tools
   for MS-DOS and MS-Windows, see the file djgpp/README.