branch master updated: Rename texi2any modules and API manuals and distribute API manual

[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 9580fa2a58 Rename texi2any modules and API manuals and distribute API 
manual
9580fa2a58 is described below

commit 9580fa2a58ef15762377172a16ec5eff0a3e6501
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Wed Oct 19 00:40:37 2022 +0200

    Rename texi2any modules and API manuals and distribute API manual
    
    * doc/Makefile.am (AM_MAKEINFOFLAGS, info_TEXINFOS, DISTCLEANFILES),
    doc/texi2any_api.texi: rename customization_api.texi as
    texi2any_api.texi.  Gavin suggestion.  Build and distribute
    texi2any_api manual.  Use AM_MAKEINFOFLAGS to set
    INFO_SPECIAL_CHARS_WARNING=0 since links to texi2any_internals
    manual produce many warnings.
    
    * doc/tp_api/Makefile.am (info_TEXINFOS), autogen.sh: rename
    tp_api.texi as texi2any_internals.texi.  Gavin suggestion.
---
 .gitignore                                           | 20 ++++++++++----------
 ChangeLog                                            | 14 ++++++++++++++
 autogen.sh                                           |  9 +++++----
 doc/Makefile.am                                      |  7 +++++--
 doc/{customization_api.texi => texi2any_api.texi}    |  9 ++++-----
 doc/tp_api/Makefile.am                               | 18 +++++++++---------
 ..._indices.texi => texi2any_internals_indices.texi} |  0
 7 files changed, 47 insertions(+), 30 deletions(-)

