texinfo-commits
[Top][All Lists]
Advanced

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

branch master updated: Include pod2texi Pod converted to Texinfo by pod2


From: Patrice Dumas
Subject: branch master updated: Include pod2texi Pod converted to Texinfo by pod2texi in manual
Date: Tue, 08 Feb 2022 09:35:11 -0500

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 e6b82eb127 Include pod2texi Pod converted to Texinfo by pod2texi in 
manual
e6b82eb127 is described below

commit e6b82eb127d6ac026a62779c8338489d2fffdd5f
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Tue Feb 8 15:34:56 2022 +0100

    Include pod2texi Pod converted to Texinfo by pod2texi in manual
    
    * doc/Makefile.am, doc/texinfo.texi (Invoking @command{pod2texi}):
    include pod2texi.texi converted from pod2texi.pl by pod2texi.pl
    in the Texinfo manual.
---
 ChangeLog        |  8 ++++++++
 doc/Makefile.am  | 15 ++++++++++++++-
 doc/texinfo.texi | 48 +++++++++++++++++++++++++++++++-----------------
 3 files changed, 53 insertions(+), 18 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 7dda28d2e0..8dd39ee5ec 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2022-02-08  Patrice Dumas  <pertusus@free.fr>
+
+       Include pod2texi Pod converted to Texinfo by pod2texi in manual
+
+       * doc/Makefile.am, doc/texinfo.texi (Invoking @command{pod2texi}):
+       include pod2texi.texi converted from pod2texi.pl by pod2texi.pl
+       in the Texinfo manual.
+
 2022-02-08  Patrice Dumas  <pertusus@free.fr>
 
        * Pod-Simple-Texinfo/lib/Pod/Simple/Texinfo.pm
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c633bb4b29..03e663d50f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -13,6 +13,7 @@
 SUBDIRS = tp_api
 
 info_TEXINFOS = texinfo.texi info-stnd.texi
+texinfo_TEXINFOS = pod2texi.texi
 DISTCLEANFILES = texinfo.info* info-stnd.info*
 
 MAKEINFO_ENVIRONMENT = TEXINFO_DEV_SOURCE=1 ; export TEXINFO_DEV_SOURCE ; \
@@ -21,6 +22,19 @@ MAKEINFO_ENVIRONMENT = TEXINFO_DEV_SOURCE=1 ; export 
TEXINFO_DEV_SOURCE ; \
 MAKEINFO = $(MAKEINFO_ENVIRONMENT) $(PERL) $(top_builddir)/tp/texi2any
 TEXI2DVI = $(top_srcdir)/util/texi2dvi
 
