Documentation/GNUmakefile

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