diff --git a/.gitignore b/.gitignore
index 3161bb5b87..2d826cd8a5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -89,11 +89,6 @@ doc/*.pdf
 doc/*.t2p
 doc/test.*
 
-doc/customization_api.??
-doc/customization_api.??s
-doc/customization_api.aux
-doc/customization_api.log
-doc/customization_api.toc
 doc/info-stnd.??
 doc/info-stnd.??s
 doc/info-stnd.aux
@@ -114,7 +109,13 @@ doc/short-sample-ja.??s
 doc/short-sample-ja.log
 doc/short-sample-ja.toc
 doc/stamp-1
+doc/stamp-2
 doc/stamp-vti
+doc/texi2any_api.??
+doc/texi2any_api.??s
+doc/texi2any_api.aux
+doc/texi2any_api.log
+doc/texi2any_api.toc
 doc/texinfo
 doc/texinfo.??
 doc/texinfo.??s
@@ -128,11 +129,10 @@ doc/texinfo.tex.sig
 doc/texinfo.toc
 doc/texinfo.xml
 doc/texput.log
-doc/version-stnd.texi
-doc/version.texi
-doc/wwwtemp
 doc/version.texi
 doc/version-stnd.texi
+doc/version-texi2any_api.texi
+doc/wwwtemp
 
 doc/refcard/*.dvi
 doc/refcard/*.log
@@ -141,8 +141,8 @@ doc/refcard/*.ps
 doc/tp_api/*.t2p
 doc/tp_api/*.info
 doc/tp_api/api_includes
-doc/tp_api/tp_api.pdf
-doc/tp_api/tp_api.texi
+doc/tp_api/texi2any_internals.pdf
+doc/tp_api/texi2any_internals.texi
 
 man/info.1
 man/install-info.1
diff --git a/ChangeLog b/ChangeLog
index da7db37d51..de379ae558 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2022-10-19  Patrice Dumas  <pertusus@free.fr>
+
+       Rename texi2any modules and API manuals and distribute API manual
+
+       * doc/Makefile.am (AM_MAKEINFOFLAGS, info_TEXINFOS, DISTCLEANFILES),
+       doc/texi2any_api.texi: rename customization_api.texi as
+       texi2any_api.texi.  Gavin suggestion.  Build and distribute
+       texi2any_api manual.  Use AM_MAKEINFOFLAGS to set
+       INFO_SPECIAL_CHARS_WARNING=0 since links to texi2any_internals
+       manual produce many warnings.
+
+       * doc/tp_api/Makefile.am (info_TEXINFOS), autogen.sh: rename
+       tp_api.texi as texi2any_internals.texi.  Gavin suggestion.
+
 2022-10-18  Wu XiangCheng  <bobwxc@yeah.net>
 
        * doc/txi-zh.tex (\Ynumbered): Override.
diff --git a/autogen.sh b/autogen.sh
index 040d449464..cd5b69e422 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -25,10 +25,11 @@ cmd="(cd tp/tests && ../maintain/regenerate_cmd_tests.sh 
Makefile.onetst . -base
 echo "  $cmd"
 $chicken eval $cmd || exit 1
 
-# missing tp_api.texi stops automake.  Set up a fake tp_api.texi
-# with a file timestamp set in the past, if tp_api.texi is not present
-if test '!' -s doc/tp_api/tp_api.texi ; then
-  cmd="echo '@setfilename tp_api.info' > doc/tp_api/tp_api.texi; touch -t 
200001010000 doc/tp_api/tp_api.texi"
+# missing texi2any_internals.texi stops automake.  Set up a fake
+# texi2any_internals.texi with a file timestamp set in the past,
+# if texi2any_internals.texi is not present
+if test '!' -s doc/tp_api/texi2any_internals.texi ; then
+  cmd="echo '@setfilename texi2any_internals.info' > 
doc/tp_api/texi2any_internals.texi; touch -t 200001010000 
doc/tp_api/texi2any_internals.texi"
   echo "  $cmd"
   $chicken eval $cmd || exit 1
 fi
diff --git a/doc/Makefile.am b/doc/Makefile.am
index d5e9b7f454..dd94c1474f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -10,11 +10,14 @@
 # WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
+# The links to texi2any_internals require that to avoid many warnings
+AM_MAKEINFOFLAGS = -c INFO_SPECIAL_CHARS_WARNING=0
+
 SUBDIRS = tp_api
 
-info_TEXINFOS = texinfo.texi info-stnd.texi
+info_TEXINFOS = texinfo.texi info-stnd.texi texi2any_api.texi
 texinfo_TEXINFOS = pod2texi.texi
-DISTCLEANFILES = texinfo.info* info-stnd.info*
+DISTCLEANFILES = texinfo.info* info-stnd.info* texi2any_api.info*
 
 MAKEINFO_ENVIRONMENT = TEXINFO_DEV_SOURCE=1 ; export TEXINFO_DEV_SOURCE ; \
                        top_srcdir="$(top_srcdir)" ; export top_srcdir ; \
diff --git a/doc/customization_api.texi b/doc/texi2any_api.texi
similarity index 99%
rename from doc/customization_api.texi
rename to doc/texi2any_api.texi
index 6a452871e1..d6c3b26d5f 100644
--- a/doc/customization_api.texi
+++ b/doc/texi2any_api.texi
@@ -1,14 +1,13 @@
 \input texinfo.tex    @c -*-texinfo-*-
 
-@setfilename customization_api.info
-
-@include version.texi
+@include version-texi2any_api.texi
 
 @settitle GNU Texinfo @command{texi2any} Output Customization
 
 @copying
-This manual is for GNU Texinfo (version @value{VERSION}, @value{UPDATED}),
-@command{texi2any} program output adaptation using customization files.
+This manual is for GNU Texinfo @command{texi2any} program output
+adaptation using customization files (version @value{VERSION},
+@value{UPDATED}).
 
 Copyright @copyright{} 2013, 2022 Free Software Foundation, Inc.
 
diff --git a/doc/tp_api/Makefile.am b/doc/tp_api/Makefile.am
index a77347738b..b86d37a94c 100644
--- a/doc/tp_api/Makefile.am
+++ b/doc/tp_api/Makefile.am
@@ -28,25 +28,25 @@ MAKEINFO = $(PERL) -I $(top_srcdir)/tp/ 
$(top_srcdir)/tp/texi2any.pl
 # of each module, so split at chapters.
 AM_MAKEINFOHTMLFLAGS = --split=chapter
 
-# since the tp_api 'manual' is referred to extensively in the
-# customization_api, we setup the build targets.
-info_TEXINFOS = tp_api.texi
+# since the texi2any_internals 'manual' is referred to extensively in the
+# texi2any_api, we setup the build targets.
+info_TEXINFOS = texi2any_internals.texi
 
 TEXINFO_TEX = ../texinfo.tex
 
 # dependencies are in api_includes/ directory but we do not want to list
 # them explicitly
-tp_api_TEXINFOS = tp_api_indices.texi
-#dist_tp_api_TEXINFOS = 
+texi2any_internals_TEXINFOS = texi2any_internals_indices.texi
+#dist_texi2any_internals_TEXINFOS = 
 EXTRA_DIST = api_includes
 
 if BUILD_PERL_API_TEXI
 
-BUILT_SOURCES = tp_api.texi
+BUILT_SOURCES = texi2any_internals.texi
 
 # all the modules with some interesting public interfaces.
 # The order matters for the result.
-tp_api_dependencies = \
+texi2any_internals_dependencies = \
   $(top_srcdir)/tp/Texinfo/Commands.pod \
   $(top_srcdir)/tp/Texinfo/Common.pm \
   $(top_srcdir)/tp/Texinfo/ParserNonXS.pm \
@@ -67,7 +67,7 @@ tp_api_dependencies = \
   $(top_srcdir)/tp/Texinfo/Convert/TexinfoXML.pm \
   $(top_srcdir)/tp/Texinfo/Convert/Plaintext.pm
 
-tp_api.texi: $(tp_api_dependencies) tp_api_indices.texi
-       $(PERL) -I $(top_srcdir)/Pod-Simple-Texinfo/lib/ -I $(top_srcdir)/tp/ 
-I $(top_srcdir)/tp/maintain/lib/Text-Unidecode/lib/ -I 
$(top_srcdir)/tp/maintain/lib/libintl-perl/lib/ -I 
$(top_srcdir)/tp/maintain/lib/Unicode-EastAsianWidth/lib/ 
$(top_srcdir)/Pod-Simple-Texinfo/pod2texi.pl --base-level=section --setfilename 
tp_api.info --top 'Texinfo modules documentation' --subdir=api_includes 
$(tp_api_dependencies) | sed -e 's/^@bye/@__bye/' | sed -e '/^@__bye/r 
$(srcdir)/tp_api_indices.texi' |  [...]
+texi2any_internals.texi: $(texi2any_internals_dependencies) 
texi2any_internals_indices.texi
+       $(PERL) -I $(top_srcdir)/Pod-Simple-Texinfo/lib/ -I $(top_srcdir)/tp/ 
-I $(top_srcdir)/tp/maintain/lib/Text-Unidecode/lib/ -I 
$(top_srcdir)/tp/maintain/lib/libintl-perl/lib/ -I 
$(top_srcdir)/tp/maintain/lib/Unicode-EastAsianWidth/lib/ 
$(top_srcdir)/Pod-Simple-Texinfo/pod2texi.pl --base-level=section --setfilename 
texi2any_internals.info --top 'Texinfo modules documentation' 
--subdir=api_includes $(texi2any_internals_dependencies) | sed -e 
's/^@bye/@__bye/' | sed -e '/^@__bye/r $(srcdir) [...]
 
 endif
diff --git a/doc/tp_api/tp_api_indices.texi 
b/doc/tp_api/texi2any_internals_indices.texi
similarity index 100%
rename from doc/tp_api/tp_api_indices.texi
rename to doc/tp_api/texi2any_internals_indices.texi