+# include pod2texi in the main manual
+pod2texi_pl = $(abs_top_srcdir)/Pod-Simple-Texinfo/pod2texi.pl
+
+if BUILD_PERL_API_TEXI
+# we setup the conversion to Texinfo for inclusion in a document,
+# but we ignore the resulting document, as we include from the
+# Texinfo manual.  The file name for the included section
+# is therefore determined by the information in the Pod file NAME
+# section.
+pod2texi.texi: $(pod2texi_pl)
+       $(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=subsubsection 
--no-section-nodes --headings-as-sections $(pod2texi_pl) > /dev/null
+endif
+
 # We'd also like to use something like this, but Automake calls
 # "install-info" directly.
 # INSTALL_INFO = $(top_builddir)/$(native_tools)/util/ginstall-info
@@ -97,7 +111,6 @@ manual2 = texinfo
 manual2_title = "GNU Texinfo manual"
 #
 # We also make a little HTML document for pod2texi script.
-pod2texi_pl = $(abs_top_srcdir)/Pod-Simple-Texinfo/pod2texi.pl
 
 # destination directory.
 doctemp = wwwtemp
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 662cc846ad..0f3d8d3474 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -41,7 +41,7 @@ Texts.  A copy of the license is included in the section 
entitled
 * Texinfo: (texinfo).           The GNU documentation format.
 * install-info: (texinfo)Invoking install-info. Update info/dir entries.
 * makeinfo: (texinfo)Invoking makeinfo.         Translate Texinfo source.
-* pod2texi: (pod2texi)Invoking pod2texi.        Translate Perl POD to Texinfo.
+* pod2texi: (pod2texi)Invoking pod2texi.        Translate Perl Pod to Texinfo.
 * texi2dvi: (texinfo)Format with texi2dvi.      Print Texinfo documents.
 * texi2pdf: (texinfo)PDF Output.                PDF output for Texinfo.
 * pdftexi2dvi: (texinfo)PDF Output.             PDF output for Texinfo.
@@ -531,7 +531,7 @@ Format with @command{tex}/@command{texindex}
 * @command{texi2any} Printed Output::     Calling @command{texi2dvi}.
 * Customization Variables::     Configuring @command{texi2any}.
 * Internationalization of Document Strings:: Translating program-inserted text.
-* Invoking @command{pod2texi}::           Translating Perl pod to Texinfo.
+* Invoking @command{pod2texi}::           Translating Perl Pod to Texinfo.
 * @command{texi2html}::                   An ancestor of @command{texi2any}.
 
 Customization Variables
@@ -15383,7 +15383,7 @@ specified within a initialization file.
 * @command{texi2any} Printed Output::     Calling @command{texi2dvi}.
 * Customization Variables::     Configuring @command{texi2any}.
 * Internationalization of Document Strings:: Translating program-inserted text.
-* Invoking @command{pod2texi}::           Translating Perl pod to Texinfo.
+* Invoking @command{pod2texi}::           Translating Perl Pod to Texinfo.
 * @command{texi2html}::                   An ancestor of @command{texi2any}.
 @end menu
 
@@ -17112,31 +17112,45 @@ appropriately in many languages.
 
 
 @node Invoking @command{pod2texi}
-@section Invoking @command{pod2texi}: Convert POD to Texinfo
+@section Invoking @command{pod2texi}: Convert Pod to Texinfo
 
 @pindex pod2texi
-@cindex Invoking @code{pod2texi}
-@cindex POD, converting to Texinfo
-@cindex Perl POD, converting to Texinfo
+@cindex Invoking @command{pod2texi}
+@cindex Pod, converting to Texinfo
+@cindex Perl Pod, converting to Texinfo
 
-The @code{pod2texi} program translates Perl pod documentation file(s)
+The @command{pod2texi} program translates Perl Pod documentation file(s)
 to Texinfo.  There are two basic modes of operation: generating a
-standalone manual from each input pod, or (if @code{--base-level=1} or
+standalone manual from each input Pod, or (if @code{--base-level=1} or
 higher is given) generating Texinfo subfiles suitable for use
 with @code{@@include}.
 
-Although ordinarily this documentation in the Texinfo manual would be
-the best place to look, in this case we have documented all the
-options and examples in the @code{pod2texi} program itself, since it
-may be useful outside of the rest of Texinfo.  Thus, please see the
-output of @code{pod2texi --help}, the version on the web at
-@url{http://www.gnu.org/software/texinfo/manual/pod2texi.html}, etc.
-
-For an example of using @code{pod2texi} to make Texinfo out of the
+@c Although ordinarily this documentation in the Texinfo manual would be
+@c the best place to look, in this case we have documented all the
+@c options and examples in the @command{pod2texi} program itself, since it
+@c may be useful outside of the rest of Texinfo.  Thus, please see the
+@c output of @code{pod2texi --help}, the version on the web at
+@c @url{http://www.gnu.org/software/texinfo/manual/pod2texi.html}, etc.
+
+The @command{pod2texi} program may be useful outside of the rest of Texinfo,
+thus the invokation of @command{pod2texi} is documented using the man page
+format to follow the convention used in Perl standalone programs, with a
+version on the web
+@url{http://www.gnu.org/software/texinfo/manual/pod2texi.html} and a version
+included below.  The version included in the manual is also an example of
+@command{pod2texi} use, as it is converted from Pod using @command{pod2texi}.
+
+For an example of using @command{pod2texi} to make Texinfo out of the
 Perl documentation itself, see
 
@url{http://svn.savannah.gnu.org/viewvc/trunk/contrib/perldoc-all/?root=texinfo,
 @file{contrib/perldoc-all}} in the Texinfo source distribution.
 
+@menu
+* pod2texi manual page::      @command{pod2texi} invokation in a manual page 
format
+@end menu
+
+@node pod2texi manual page
+@include pod2texi.texi
 
 @node @command{texi2html}
 @section @command{texi2html}: Ancestor of @command{texi2any}



reply via email to

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