X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/e3e5784ec6910ef4529d3193f13fc4dd0588543b..a607fe54c9f20934b57e29e9040b9dd0a4decf3a:/doc/Makefile diff --git a/doc/Makefile b/doc/Makefile index 2fac0bc6..89b4be92 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,22 +1,63 @@ +all: man index.html + +# Decide on the versionid policy. +# +# If the user has passed in $(VERSION) on the command line (`make +# VERSION="Release 0.56"'), we use that as an explicit version +# string. Otherwise, we use `svnversion' to examine the checked-out +# documentation source, and if that returns a single revision +# number then we invent a version string reflecting just that +# number. Failing _that_, we resort to versionids.but which shows a +# $Id for each individual file. +# +# So here, we define VERSION using svnversion if it isn't already +# defined ... +ifndef VERSION +SVNVERSION=$(shell test -d .svn && svnversion .) +BADCHARS=$(findstring :,$(SVNVERSION))$(findstring S,$(SVNVERSION)) +ifeq ($(BADCHARS),) +ifneq ($(SVNVERSION),) +ifneq ($(SVNVERSION),exported) +VERSION=Built from revision $(patsubst M,,$(SVNVERSION)) +endif +endif +endif +endif +# ... and now, we condition our build behaviour on whether or not +# VERSION _is_ defined. +ifdef VERSION +VERSIONIDS=vstr +vstr.but: FORCE + echo \\versionid $(VERSION) > vstr.but +FORCE:; +else +VERSIONIDS=vids +endif + CHAPTERS := $(SITE) blurb intro gs using config pscp psftp plink pubkey -CHAPTERS += pageant errors faq feedback licence +CHAPTERS += pageant errors faq feedback licence udp pgpkeys sshnames +CHAPTERS += index $(VERSIONIDS) INPUTS = $(patsubst %,%.but,$(CHAPTERS)) # This is temporary. Hack it locally or something. -HALIBUT = $(HOME)/src/halibut/build/halibut +HALIBUT = halibut + +index.html: $(INPUTS) + $(HALIBUT) --text --html --winhelp $(INPUTS) + +# During formal builds it's useful to be able to build this one alone. +putty.hlp: $(INPUTS) + $(HALIBUT) --winhelp $(INPUTS) -all: Contents.html man +putty.info: $(INPUTS) + $(HALIBUT) --info $(INPUTS) -Contents.html: $(INPUTS) - $(HOME)/src/halibut/build/halibut $(INPUTS) - rm -f index.html - ln -s Contents.html index.html - mv output.txt puttydoc.txt - mv output.hlp putty.hlp - mv output.cnt putty.cnt +chm: putty.hhp +putty.hhp: $(INPUTS) chm.but + $(HALIBUT) --html $(INPUTS) chm.but -MKMAN = $(HOME)/src/halibut/build/halibut mancfg.but $< && mv output.1 $@ +MKMAN = $(HALIBUT) --man=$@ mancfg.but $< MANPAGES = putty.1 puttygen.1 plink.1 pscp.1 psftp.1 puttytel.1 pterm.1 man: $(MANPAGES) @@ -28,5 +69,7 @@ psftp.1: man-psft.but mancfg.but; $(MKMAN) puttytel.1: man-ptel.but mancfg.but; $(MKMAN) pterm.1: man-pter.but mancfg.but; $(MKMAN) -clean: - rm -f *.html *.txt *.hlp *.cnt *.1 +mostlyclean: + rm -f *.html *.txt *.hlp *.cnt *.1 *.info vstr.but *.hh[pck] +clean: mostlyclean + rm -f *.chm