Documentation/GNUmakefile

   1 depth = ..
   2
   3 ########################
   4 #  Documentation build #
   5 ########################
   6
   7 #############
   8 ### Variables
   9
  10 NAME = documentation
  11 LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py)
  12 MANUALS_SUBDIRS = usage contributor essay \
  13   web learning notation extending
  14 SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs \
  15   included $(LANGS)
  16 STEPMAKE_TEMPLATES = documentation texinfo tex omf
  17 LOCALSTEPMAKE_TEMPLATES = lilypond ly
  18
  19 ### Extra flags
  20
  21 LILYPOND_BOOK_FLAGS = --extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
  22 TEXI2PDF_FLAGS = \
  23   -I $(outdir) \
  24   -I $(top-build-dir)/Documentation/$(outconfbase)
  25 $(outdir)/snippets-big-page.html: TEXI2HTML_FLAGS += -D short_toc
  26 $(outdir)/snippets/index..html: TEXI2HTML_FLAGS += -D short_toc
  27
  28 ### Extra source files
  29
  30 README_TOP_FILES= DEDICATION THANKS
  31
  32 IN_ITELY_FILES = $(call src-wildcard,snippets/*-intro.itely)
  33 SNIPPET_LY_FILES = $(call src-wildcard,snippets/*.ly)
  34
  35 EXTRA_DIST_FILES = $(call src-wildcard,*.init) $(call src-wildcard,*.bst)
  36
  37 ### Out files
  38
  39 # Dependencies
  40 GENERATED_ITELY_FILES = $(IN_ITELY_FILES:snippets/%-intro.itely=$(outdir)/%.itely)
  41
  42 XREF_MAPS_FILES += $(XREF_MAPS_DIR)/internals.xref-map
  43 OMF_FILES += $(outdir)/internals.html.omf $(outdir)/internals.pdf.omf
  44
  45 # Main manuals
  46 TEXINFO_MANUALS = internals\
  47  $(TELY_FILES:%.tely=%)\
  48  $(TEXI_FILES:%.texi=%)
  49 OUT_TEXINFO_MANUALS = $(TEXINFO_MANUALS:%=$(outdir)/%.texi)
  50
  51 ## CHAIN_RULE hack: keep the following line *before* including
  52 # stepmake.make, so the Internals Reference is built before the
  53 # Notation Reference, thus providing automatically generated sections
  54 # of the NR
  55 TEXI_FILES_FROM_TELY = $(outdir)/internals.texi
  56
  57 PDF_FILES = $(TEXINFO_MANUALS:%=$(outdir)/%.pdf)
  58
  59 TOPDIR_HTML_MANUALS =
  60 UNSPLIT_HTML_MANUALS =
  61 SPLIT_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\
  62  $(if $(findstring $(manual), $(UNSPLIT_HTML_MANUALS)),,$(manual)))
  63 NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLIT_HTML_MANUALS),\
  64  $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual)))
  65
  66 OUT_HTML_FILES = $(UNSPLIT_HTML_MANUALS:%=$(outdir)/%.html)\
  67  $(SPLIT_HTML_MANUALS:%=$(outdir)/%-big-page.html)
  68 DEEP_HTML_FILES = $(NOT_TOPDIR_HTML_MANUALS:%=$(outdir)/%/index.html)
  69
  70 # Symlinks to refer to external source documents from split and non-split HTML
  71 source-links = $(outdir)/source\
  72  $(foreach manual, $(SPLIT_HTML_MANUALS), $(outdir)/$(manual)/source)
  73
  74 # Other out files
  75
  76 MAIN_INFO_DOC = lilypond-web
  77 INFO_DOCS = lilypond-usage lilypond-changes lilypond-contributor lilypond-internals \
  78  lilypond-essay lilypond-learning lilypond-notation music-glossary \
  79  lilypond-web lilypond-extending
  80 ifeq ($(out),www)
  81 INFO_DOCS += lilypond-snippets
  82 endif
  83 INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info)
  84
  85 ifeq ($(out),www)
  86 INFO_IMAGES_DIR = lilypond
  87 DEST_INFO_IMAGES_SUBDIR = Documentation
  88 endif
  89
  90 include $(depth)/make/stepmake.make
  91
  92 OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
  93
  94
  95 ### Web site idiosyncrasies
  96 $(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
  97
  98 ### AJAX scripts
  99 JS_FILES = $(call src-wildcard,*.js)
 100 PHP_FILES = $(call src-wildcard,*.php)
 101 EXTRA_DIST_FILES += $(JS_FILES) $(PHP_FILES)
 102
 103 OUT_JS_FILES = $(JS_FILES:%.js=$(outdir)/%.js)
 104 OUT_PHP_FILES = $(PHP_FILES:%.php=$(outdir)/%.php)
 105
 106
 107
 108 ### bad hack for badly-integrated roadmap.
 109 $(outdir)/ROADMAP:
 110         cp $(top-src-dir)/ROADMAP $(outdir)
 111 $(outdir)/contributor.texi: $(outdir)/ROADMAP
 112
 113 ### bad hack for badly-integrated bibliography
 114 $(outdir)/colorado.itexi:
 115         BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
 116                 -s $(top-src-dir)/Documentation/lily-bib \
 117                 -o $(outdir)/colorado.itexi \
 118                 $(src-dir)/essay/colorado.bib
 119
 120 $(outdir)/computer-notation.itexi:
 121         BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
 122                 -s $(top-src-dir)/Documentation/lily-bib \
 123                 -o $(outdir)/computer-notation.itexi \
 124                 $(src-dir)/essay/computer-notation.bib
 125
 126 $(outdir)/engravingbib.itexi:
 127         BSTINPUTS=$(src-dir)/essay $(buildscript-dir)/bib2texi \
 128                 -s $(top-src-dir)/Documentation/lily-bib \
 129                 -o $(outdir)/engravingbib.itexi \
 130                 $(src-dir)/essay/engravingbib.bib
 131
 132 $(outdir)/essay.texi: \
 133   $(outdir)/colorado.itexi \
 134   $(outdir)/computer-notation.itexi \
 135   $(outdir)/engravingbib.itexi
 136
 137 $(outdir)/others-did.itexi:
 138         BSTINPUTS=$(src-dir)/web/ $(buildscript-dir)/bib2texi \
 139                 -s $(top-src-dir)/Documentation/lily-bib \
 140                 -o $(outdir)/others-did.itexi \
 141                 $(src-dir)/web/others-did.bib
 142
 143 $(outdir)/we-wrote.itexi:
 144         BSTINPUTS=$(src-dir)/web/ $(buildscript-dir)/bib2texi \
 145                 -s $(top-src-dir)/Documentation/lily-bib \
 146                 -o $(outdir)/we-wrote.itexi \
 147                 $(src-dir)/web/we-wrote.bib
 148
 149
 150 ###########
 151 ### Targets
 152
 153 default: local-txt-doc
 154
 155 local-help: extra-local-help
 156
 157 extra-local-help:
 158         @echo "  check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
 159         @echo "  fix-xrefs [ISOLANG=LL]   interactively fix Texinfo cross-references"
 160         @echo "                             (use with caution)"
 161         @echo "  info                     update info pages"
 162         @echo "  xml                      update Docbook xml documentation"
 163         @echo
 164         @echo "Translations specific targets (see TRANSLATION for details):"
 165         @echo "  new-lang ISOLANG=LL           create and initialize"
 166         @echo "                                  subdirectory \'LL' for language \'LL"
 167         @echo "                                  (if \'LL exists, update missing file)"
 168         @echo "  po-update                     update and replace PO files for"
 169         @echo "                                  documentation with msgmerged versions"
 170         @echo "  check-translation ISOLANG=LL  show changes in English docs since"
 171         @echo "                                  last translation update"
 172         @echo "  update-translation ISOLANG=LL call $$$$EDITOR to help updating"
 173         @echo "                                  the translation"
 174         @echo "  snippet-update ISOLANG=LL     update ly snippets in Texinfo translation"
 175         @echo "                                  according to docs in English"
 176         @echo "                                  (use with caution)"
 177         @echo
 178         @echo "  LL refers to the desired locale"
 179         @echo "    (most often only the ISO 639 language code)."
 180         @echo
 181
 182 info: $(INFO_FILES)
 183         @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
 184         @echo export PYTHONPATH=$(PYTHONPATH)
 185
 186 xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
 187
 188
 189 local-clean:
 190         rm -f $(INFO_IMAGES_DIR)
 191
 192 ### Web targets
 193
 194 ifeq ($(out),www)
 195 local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
 196
 197 ifeq ($(AJAX_SEARCH),1)
 198 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(OUT_JS_FILES) $(OUT_PHP_FILES) $(source-links) $(OMF_FILES)
 199 else
 200 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
 201 endif
 202
 203 endif
 204
 205
 206 #########
 207 ### Rules
 208
 209 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi
 210         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
 211
 212 # cd $(outdir) rule gets bit hairy for --srcdir configure builds
 213 txt-to-html:
 214         $(foreach a, $(README_TOP_FILES), cp $(top-src-dir)/$(a) $(outdir)/$(a).txt && ) true
 215         $(PYTHON) $(step-bindir)/text2html.py $(OUT_TXT_FILES)
 216
 217 ifeq ($(out),www)
 218 ## Extra images dependencies
 219 $(OUT_TEXINFO_MANUALS): $(outdir)/pictures
 220
 221 $(outdir)/pictures:
 222         $(MAKE) -C pictures WWW-1
 223         ln -sf ../pictures/$(outdir) $@
 224
 225 $(outdir)/ly-examples:
 226         $(MAKE) -C web/ly-examples
 227         ln -sf ../web/ly-examples/$(outdir) $@
 228 endif
 229
 230 ifeq ($(out),www)
 231 $(outdir)/web.texi: $(outdir)/ly-examples $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi
 232 else
 233 # duplicate (without ly-examples)
 234 $(outdir)/web.texi: $(outdir)/we-wrote.itexi $(outdir)/others-did.itexi
 235 endif
 236
 237
 238 # Ugh, using '%' twice not possible
 239 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
 240         mkdir -p $(dir $@)
 241         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
 242
 243 $(outdir)/internals/internals.xml: $(outdir)/internals.texi
 244         mkdir -p $(dir $@)
 245         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
 246
 247 $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
 248
 249 $(foreach manual, $(MANUAL_SUBDIRS),\
 250 $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
 251
 252
 253
 254 $(outdir)/source:
 255         @rm -f $(@)
 256         ln -sf $(depth) $(@)
 257
 258 $(outdir)/%/source:
 259         @rm -f $(@)
 260         mkdir -p $(dir $@)
 261         ln -sf $(depth)/.. $(@)
 262
 263
 264 ## Snippets rules idiosyncrasies
 265 $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
 266         xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
 267
 268 $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
 269
 270 $(outdir)/%.bib: %.bib
 271         ln -f $< $@
 272
 273 $(outdir)/%.js: %.js
 274         ln -f $< $@
 275
 276 $(outdir)/%.php: %.php
 277         ln -f $< $@
 278
 279 ## notation.texi deps
 280 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
 281         $(MAKE) -C $(top-src-dir)/mf
 282
 283 $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
 284
 285 ## Rules for the automatically generated documentation
 286 $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
 287         cd $(outdir) && $(BISON) -v $<
 288         $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
 289
 290 # There used to be a dependency on a dummy target, to force a rebuild
 291 # of internals every time.  however, this triggers
 292 # compilation during install, which is a bad thing (tm).
 293
 294 $(outdir)/internals.texi: $(LILYPOND_BINARY)
 295         cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
 296
 297
 298 ###############################################
 299 #  Documentation and translations maintenance #
 300 ###############################################
 301 po-update:
 302         make -C po po-update
 303
 304 all-translations-update: po-update translation-status
 305         $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true
 306
 307 ifneq ($(NO_COLOR),)
 308 CHECK_TRANSLATION_FLAGS = --no-color
 309 endif
 310
 311 ifneq ($(ISOLANG),)
 312 new-lang-dir:
 313         mkdir -p $(ISOLANG)/$(DIR)
 314         cp fr/GNUmakefile $(ISOLANG)
 315         cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR)
 316         sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile
 317         rm -f $(outdir)/*.*tely $(outdir)/*.*texi
 318         $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi)
 319         for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\
 320             test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
 321         done
 322         rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
 323         for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
 324             test -e $(ISOLANG)/$(DIR)/$$i\
 325                 || test -e $(ISOLANG)/$$i\
 326                 || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
 327         done
 328
 329 new-lang:
 330 # Also for updating/adding missing files
 331         mkdir -p $(ISOLANG)
 332         $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
 333         msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
 334         test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
 335         @echo "***  Please add a language definition for $(ISOLANG) in python/langdefs.py  ***"
 336
 337 TRANSLATION_DIRS = web texidocs
 338 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
 339 TEXI_LANGUTIL_FLAGS += --skeleton
 340
 341 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
 342 skeleton-update:
 343         @echo "$@ has been discontinued"
 344         @echo "simply copy .texi, .itexi files you want to translate"
 345         exit 2
 346         mkdir -p $(ISOLANG)
 347         $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
 348         $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
 349
 350 snippet-update:
 351         $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
 352
 353 DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
 354 -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
 355 -I $(top-src-dir)/Documentation/snippets \
 356 -I $(top-build-dir)/Documentation/out-www \
 357 -I $(top-build-dir)/Documentation/out
 358
 359 else # ISOLANG is empty
 360
 361 DOCUMENTS_INCLUDES:=-I . \
 362 -I $(top-build-dir)/Documentation/out-www \
 363 -I $(top-src-dir)/Documentation/snippets \
 364 -I $(top-build-dir)/Documentation/snippets/out-www \
 365 -I $(top-build-dir)/Documentation/out
 366
 367 endif # ISOLANG
 368
 369 check-xrefs:
 370         $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
 371         $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
 372
 373 fix-xrefs:
 374         $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
 375         $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
 376
 377 check-translation:
 378         ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 379
 380 update-translation:
 381         ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 382
 383 # what's it gonna be, boy...tranlationS-/translation-
 384 translation-status:
 385         PYTHONPATH=$(top-src-dir)/python:$(top-src-dir)/python/auxiliar $(PYTHON) $(top-src-dir)/scripts/auxiliar/translations-status.py
 386
 387 .SECONDARY: