Makefile.am

   1 ## Process this file with Automake to produce Makefile.in
   2
   3 bin_SCRIPTS = bin/stow bin/chkstow
   4 info_TEXINFOS = doc/stow.texi
   5 dist_man_MANS = doc/stow.8
   6 PDF = doc/manual.pdf
   7 HTML = doc/manual-single.html
   8 dist_doc_DATA = \
   9         README \
  10         $(PDF) $(HTML) doc/version.texi \
  11         ChangeLog doc/ChangeLog.OLD
  12
  13 pmdir = $(PMDIR)
  14 pm_DATA = lib/Stow.pm
  15 pmstowdir = $(pmdir)/Stow
  16 dist_pmstow_DATA = lib/Stow/Util.pm
  17
  18 TEXINFO_TEX = doc/texinfo.tex
  19 export TEXI2DVI_BUILD_MODE = clean
  20 AM_MAKEINFOFLAGS = -I $(srcdir)
  21
  22 # We require this -I parameter to ensure that the include of the
  23 # default ignore list in the manual works.  Unfortunately this is
  24 # the only way to do it:
  25 #
  26 #   http://article.gmane.org/gmane.comp.sysutils.automake.bugs/4334/match=passing+parameters
  27 #
  28 # even though it annoyingly produces a warning with the -Wall option
  29 # to AM_INIT_AUTOMAKE which has to be silenced via -Wno-override.
  30 TEXI2DVI = texi2dvi $(AM_MAKEINFOFLAGS)
  31
  32 doc_deps = $(info_TEXINFOS) doc/version.texi
  33
  34 DEFAULT_IGNORE_LIST = $(srcdir)/default-ignore-list
  35
  36 TESTS_DIR = $(srcdir)/t
  37 TESTS_OUT = tmp-testing-trees
  38 TESTS_ENVIRONMENT = $(PERL) -Ibin -Ilib -I$(TESTS_DIR)
  39
  40 # This is a kind of hack; TESTS needs to be set to ensure that the
  41 # `check-am' target makes check-TESTS, but we override check-TESTS
  42 # so it doesn't really matter what it's set to, as long as it already
  43 # exists (otherwise automake will try to build it).
  44 TESTS = t
  45
  46 # GNU autotools standardised on the 'check' target, but CPAN (and the
  47 # rest of the world) standardised on the 'test' target.
  48 test: check
  49
  50 # required in vpath mode to ensure $build/t/ exists
  51 check_DATA = $(TESTS_OUT)
  52
  53 # Test::Harness produces cleaner output than automake's default test
  54 # harness, albeit without the pretty colours provided by the
  55 # `color-tests' AM_INIT_AUTOMAKE option.  This also dodges having to
  56 # set TESTS to the full list of tests, which is good because automake
  57 # doesn't support wildcards, and so it would be too easy to forget to
  58 # add a new one to the list.
  59 #
  60 # Note that automake's `check' rule cannot be overridden
  61 # for some weird reason:
  62 #
  63 #   http://thread.gmane.org/gmane.comp.sysutils.automake.general/13040/focus=13041
  64 #
  65 # so we override check-TESTS instead which is where the real work is
  66 # done anyway.  Unfortunately this produces a warning with the -Wall
  67 # option to AM_INIT_AUTOMAKE which has to be silenced via
  68 # -Wno-override.
  69 check-TESTS:
  70         dir=$(TESTS_DIR); \
  71         $(TESTS_ENVIRONMENT) -MTest::Harness -e 'runtests(@ARGV)' "$${dir#./}"/*.t
  72
  73 $(TESTS_OUT):
  74         mkdir -p $@
  75
  76 CPAN_FILES = MANIFEST MANIFEST.SKIP Build.PL META.yml META.json
  77 EXTRA_DIST = \
  78         bin/stow.in bin/chkstow.in lib/Stow.pm.in \
  79         doc/manual-split \
  80         $(TESTS) t/testutil.pm \
  81         $(TEXINFO_TEX) \
  82         $(DEFAULT_IGNORE_LIST) \
  83         $(CPAN_FILES)
  84 CLEANFILES = $(bin_SCRIPTS) $(pm_DATA) $(dist_man_MANS) $(HTML) $(PDF) ChangeLog
  85
  86
  87 # clean up auto-generated files
  88 clean-local:
  89         -rm -rf $(TESTS_OUT)
  90 maintainer-clean:
  91         -rm -rf doc/manual-split
  92
  93 # this is more explicit and reliable than the config file trick
  94 edit = sed -e 's|[@]PERL[@]|$(PERL)|g' \
  95            -e 's|[@]VERSION[@]|$(VERSION)|g'
  96
  97 bin/stow: bin/stow.in Makefile
  98         [ -d bin ] || mkdir bin # required in vpath mode
  99         $(edit) < $< > $@
 100         chmod +x $@
 101
 102 bin/chkstow: bin/chkstow.in Makefile
 103         [ -d bin ] || mkdir bin # required in vpath mode
 104         $(edit) < $< > $@
 105         chmod +x $@
 106
 107 lib/Stow.pm: lib/Stow.pm.in Makefile $(DEFAULT_IGNORE_LIST)
 108         [ -d lib ] || mkdir lib # required in vpath mode
 109         ( $(edit) < $<; cat $(DEFAULT_IGNORE_LIST) ) > $@
 110
 111 ##############################################################################
 112 # The below rules should only be needed by developers.
 113 ##############################################################################
 114
 115 doc/stow.8: bin/stow.in
 116         [ -d doc ] || mkdir doc # required in vpath mode
 117         pod2man $< > $@
 118
 119 # We use automake's built-in rule to generate stow.info.  The built-in
 120 # rules would also generate doc/stow.html and doc/stow.pdf, but after
 121 # installation we want $(docdir) (typically /usr/share/doc/stow/) to
 122 # contain manual-single.html, manual.pdf, and manual-split/*.html, to
 123 # make it explicitly obvious that these files contain the user manual
 124 # rather than some other Stow-related documentation.
 125 #
 126 # If it were not for a troublesome dependency on doc/$(am__dirstamp):
 127 #
 128 #   http://article.gmane.org/gmane.comp.sysutils.automake.general/13192
 129 #
 130 # we could have achieved this using the built-in rules combined with
 131 # install-data-hook to rename from stow.pdf to manual.pdf etc. on
 132 # install.  Instead, by overriding the built-in rules with modified
 133 # versions, we can kill both birds with one stone.
 134
 135 $(HTML): $(doc_deps)
 136         [ -d doc ] || mkdir doc # required in vpath mode
 137         -rm -f $@
 138         texi2html --P=$(srcdir) --output=$@ -expandinfo -menu -monolithic -verbose $<
 139
 140 $(PDF): $(doc_deps)
 141         TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \
 142         MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I doc -I $(srcdir)/doc' \
 143         $(TEXI2PDF) -o $@ `test -f 'doc/stow.texi' || echo '$(srcdir)/'`doc/stow.texi
 144
 145 doc/manual-split: $(doc_deps)
 146         rm -rf $@.new
 147         if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I doc -I $(srcdir)/doc \
 148          -o $@.new `test -f 'doc/stow.texi' || echo '$(srcdir)/'`doc/stow.texi; \
 149         then \
 150           rm -rf $@; \
 151           mv $@.new $@; \
 152         else \
 153           rm -Rf $@.new $@; \
 154           exit 1; \
 155         fi
 156
 157 # The split version of the manual is copied to $(docdir)/manual-split
 158 # by install-data-hook.  The whole subdirectory is included via
 159 # EXTRA_DIST in order to avoid having to list each file explicitly in
 160 # dist_doc_DATA, since automake doesn't support wildcards, and
 161 # dist_doc_DATA cannot refer to directories while EXTRA_DIST can (go
 162 # figure ...)
 163
 164 install-data-hook: doc/manual-split
 165         cp -r $(srcdir)/doc/manual-split $(DESTDIR)$(docdir)
 166
 167 uninstall-hook:
 168         chmod u+w -R $(DESTDIR)$(docdir)/manual-split
 169         rm -rf $(DESTDIR)$(docdir)/manual-split
 170
 171 # Using install-data-hook has the slightly annoying disadvantage that
 172 # by default the split version of the manual isn't automatically
 173 # rebuilt during development by a simple `make'.  A workaround hack
 174 # for this is to piggy-back the dependency onto manual-single.html,
 175 # which *is* automatically rebuilt by `make':
 176 $(HTML): doc/manual-split
 177
 178 # With the above hack, this probably isn't necessary but is safer to
 179 # keep in anyway:
 180 dist-hook: doc/manual-split
 181
 182 dist-hook: $(dist_man_MANS) ChangeLog
 183
 184 ChangeLog: doc/ChangeLog.OLD
 185         @if [ -d .git ]; then \
 186             ( \
 187                 git log \
 188                     --format="format:%ad  %aN <%aE>%n%n    * %w(70,0,4)%s%+b%n" \
 189                     --name-status \
 190                     v2.0.2..HEAD \
 191                 | sed 's/^\([A-Z]\)\t/      \1 /'; \
 192                 cat $< \
 193             ) > $@; \
 194             echo "Rebuilt $@ from git commit history."; \
 195         else \
 196             echo "Not in a git repository; can't update ChangeLog."; \
 197         fi