# Makefile to build Texinfo from the Perl POD documentation,
# using pod2texi.
#
# Copyright 2013-2019 Free Software Foundation, Inc.
# 
# This file is free software; as a special exception the author gives
# unlimited permission to copy and/or distribute it, with or without
# modifications, as long as this notice is preserved.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

perl_pod_subdir = $(shell pwd)/perl-[0-9]*.*/pod
texi_pod_doc = perldoc-all
texi_pod_doc_incl = $(texi_pod_doc)-incl.texi
texi_pod_subdir = $(texi_pod_doc)

texinfo_srcdir = $(shell cd ../../ && pwd)
pod2texi = perl $(texinfo_srcdir)/Pod-Simple-Texinfo/pod2texi.pl
pod2texi_args  = --base-level=section
pod2texi_args += --preamble=''  # we want our own
pod2texi_args += --subdir=$(texi_pod_subdir)

# Unfortunately have to use --no-validate since not all the names and
# L<references> match up.  Split HTML by chapter is the natural thing here.
gendocs_args  = --email bug-texinfo@gnu.org
gendocs_args += --common "--no-warn --no-validate"
gendocs_args += --split chapter
gendocs_args += --no-ascii
gendocs_args += --source $(texi_pod_subdir)
gendocs_args += --tex "--batch -t @finalout"
gendocs_title = "Perl documentation in Texinfo"

all: $(texi_pod_doc_incl)
	rm -rf manual *.aux *.toc
# turns out the combined docs overflow one of TeX's arrays; increase it.
	env save_size=100000 \
	  ./gendocs-sh $(gendocs_args) $(texi_pod_doc) $(gendocs_title)

EXTRA_DIST += gendocs-sh

$(texi_pod_doc_incl): $(perl_pod_subdir)/*.pod
	rm -rf $(texi_pod_subdir)
#
# We remove all X<...> cross-reference constructs from the pods
# before processing, since they are not parsed properly, resulting
# in many chapters called simply "NAME", e.g., perldebug and perlsyn.
# 
# We omit the numerous delta pods, which are uninteresting when
# searching (and take tons of time and space to process).
# 
# We also omit perlunicook, since it necessarily has many binary Unicode
# characters, and processing the whole thing in UTF-8 makes it less useful. 
#
# Because we start from the source directory, we also lose all the
# generated .pods, such as perluniprops.  We would not want
# all of them (e.g., perltw.pod), but some (like uniprops) might be nice.
# Maybe someday.
# 
	cd $(perl_pod_subdir) \
	&& perl -p -i.bak -e 's,X<.*?>>?,,g' *.pod \
	&& $(pod2texi) -o $@ $(pod2texi_args) \
	  `ls *.pod | egrep -v "(delta|unicook)"` \
	&& mv $(texi_pod_subdir) $@ ../..

# updating on www.gnu.org.  We do not install the split HTML files
# because the long file names cause trouble for some GNU webmasters,
# who use encryption software that reduces the maximum file name length
# by about half.  Sigh.
www_target = $(HOME)/gnu/www/www/software/perl/manual
install:
	cp -arf manual/. $(www_target)/.
	rm -rf $(www_target)/html_chapter
	cd $(www_target) && cvs update -P

mostlyclean:
	rm -rf manual $(texi_pod_doc_incl)

# run directly from top-level Makefile.am
# when running make dist, ensure we have none of the build files,
# since the whole contrib/ directory is included in its entirety.
dist-hook:
	rm -rf manual perl-5.*.* $(texi_pod_doc) $(texi_pod_doc_incl) && \
	rm -rf *.?? *.??? *.info *~ \#*