X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2FGNUmakefile;h=5994526b73e71ae9fcf2d94c0aa09ada0072c0d5;hb=2f996385b21b9d5006c7369c2c496ccbee001e97;hp=b586a9a4f59211a7c533f522c2a265759b6048f4;hpb=0af6d4cb04fa3e4aa69a7aecb76034e4cb1ec49b;p=lilypond.git diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index b586a9a4f5..5994526b73 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -1,83 +1,259 @@ -# Documentation/tex/Makefile - depth=../.. +LATEX_FILES =$(call src-wildcard,*.latex) -LATEX_FILES =$(wildcard *.latex) +EXTRA_DIST_FILES = $(LATEX_FILES) $(IMAGES) $(EPS_ILLUSTRATIONS) +EXTRA_DIST_FILES += README.txt writing-texinfo.txt policy.txt writing-sections.txt +IMAGES=$(call src-wildcard,*.png) +EPS_ILLUSTRATIONS=context-example.eps +PDF_ILLUSTRATIONS=context-example.pdf -# todo: add latex. -DVI_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.dvi)) +OUT_PDF_IMAGES=$(IMAGES:%.png=$(outdir)/%.pdf) $(addprefix $(outdir)/,$(PDF_ILLUSTRATIONS)) -EXTRA_DIST_FILES= $(LATEX_FILES) $(wildcard *.itexi *.itely) +OUT_PNG_IMAGES=$(OUT_PDF_IMAGES:%.pdf=%.png) -HTML_FILES = $(addprefix $(outdir)/, $(TELY_FILES:.tely=.html)) +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 -PS_FILES = $(DVI_FILES:.dvi=.ps) $(OUTDOC_FILES:.doc=.ps) $(OUTTEX_FILES:.tex=.ps) +# todo: add latex. +PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf) +# this prevents aux files from being reused for translated docs +TEXI2PDF_FLAGS = --tidy -PS_GZ_FILES= $(addsuffix .gz, $(PS_FILES)) +INFO_DOCS = lilypond lilypond-internals music-glossary lilypond-program lilypond-learning +INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info) -INFO_FILES = $(addprefix $(outdir)/, lilypond.info lilypond-internals.info) +ifeq ($(out),www) +INFO_IMAGES_DIR = lilypond +endif -STEPMAKE_TEMPLATES=tex texinfo documentation -LOCALSTEPMAKE_TEMPLATES=lilypond mudela +STEPMAKE_TEMPLATES=tex texinfo omf documentation +OMF_FILES += $(outdir)/lilypond-internals.html.omf -include $(depth)/make/stepmake.make +LOCALSTEPMAKE_TEMPLATES=lilypond ly -dvi: $(DVI_FILES) -ps: $(PS_FILES) +TEXINPUTS=$(top-src-dir)/tex:: +export TEXINPUTS + +include $(depth)/make/stepmake.make info: $(INFO_FILES) -default: + @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR) + @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. +# Viewable with a recent Emacs, doing: C-u C-h i out-www/lilypond.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 + +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: + +local-clean: + rm -f lilypond -DEEP_HTML_FILES = $(outdir)/lilypond/lilypond.html $(outdir)/lilypond-internals/lilypond-internals.html +local-help: extra-local-help -local-WWW: $(HTML_FILES) $(datafiles) $(PS_GZ_FILES) $(DEEP_HTML_FILES) - $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals - $(MAKE) footify - -mkdir $(outdir)/lilypond - ln -f $(outdir)/*.png $(outdir)/lilypond - $(MAKE) deep-footify +extra-local-help: + @echo -e "\ + info update info pages\n\ + ps update PostScript documents\n\ + xml update Docbook xml documentation\n\ +" -# $(PYTHON) $(step-bindir)/ls-latex.py --title 'User documentation' \ -# $(DOC_FILES) $(TEX_FILES) $(TELY_FILES) \ -# | sed "s!$(outdir)/!!g" > $(outdir)/index.html +# Generic rule using % twice not possible? +# $(outdir)/%/%.html: $(outdir)/%.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) -I$(outdir) --output=$@ --docbook $< + +$(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.texi + mkdir -p $(dir $@) + $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $< + +$(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) + +$(outdir)/%.png: %.png + convert -depth 8 -geometry 50x50% $< $@ + +$(outdir)/%.png: %.eps + gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit + +$(outdir)/%.pdf: %.png + convert -depth 8 $< $@ + +$(outdir)/%.pdf: %.eps + gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $< + + +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 + +# 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 + +$(outdir)/source: + @rm -f $(@) + ln -sf ../../ $(@) + +$(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 -localclean: - rm -f fonts.aux fonts.log feta*.tfm feta*.*pk -backdoc-WWW: $(outdir)/lilypond-internals/lilypond-internals.html - $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals +# lilypond.texi deps +$(top-build-dir)/mf/$(outconfbase)/feta16list.ly: + $(MAKE) -C $(top-src-dir)/mf -#ugh. lily/OUT/lilypond hardcoded. -# when cross-compiling, we don't have lilypond -$(outdir)/lilypond-internals.texi: - if [ -e $(depth)/$(builddir)/lily/out/lilypond ]; then \ - cd $(outdir) && ../$(depth)/$(builddir)/lily/out/lilypond ../$(src-depth)/ly/generate-documentation; \ - else \ - touch $@; \ - fi +$(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) -# Generic rule not possible? -# $(outdir)/%/%.html: $(outdir)/%.texi -$(outdir)/lilypond/lilypond.html: $(outdir)/lilypond.texi - -$(MAKEINFO) --force --output=$@ --html $< -# we want footers even if website builds (or is built) partly - $(deep-footify) $(sort $(wildcard $(outdir)/$(*F)/*.html)) +# 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/lilypond-internals.html: $(outdir)/lilypond-internals.texi - -$(MAKEINFO) --force --output=$@ --html $< -# we want footers even if website builds (or is built) partly - $(deep-footify) $(sort $(wildcard $(outdir)/$(*F)/*.html)) +$(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) && lilypond $(top-src-dir)/ly/generate-interface-doc