X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2FGNUmakefile;h=03f132c43c7cf881871f73f6a0c08c8540b4cced;hb=4d7f6d854d50a4bc9d374dbbd2f4a9d7bcb3b035;hp=bb78b9dbf2bfeda304a1ed4a108a90e0e4e40997;hpb=de658c9789658317b265eb7f3fd34a87c7a8f953;p=lilypond.git diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index bb78b9dbf2..03f132c43c 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -1,54 +1,131 @@ -# Documentation/tex/Makefile - depth=../.. +LATEX_FILES =$(call src-wildcard,*.latex) -LATEX_FILES =$(wildcard *.latex) -# todo: add latex. -DVI_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.dvi)) +EXTRA_DIST_FILES= $(LATEX_FILES) $(IMAGES) README.txt convert-ly.txt $(EPS_ILLUSTRATIONS) -EXTRA_DIST_FILES= $(LATEX_FILES) +IMAGES=$(call src-wildcard,*.png) +EPS_ILLUSTRATIONS=context-example.eps +PDF_ILLUSTRATIONS=context-example.pdf -HTML_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.html)) +OUT_PDF_IMAGES=$(IMAGES:%.png=$(outdir)/%.pdf) $(addprefix $(outdir)/,$(PDF_ILLUSTRATIONS)) -PS_FILES = $(DVI_FILES:.dvi=.ps) -PDF_FILES = $(DVI_FILES:.dvi=.pdf) +OUT_PNG_IMAGES=$(OUT_PDF_IMAGES:%.pdf=%.png) -PS_GZ_FILES= $(addsuffix .gz, $(PS_FILES)) +OUT_TEXI_FILES=$(ITEXI_FILES:%.itexi=$(outdir)/%.texi)\ + $(ITELY_FILES:%.itely=$(outdir)/%.texi) +HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%.html)\ + $(outdir)/lilypond-internals.html + +# todo: add latex. +PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf) INFO_DOCS = lilypond lilypond-internals music-glossary INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) STEPMAKE_TEMPLATES=tex texinfo omf documentation - +#TEXI2DVI_FLAGS = -E OMF_FILES += $(outdir)/lilypond-internals.html.omf LOCALSTEPMAKE_TEMPLATES=lilypond ly -LILYPOND_BOOK_FLAGS=--extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"' -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)) +TEXINPUTS=$(top-src-dir)/tex:: +export TEXINPUTS -dvi: $(DVI_FILES) +include $(depth)/make/stepmake.make -ps: $(PS_FILES) +info: $(INFO_FILES) -# Cancel the default info generation rule. We want to generate info -# from `.nexi', making sure we don't run LilyPond for inline pictures, -# when just generating info: +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/*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 $(package_infodir) && ln -sf $(webdir)/Documentation/user/*png .) +endif -$(outdir)/%.info: $(outdir)/%.texi +local-uninstall-WWW: + rm -f $(package_infodir)/*.png -default: +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 + + +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 @@ -57,44 +134,100 @@ extra-local-help: 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) $(OUT_EPS_IMAGES) 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) -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 $(OUT_PNG_IMAGES) + $(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=$(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.pdf: $(OUT_PDF_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)/%.png: %.eps + gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit -local-WWW: deep-symlinks +$(outdir)/%.pdf: %.png + convert $< $@ -deep-symlinks: - mkdir -p $(outdir)/lilypond - cd $(outdir)/lilypond && $(foreach i, $(LILYPOND_LINKS),\ - rm -f $(i) && ln -s lilypond.html $(i) &&) true +$(outdir)/%.pdf: %.eps + gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $< -endif +DEEP_HTML_FILES =\ + $(outdir)/lilypond/index.html\ + $(outdir)/lilypond-internals/index.html\ + $(outdir)/music-glossary/index.html + +# Symlinks to refer to external source documents from split and non-split HTML +source-links = $(outdir)/source $(outdir)/lilypond/source $(outdir)/music-glossary/source + +$(outdir)/source: + @rm -f $(@) + ln -sf ../../ $(@) + +$(outdir)/lilypond/source: + @rm -f $(@) + mkdir -p $(outdir)/lilypond + ln -sf ../../../ $(@) -local-WWW: $(HTML_FILES) $(datafiles) $(PDF_FILES) $(PS_GZ_FILES) $(DEEP_HTML_FILES) info-dir +$(outdir)/music-glossary/source: + @rm -f $(@) + mkdir -p $(outdir)/music-glossary + ln -sf ../../../ $(@) + +local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\ + $(datafiles) $(PDF_FILES) $(source-links) info info-dir local-WWW-clean: deep-WWW-clean @@ -102,48 +235,45 @@ 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 -f fonts.aux fonts.log feta*.tfm feta*.*pk + 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 -# Rules for the automatically generated documentation -# When cross-compiling, we don't have lilypond, so we fake -ifneq ($(CROSS),yes) +$(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 -# 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: $(builddir)/lily/$(outconfbase)/lilypond - cd $(outdir) && $(builddir)/lily/$(outconfbase)/lilypond --verbose $(abs-srcdir)/ly/generate-documentation +$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: $(LILYPOND_BINARY) + cd $(outdir) && $(LILYPOND_BINARY) --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) && $(builddir)/lily/$(outconfbase)/lilypond $(abs-srcdir)/ly/generate-interface-doc + cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc -else - -$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: - touch $@ - touch $(outdir)/$(*F).nexi - -$(outdir)/interfaces.itexi: - cp dummy-interfaces.itexi $@ -endif +local-clean: local-delete +local-delete: + find $(outdir)/ -name 'lily-[0-9]*' | xargs rm -f + -rm -f $(outdir)/*