Makefile.am

   1 # This file is part of GNU Stow.
   2 #
   3 # GNU Stow is free software: you can redistribute it and/or modify it
   4 # under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation, either version 3 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # GNU Stow is distributed in the hope that it will be useful, but
   9 # WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program. If not, see https://www.gnu.org/licenses/.
  15
  16 ## Process this file with Automake to produce Makefile.in
  17
  18 bin_SCRIPTS = bin/stow bin/chkstow
  19 info_TEXINFOS = doc/stow.texi
  20 dist_man_MANS = doc/stow.8
  21 PDF = doc/manual.pdf
  22 HTML = doc/manual-single.html
  23 dist_doc_DATA = \
  24         README.md INSTALL.md \
  25         $(PDF) $(HTML) doc/version.texi \
  26         ChangeLog doc/ChangeLog.OLD
  27
  28 # automake magic to define where *_DATA files get installed:
  29 pmdir = $(PMDIR)
  30 pmstowdir = $(pmdir)/Stow
  31
  32 pm_DATA = lib/Stow.pm
  33 pmstow_DATA = lib/Stow/Util.pm
  34
  35 export TEXI2DVI_BUILD_MODE = clean
  36
  37 doc_deps = $(info_TEXINFOS) doc/version.texi
  38
  39 DEFAULT_IGNORE_LIST = $(srcdir)/default-ignore-list
  40
  41 TESTS_DIR = $(srcdir)/t
  42 TESTS_OUT = tmp-testing-trees
  43 TESTS_ENVIRONMENT = $(PERL) -Ibin -Ilib -I$(TESTS_DIR)
  44
  45 # This is a kind of hack; TESTS needs to be set to ensure that the
  46 # `check-am' target makes check-TESTS, but we override check-TESTS
  47 # so it doesn't really matter what it's set to, as long as it already
  48 # exists (otherwise automake will try to build it).
  49 TESTS = t
  50
  51 # GNU autotools standardised on the 'check' target, but CPAN (and the
  52 # rest of the world) standardised on the 'test' target.
  53 test: check
  54
  55 # required in vpath mode to ensure $build/t/ exists
  56 check_DATA = $(TESTS_OUT)
  57
  58 # Test::Harness produces cleaner output than automake's default test
  59 # harness, albeit without the pretty colours provided by the
  60 # `color-tests' AM_INIT_AUTOMAKE option.  This also dodges having to
  61 # set TESTS to the full list of tests, which is good because automake
  62 # doesn't support wildcards, and so it would be too easy to forget to
  63 # add a new one to the list.
  64 #
  65 # Note that automake's `check' rule cannot be overridden
  66 # for some weird reason:
  67 #
  68 #   https://lists.gnu.org/archive/html/automake/2011-09/msg00029.html
  69 #
  70 # so we override check-TESTS instead which is where the real work is
  71 # done anyway.  Unfortunately this produces a warning with the -Wall
  72 # option to AM_INIT_AUTOMAKE which has to be silenced via
  73 # -Wno-override.
  74 check-TESTS:
  75         dir=$(TESTS_DIR); \
  76         $(TESTS_ENVIRONMENT) -MTest::Harness -e 'runtests(@ARGV)' "$${dir#./}"/*.t
  77
  78 $(TESTS_OUT):
  79         mkdir -p $@
  80
  81 CPAN_FILES = MANIFEST MANIFEST.SKIP Build.PL META.yml META.json
  82 EXTRA_DIST = \
  83         bin/stow.in bin/chkstow.in lib/Stow.pm.in lib/Stow/Util.pm.in \
  84         doc/manual-split \
  85         $(TESTS) t/testutil.pm \
  86         $(DEFAULT_IGNORE_LIST) \
  87         $(CPAN_FILES)
  88 CLEANFILES = $(bin_SCRIPTS) $(pm_DATA) $(pmstow_DATA)
  89 DISTCLEANFILES = Makefile.in configure Build MYMETA.*
  90 MAINTAINERCLEANFILES = $(dist_man_MANS) $(HTML) $(PDF) ChangeLog
  91
  92 # clean up auto-generated files
  93 clean-local:
  94         -rm -rf $(TESTS_OUT)
  95 maintainer-clean-local:
  96         -rm -rf doc/manual-split cover_db
  97
  98 # this is more explicit and reliable than the config file trick
  99 edit = sed -e 's|[@]PERL[@]|$(PERL)|g'       \
 100            -e 's|[@]VERSION[@]|$(VERSION)|g' \
 101            -e "s|[@]USE_LIB_PMDIR[@]|$$use_lib_pmdir|g"
 102
 103 pmdir_in_INC = \
 104         PERL5LIB= $(PERL) -V | \
 105             awk '/@INC/ {p=1; next} p==1 {print $$1}' | \
 106             grep -q "$(pmdir)"
 107
 108 calc_use_lib_pmdir = \
 109         if $(pmdir_in_INC); then \
 110             use_lib_pmdir=""; \
 111         else \
 112             use_lib_pmdir="use lib \"$(pmdir)\";"; \
 113         fi
 114
 115 check_pmdir = \
 116         echo; \
 117         echo "\# Perl modules will be installed to $(pmdir)"; \
 118         echo "\# "; \
 119         if $(pmdir_in_INC); then \
 120             echo "\# This is in $(PERL)'s built-in @INC, so everything"; \
 121             echo "\# should work fine with no extra effort."; \
 122         else \
 123             echo "\# This is not in $(PERL)'s built-in @INC, so the"; \
 124             echo "\# front-end scripts will have an appropriate \"use lib\""; \
 125             echo "\# line inserted to compensate."; \
 126         fi; \
 127         echo
 128
 129 bin/stow: bin/stow.in Makefile.am
 130         [ -d bin ] || mkdir bin # required in vpath mode
 131         @$(check_pmdir)
 132         @$(calc_use_lib_pmdir); \
 133         $(edit) < $< > $@
 134         @echo "Generated $@ from $<"
 135         chmod +x $@
 136
 137 bin/chkstow: bin/chkstow.in Makefile.am
 138         @[ -d bin ] || mkdir bin # required in vpath mode
 139         @$(edit) < $< > $@
 140         @echo "Generated $@ from $<"
 141         chmod +x $@
 142
 143 lib/Stow.pm: lib/Stow.pm.in $(DEFAULT_IGNORE_LIST) Makefile.am
 144         @[ -d lib ] || mkdir lib # required in vpath mode
 145         @( $(edit) < $<; cat $(DEFAULT_IGNORE_LIST) ) > $@
 146         @echo "Generated $@ from $< and $(DEFAULT_IGNORE_LIST)"
 147
 148 lib/Stow/Util.pm: lib/Stow/Util.pm.in Makefile.am
 149         @[ -d lib/Stow ] || mkdir -p lib/Stow # required in vpath mode
 150         @$(edit) < $< > $@
 151         @echo "Generated $@ from $<"
 152
 153 ##############################################################################
 154 # The below rules should only be needed by developers.
 155 ##############################################################################
 156
 157 cpanm:
 158         cpanm --quiet --installdeps --notest .; \
 159         CPANM_RESULT=$$?; \
 160         if [ $$CPANM_RESULT != 0 ]; then \
 161             echo ---------------------------------------------------; \
 162             cat ~/.cpanm/build.log; \
 163             echo ---------------------------------------------------; \
 164             exit $$CPANM_RESULT; \
 165         fi
 166
 167 doc/stow.8: bin/stow.in Makefile.am
 168         [ -d doc ] || mkdir doc # required in vpath mode
 169         $(edit) < $< | pod2man --name stow --section 8 > $@
 170
 171 # We use automake's built-in rule to generate stow.info.  The built-in
 172 # rules would also generate doc/stow.html and doc/stow.pdf, but after
 173 # installation we want $(docdir) (typically /usr/share/doc/stow/) to
 174 # contain manual-single.html, manual.pdf, and manual-split/*.html, to
 175 # make it explicitly obvious that these files contain the user manual
 176 # rather than some other Stow-related documentation.
 177 #
 178 # If it were not for a troublesome dependency on doc/$(am__dirstamp):
 179 #
 180 #   https://lists.gnu.org/archive/html/automake/2011-11/msg00107.html
 181 #
 182 # we could have achieved this using the built-in rules combined with
 183 # install-data-hook to rename from stow.pdf to manual.pdf etc. on
 184 # install.  Instead, by overriding the built-in rules with modified
 185 # versions, we can kill both birds with one stone.
 186
 187 # Generating the single-page HTML version used to be done with the old
 188 # texi2html, which is no longer maintained.  This rule is not used,
 189 # but is kept to allow comparing of results during the transition, and
 190 # potentially longer for posterity.
 191 doc/manual-single-old-texi2html.html: $(doc_deps)
 192         texi2html --P=$(srcdir) --output=$@ -expandinfo -menu -monolithic -verbose $<
 193
 194 # One alternative to the old texi2html approach is to use the texi2html
 195 # wrapper around texi2any which is provided as a partial drop-in replacement:
 196 #
 197 # https://www.gnu.org/software/texinfo/manual/texinfo/html_node/texi2html.html#texi2html
 198 #
 199 # Differences to the old texi2html:
 200 #
 201 #   - Doesn't wrap @file{foo} paths with quotes, which looks better.
 202 #   - Missing certain sections
 203 doc/manual-single-texi2html-wrapper.html: $(doc_deps)
 204         texi2any -P $(srcdir) --output=$@ --verbose \
 205                 -c TEXI2HTML=1 -c SHOW_MENU=1 -c MONOLITHIC=1 $<
 206
 207 .PHONY: manual-single-html-all
 208 manual-single-html-all: \
 209         $(HTML) \
 210         doc/manual-single-texi2html-wrapper.html \
 211         doc/manual-single-old-texi2html.html
 212
 213 # Modern approach using $(MAKEINFOHTML) --no-split
 214 # Differences to the older two approaches:
 215 #
 216 #   - Nicer navigation links between sections
 217 $(HTML): $(doc_deps)
 218         [ -d doc ] || mkdir doc # required in vpath mode
 219         -rm -f $@
 220         $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I doc -I $(srcdir)/doc \
 221                 -c USE_TITLEPAGE_FOR_TITLE=1 --no-split -o $@ \
 222                 `test -f 'doc/stow.texi' || echo '$(srcdir)/'`doc/stow.texi
 223
 224 $(PDF): $(doc_deps)
 225         TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \
 226         MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I doc -I $(srcdir)/doc' \
 227         $(TEXI2PDF) -o $@ `test -f 'doc/stow.texi' || echo '$(srcdir)/'`doc/stow.texi
 228
 229 doc/manual-split: $(doc_deps)
 230         rm -rf $@.new
 231         if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I doc -I $(srcdir)/doc \
 232          -o $@.new `test -f 'doc/stow.texi' || echo '$(srcdir)/'`doc/stow.texi; \
 233         then \
 234           rm -rf $@; \
 235           mv $@.new $@; \
 236         else \
 237           rm -Rf $@.new $@; \
 238           exit 1; \
 239         fi
 240
 241 # The split version of the manual is copied to $(docdir)/manual-split
 242 # by install-data-hook.  The whole subdirectory is included via
 243 # EXTRA_DIST in order to avoid having to list each file explicitly in
 244 # dist_doc_DATA, since automake doesn't support wildcards, and
 245 # dist_doc_DATA cannot refer to directories while EXTRA_DIST can (go
 246 # figure ...)
 247
 248 install-data-hook: doc/manual-split
 249         cp -r $(srcdir)/doc/manual-split $(DESTDIR)$(docdir)
 250
 251 uninstall-hook:
 252         chmod u+w -R $(DESTDIR)$(docdir)/manual-split
 253         rm -rf $(DESTDIR)$(docdir)/manual-split
 254
 255 # Using install-data-hook has the slightly annoying disadvantage that
 256 # by default the split version of the manual isn't automatically
 257 # rebuilt during development by a simple `make'.  A workaround hack
 258 # for this is to piggy-back the dependency onto manual-single.html,
 259 # which *is* automatically rebuilt by `make':
 260 $(HTML): doc/manual-split
 261
 262 # With the above hack, this probably isn't necessary but is safer to
 263 # keep in anyway:
 264 dist-hook: doc/manual-split
 265
 266 dist-hook: $(dist_man_MANS)
 267 ## If we are creating a distribution from a git checkout, ensure
 268 ## the ChangeLog file is in sync the git repository.
 269         if test -d $(top_srcdir)/.git; then \
 270           rm -f ChangeLog \
 271             && $(MAKE) $(AM_MAKEFLAGS) ChangeLog \
 272             && cp -f ChangeLog $(distdir)/ChangeLog; \
 273         fi
 274
 275 ChangeLog: doc/ChangeLog.OLD
 276         @if [ -d .git ]; then \
 277             ( \
 278                 git log \
 279                     --format="format:%ad  %aN <%aE>%n%n    * %w(70,0,4)%s%+b%n" \
 280                     --name-status \
 281                     v2.0.2..HEAD \
 282                 | sed 's/^\([A-Z]\)\t/      \1 /'; \
 283                 cat $< \
 284             ) > $@; \
 285             echo "Rebuilt $@ from git commit history."; \
 286         else \
 287             echo "Not in a git repository; can't update ChangeLog."; \
 288         fi