X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2FGNUmakefile;h=de0b41538cc516b0c15d208847185233565c88ad;hb=078703a6ab29f75983a55ac2cc35fe5f315da574;hp=2c30d360d43c8968443bef5b17f14e80b574b871;hpb=be6b7669873b8b227c224e9ff1e1e101c43426df;p=lilypond.git diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index 2c30d360d4..de0b41538c 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -1,91 +1,227 @@ -# Documentation/tex/Makefile - depth=../.. - -LATEX_FILES =$(wildcard *.latex) +LATEX_FILES =$(call src-wildcard,*.latex) # todo: add latex. -DVI_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.dvi)) +DVI_FILES = $(TELY_FILES:%.tely=$(outdir)/%.dvi) -EXTRA_DIST_FILES= $(LATEX_FILES) +EXTRA_DIST_FILES= $(LATEX_FILES) $(IMAGES) +IMAGES=$(call src-wildcard,*.png) -HTML_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.html)) +OUT_EPS_IMAGES=$(IMAGES:%.png=$(outdir)/%.eps) +OUT_PNG_IMAGES=$(IMAGES:%=$(outdir)/%) +OUT_TEXI_FILES=$(ITEXI_FILES:%.itexi=$(outdir)/%.texi)\ + $(ITELY_FILES:%.itely=$(outdir)/%.texi) +HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%.html)\ + $(outdir)/lilypond-internals.html PS_FILES = $(DVI_FILES:.dvi=.ps) +PDF_FILES = $(DVI_FILES:.dvi=.pdf) PS_GZ_FILES= $(addsuffix .gz, $(PS_FILES)) -INFO_FILES = $(addprefix $(outdir)/, lilypond.info lilypond-internals.info) +INFO_DOCS = lilypond lilypond-internals music-glossary +INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) + +STEPMAKE_TEMPLATES=tex texinfo omf documentation + +OMF_FILES += $(outdir)/lilypond-internals.html.omf -STEPMAKE_TEMPLATES=tex texinfo documentation LOCALSTEPMAKE_TEMPLATES=lilypond ly -# Hmm, what about? -# local-dist: check-info -info: check-info +TEXINPUTS=$(top-src-dir)/tex:: +export TEXINPUTS include $(depth)/make/stepmake.make -# Ugh,ugh. -# emacs cannot fix the menu structure when @mbinclude is used -# lilypond.tely uses mbinclude -TEXINFO_SOURCES := $(filter-out lilypond.tely, $(TEXINFO_SOURCES)) - dvi: $(DVI_FILES) ps: $(PS_FILES) +info: $(INFO_FILES) + +pathsettings: + @echo export PATH=$(PATH) + @echo export LILYPONDPREFIX=$(LILYPONDPREFIX) + @echo export PYTHONPATH=$(PYTHONPATH) + +xml: $(outdir)/lilypond/lilypond.xml $(outdir)/lilypond-internals/lilypond-internals.xml + +# There are two modes for info: with and without images. +ifeq ($(out),www) + +# This builds all .info targets with images, in out-www. +# Viewawble with a recent Emacs, doing: M-x info out-www/lilypond.info + +# Cancel the special, non-image info generation rule that skips images: +$(outdir)/%.info: $(outdir)/%.nexi + +local-install-info: info + -$(INSTALL) -d $(DESTDIR)$(package_infodir) +ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr) +## Can not have absolute symlinks because some binary packages build schemes +## install files in nonstandard root. Best we can do is to notify the +## builder or packager. + @echo + @echo "***************************************************************" + @echo "Please add or update the LilyPond direntries, do" + @echo + @echo " install-info --info-dir=$(infodir) $(outdir)/lilypond.info" + @echo + @echo "For images in the INFO docs to work, do: " + @echo + @echo " (cd $(package_infodir) && ln -sf ../../doc/lilypond/Documentation/user/out-www/*png .)" + @echo "or add something like that to the postinstall script." + @echo +else + -$(INSTALL) -d $(DESTDIR)$(package_infodir) + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info + install-info --info-dir=$(infodir) $(outdir)/lilypond.info + (cd $(lilypond_infodir) && ln -sf $(webdir)/Documentation/user/out-www/*png .) +endif + +local-uninstall-WWW: + rm -f $(package_infodir)/*.png + +else + +# Cancel the default info generation rule that generates images: +$(outdir)/%.info: # $(outdir)/%.texi + +local-install-info: info + -$(INSTALL) -d $(DESTDIR)$(package_infodir) +ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr) +## Can not have absolute symlinks because some binary packages build schemes +## install files in nonstandard root. Best we can do is to notify the +## builder or packager. + @echo + @echo "***************************************************************" + @echo "Please add or update the LilyPond direntries, do" + @echo + @echo " install-info --info-dir=$(infodir) out/lilypond.info" + @echo + @echo "For images in the INFO docs to work, do" + @echo + @echo " make out=www install-info " + @echo + @echo "and read the extra instructions." + @echo +else + -$(INSTALL) -d $(DESTDIR)$(package_infodir) + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info + install-info --info-dir=$(infodir) $(outdir)/lilypond.info + @echo + @echo "***************************************************************" + @echo "For images in the INFO docs to work, do" + @echo + @echo " make out=www install-info " + @echo +endif -# Cancel default info generation rule. We want to generate info from -# `.nexi', making sure we don't run LilyPond for inline pictures, when -# generating info. -$(outdir)/%.info: $(outdir)/%.texi + +endif + +# All web targets, except info image symlinks and info docs are +# installed in non-recursing target from TOP-SRC-DIR +local-install-WWW: local-install-info +local-uninstall-WWW: local-uninstall-info default: -# Info is now built by default via texinfo-rules. -# We must build them by default, otherwise they get built during make install -info: $(INFO_FILES) +local-help: extra-local-help + +extra-local-help: + @echo -e "\ + dvi update dvi documents\n\ + info update info pages\n\ + ps update PostScript documents\n\ + xml update Docbook xml documentation\n\ +" # Generic rule using % twice not possible? # $(outdir)/%/%.html: $(outdir)/%.texi -$(outdir)/lilypond/lilypond.html: $(outdir)/lilypond.texi +$(outdir)/lilypond.texi: $(outdir)/lilypond-internals.texi +$(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi + +# +# The split user manual +# +$(outdir)/lilypond/index.html: $(outdir)/lilypond.texi $(OUT_PNG_IMAGES) + mkdir -p $(dir $@) + $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< + find $(outdir)/lilypond/ -name '*'.png -o -name '*'.ly | xargs rm -f +# symbolic links to save space + (cd $(outdir)/lilypond/ ; ln -sf ../*.png ../*.ly . ) + +# +# One big page manual +# +$(outdir)/lilypond.html: $(outdir)/lilypond.texi + $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $< + +# +# The split internals reference +# +$(outdir)/lilypond-internals/index.html: $(outdir)/lilypond-internals.texi mkdir -p $(dir $@) - $(MAKEINFO) --output=$@ --html $< - -cp -f $(outdir)/*.png $(outdir)/lilypond - -cp -f $(outdir)/lilypond/index.html $@ - $(deep-footify) $(shell find $(outdir)/$(*F)/*.html) + $(MAKEINFO) --output=$(outdir)/lilypond-internals --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< + +# +# One big page internals reference +# +$(outdir)/lilypond-internals.html: $(outdir)/lilypond-internals.texi + $(MAKEINFO) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split --no-headers $< + +# +# The split glossary +# +$(outdir)/music-glossary/index.html: $(outdir)/music-glossary.texi + mkdir -p $(dir $@) + $(MAKEINFO) --output=$(outdir)/music-glossary --css-include=$(top-src-dir)/Documentation/texinfo.css --html $< + find $(outdir)/music-glossary/ -name '*'.png -o -name '*'.ly | xargs rm -f +# symbolic links to save space + (cd $(outdir)/music-glossary/ ; ln -sf ../*.png ../*.ly . ) -$(outdir)/lilypond-internals/lilypond-internals.html: $(outdir)/lilypond-internals.texi +$(outdir)/lilypond.xml: $(outdir)/lilypond.texi mkdir -p $(dir $@) - $(MAKEINFO) --output=$@ --html $< - -cp -f $(outdir)/*.png $(outdir)/lilypond-internals - -cp -f $(outdir)/lilypond-internals/index.html $@ - $(deep-footify) $(shell find $(outdir)/$(*F)/*.html) + $(MAKEINFO) -I$(outdir) --output=$@ --docbook $< -ifeq ($(SPLITTING_MAKEINFO),yes) +$(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.texi + mkdir -p $(dir $@) + $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $< -DEEP_HTML_FILES = $(outdir)/lilypond/lilypond.html $(outdir)/lilypond-internals/lilypond-internals.html +$(outdir)/lilypond.dvi: $(OUT_EPS_IMAGES) $(OUT_PNG_IMAGES) -else +$(outdir)/%.png: %.png + convert -geometry 50x50% $< $@ -# Links referred to by Documentation index -LILYPOND_LINKS=Reference-Manual.html Tutorial.html Ly2dvi.html Midi2ly.html +$(outdir)/%.eps: %.png + convert $< $@ -local-WWW: deep-symlinks +DEEP_HTML_FILES =\ + $(outdir)/lilypond/index.html\ + $(outdir)/lilypond-internals/index.html\ + $(outdir)/music-glossary/index.html -deep-symlinks: - mkdir -p $(outdir)/lilypond - cd $(outdir)/lilypond && $(foreach i, $(LILYPOND_LINKS),\ - rm -f $(i) && ln -s lilypond.html $(i) &&) true +# Symlinks to refer to external source documents from split and non-split HTML +source-links = $(outdir)/source $(outdir)/lilypond/source $(outdir)/music-glossary/source -endif +$(outdir)/source: + @rm -f $(@) + ln -sf ../../../ $(@) +$(outdir)/lilypond/source: + @rm -f $(@) + ln -sf ../../../../ $(@) -local-WWW: $(HTML_FILES) $(datafiles) $(PS_GZ_FILES) $(DEEP_HTML_FILES) info-dir +$(outdir)/music-glossary/source: + @rm -f $(@) + ln -sf ../../../../ $(@) + +local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\ + $(datafiles) $(PDF_FILES) $(source-links) info info-dir local-WWW-clean: deep-WWW-clean @@ -93,39 +229,44 @@ deep-WWW-clean: rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals info-dir: - $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals - $(MAKE) footify - $(MAKE) deep-footify + $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary $(outdir)/%.bib: %.bib ln -f $< $@ -# we want footers even if website builds (or is built) partly - $(MAKE) footify local-clean: rm -f fonts.aux fonts.log feta*.tfm feta*.*pk - rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals + rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals $(outdir)/music-glossary -#$(outdir)/lilypond.nexi: $(outdir)/interfaces.itexi -#$(outdir)/lilypond.texi: $(outdir)/interfaces.itexi +# lilypond.texi deps +$(top-build-dir)/mf/$(outconfbase)/feta16list.ly: + $(MAKE) -C $(top-src-dir)/mf + +$(outdir)/lilypond.texi: $(ITELY_FILES) $(ITEXI_FILES) +$(outdir)/lilypond.nexi: $(ITELY_FILES) $(ITEXI_FILES) + +# Prevent building music-glossary.texi from default target +$(outdir)/music-glossary.nexi: # Rules for the automatically generated documentation # When cross-compiling, we don't have lilypond, so we fake ifneq ($(CROSS),yes) -# there used to be a dependency on a dummy target, to force a rebuild of lilypond-internals every time. -# however, this triggers compilation during install, which is a bad thing (tm). +# There used to be a dependency on a dummy target, to force a rebuild +# of lilypond-internals every time. however, this triggers +# compilation during install, which is a bad thing (tm). -$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: $(depth)/$(builddir)/lily/$(outconfbase)/lilypond - cd $(outdir) && ../$(depth)/$(builddir)/lily/$(outconfbase)/lilypond ../$(src-depth)/ly/generate-documentation +$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: $(top-build-dir)/lily/$(outconfbase)/lilypond + cd $(outdir) && $(top-build-dir)/lily/$(outconfbase)/lilypond --verbose $(top-src-dir)/ly/generate-documentation + rm -f $(outdir)/lilypond-internals.nexi -ln $(outdir)/lilypond-internals.texi $(outdir)/lilypond-internals.nexi ## unused $(outdir)/interfaces.itexi: dummy - cd $(outdir) && ../$(depth)/$(builddir)/lily/$(outconfbase)/lilypond ../$(src-depth)/ly/generate-interface-doc + cd $(outdir) && $(top-build-dir)/lily/$(outconfbase)/lilypond $(top-src-dir)/ly/generate-interface-doc else @@ -133,7 +274,12 @@ $(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: touch $@ touch $(outdir)/$(*F).nexi -$(outdir)/interfaces.itexi: +$(outdir)/programming-interface.texi: cp dummy-interfaces.itexi $@ endif +local-clean: local-delete + +local-delete: + find $(outdir)/ -name 'lily-[0-9]*' | xargs rm -f + -rm -f $(outdir)/*