X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2FGNUmakefile;h=e0cff00614c63a7979523977678fa1266976edd2;hb=ece2e45d587f63565e81af44e1937ebe1f5e47a8;hp=120d24d2a541fc31ab385c5c870c3c1022edfb89;hpb=30c886ed7719a722a55787f955de5b28cc99517c;p=lilypond.git diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index 120d24d2a5..a5b0b864b5 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -1,140 +1,259 @@ -# 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) $(EPS_ILLUSTRATIONS) +EXTRA_DIST_FILES += README.txt writing-texinfo.txt policy.txt -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)/%-big-page.html)\ + $(outdir)/lilypond-internals-big-page.html + +# todo: add latex. +PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf) +# this prevents aux files from being reused for translated docs +TEXI2PDF_FLAGS = --tidy + +INFO_DOCS = lilypond lilypond-internals music-glossary lilypond-program lilypond-learning +INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) + +ifeq ($(out),www) +INFO_IMAGES_DIR = lilypond +endif -INFO_FILES = $(addprefix $(outdir)/, lilypond.info lilypond-internals.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 # -> reinstate when actively hacking doco. +TEXINPUTS=$(top-src-dir)/tex:: +export TEXINPUTS -include $(depth)/make/stepmake.make +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)) +info: $(INFO_FILES) + + @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR) + @echo export PYTHONPATH=$(PYTHONPATH) -dvi: $(DVI_FILES) +xml: $(outdir)/lilypond/lilypond.xml $(outdir)/lilypond-internals/lilypond-internals.xml -ps: $(PS_FILES) +# There are two modes for info: with and without images. +ifeq ($(out),www) +# This builds all .info targets with images, in out-www. +# Viewable with a recent Emacs, doing: C-u C-h i out-www/lilypond.info -# 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. +# Cancel the special, non-image info generation rule that skips images: +$(outdir)/%.info: $(outdir)/%.nexi + +# "makeinfo --info" MUST be able to read PNGs from CWD for info images +# to work, hence lilypond/ -> $(outdir)/ symlink. +# $(outdir)/lilypond/*.png symlinks are only needed to view +# out-www/*.info with Emacs -- HTML docs no longer need these +# symlinks, see replace_symlinks_urls in +# buildscripts/add_html_footer.py. +$(outdir)/%.info: lilypond +lilypond: $(OUT_PNG_IMAGES) + rm -f lilypond + ln -s $(outdir) lilypond + mkdir -p $(outdir)/lilypond + find $(outdir)/lilypond/ -name '*'.png | xargs rm -f + (cd $(outdir)/lilypond/ ; ln -sf ../*.png . ) + +local-install-info: info + -$(INSTALL) -d $(DESTDIR)$(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 $(infodir) && ln -sfT ../doc/lilypond/html/Documentation/user lilypond)" + @echo "or add something like that to the postinstall script." + @echo +else # installing directly into standard /usr/... + -$(INSTALL) -d $(DESTDIR)$(infodir) + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-program.info + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-learning.info + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-internals.info + -install-info --remove --info-dir=$(infodir) $(outdir)/music-glossary.info + install-info --info-dir=$(infodir) $(outdir)/lilypond.info + cd $(infodir) && ln -sfT $(webdir)/Documentation/user lilypond +endif # installing directly into standard /usr/... + +local-uninstall-WWW: + rm -f $(infodir)/lilypond + +else # out!=www + +# Cancel the default info generation rule that generates images: $(outdir)/%.info: $(outdir)/%.texi -default: +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 # installing directly into standard /usr/... + -$(INSTALL) -d $(DESTDIR)$(infodir) + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-program.info + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-learning.info + -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-internals.info + -install-info --remove --info-dir=$(infodir) $(outdir)/music-glossary.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 # installing into standard /usr/* root# installing into /usr/... + +endif # out!=www + +# 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-clean: + rm -f lilypond + +local-help: extra-local-help +extra-local-help: + @echo -e "\ + 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 + +# +# Split manuals in HTML +# +$(outdir)/lilypond/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) +$(outdir)/lilypond-program/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) +$(outdir)/lilypond-learning/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) +$(outdir)/music-glossary/index.html: $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES) + + +# +# Manuals in one big HTML page +# +$(outdir)/lilypond-big-page.html: $(OUT_PNG_IMAGES) +$(outdir)/lilypond-program-big-page.html: $(OUT_PNG_IMAGES) +$(outdir)/lilypond-learning-big-page.html: $(OUT_PNG_IMAGES) + +$(outdir)/lilypond.xml: $(outdir)/lilypond.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) -I$(outdir) --output=$@ --docbook $< -$(outdir)/lilypond-internals/lilypond-internals.html: $(outdir)/lilypond-internals.texi +$(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.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) --output=$(outdir)/lilypond-internals --docbook $< -ifeq ($(SPLITTING_MAKEINFO),yes) +$(outdir)/lilypond.pdf $(outdir)/lilypond-program.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES) +$(outdir)/lilypond-learning.pdf $(outdir)/music-glossary.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES) -DEEP_HTML_FILES = $(outdir)/lilypond/lilypond.html $(outdir)/lilypond-internals/lilypond-internals.html +$(outdir)/%.png: %.png + convert -depth 8 -geometry 50x50% $< $@ -else +$(outdir)/%.png: %.eps + gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit -# Links referred to by Documentation index -LILYPOND_LINKS=Reference-Manual.html Tutorial.html Ly2dvi.html Midi2ly.html +$(outdir)/%.pdf: %.png + convert -depth 8 $< $@ -local-WWW: deep-symlinks - -deep-symlinks: - mkdir -p $(outdir)/lilypond - cd $(outdir)/lilypond && $(foreach i, $(LILYPOND_LINKS),\ - rm -f $(i) && ln -s lilypond.html $(i) &&) true - -endif +$(outdir)/%.pdf: %.eps + gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $< -local-WWW: $(HTML_FILES) $(datafiles) $(PDF_FILES) $(PS_GZ_FILES) $(DEEP_HTML_FILES) info-dir +DEEP_HTML_FILES =\ + $(outdir)/lilypond/index.html\ + $(outdir)/lilypond-internals/index.html\ + $(outdir)/music-glossary/index.html\ + $(outdir)/lilypond-program/index.html\ + $(outdir)/lilypond-learning/index.html -local-WWW-clean: deep-WWW-clean +# 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)/lilypond-program/source $(outdir)/lilypond-learning/source -deep-WWW-clean: - rm -rf $(outdir)/lilypond $(outdir)/lilypond-internals +$(outdir)/source: + @rm -f $(@) + ln -sf ../../ $(@) -info-dir: - $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals - $(MAKE) footify - $(MAKE) deep-footify +$(outdir)/%/source: + @rm -f $(@) + mkdir -p $(dir $@) + ln -sf ../../../ $(@) +local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\ + $(datafiles) $(PDF_FILES) $(source-links) info $(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 -#$(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 $(outdir)/lilypond-program.texi $(outdir)/lilypond-learning.texi: $(ITELY_FILES) $(ITEXI_FILES) +$(outdir)/lilypond.nexi $(outdir)/lilypond-program.nexi $(outdir)/lilypond-learning.nexi: $(ITELY_FILES) $(ITEXI_FILES) -# 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). +# 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). -$(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 - -else - -$(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: - touch $@ - touch $(outdir)/$(*F).nexi - -$(outdir)/interfaces.itexi: - cp dummy-interfaces.itexi $@ -endif - + cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc