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 automated-engraving 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)
  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 UNSPLITTED_HTML_MANUALS =
  61 SPLITTED_HTML_MANUALS = $(foreach manual, $(TEXINFO_MANUALS),\
  62  $(if $(findstring $(manual), $(UNSPLITTED_HTML_MANUALS)),,$(manual)))
  63 NOT_TOPDIR_HTML_MANUALS = $(foreach manual, $(SPLITTED_HTML_MANUALS),\
  64  $(if $(findstring $(manual), $(TOPDIR_HTML_MANUALS)),,$(manual)))
  65
  66 OUT_HTML_FILES = $(UNSPLITTED_HTML_MANUALS:%=$(outdir)/%.html)\
  67  $(SPLITTED_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, $(SPLITTED_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 ### Web site idiosyncrases
  95 $(XREF_MAPS_DIR)/web.xref-map: XREF_MAP_FLAGS += --split=node
  96
  97
  98 ### bad hack for badly-integrated roadmap.
  99 $(outdir)/ROADMAP:
 100         cp $(top-src-dir)/ROADMAP $(outdir)
 101 $(outdir)/contributor.texi: $(outdir)/ROADMAP
 102
 103
 104 ###########
 105 ### Targets
 106
 107 default: local-txt-doc
 108
 109 local-help: extra-local-help
 110
 111 extra-local-help:
 112         @echo "  check-xrefs [ISOLANG=LL] validate Texinfo cross-references"
 113         @echo "  fix-xrefs [ISOLANG=LL]   interactively fix Texinfo cross-references"
 114         @echo "                             (use with caution)"
 115         @echo "  info                     update info pages"
 116         @echo "  xml                      update Docbook xml documentation"
 117         @echo
 118         @echo "Translations specific targets (see TRANSLATION for details):"
 119         @echo "  new-lang ISOLANG=LL           create and initialize"
 120         @echo "                                  subdirectory \'LL' for language \'LL"
 121         @echo "                                  (if \'LL exists, update missing file)"
 122         @echo "  po-update                     update and replace PO files for"
 123         @echo "                                  documentation with msgmerged versions"
 124         @echo "  check-translation ISOLANG=LL  show changes in English docs since"
 125         @echo "                                  last translation update"
 126         @echo "  update-translation ISOLANG=LL call $$$$EDITOR to help updating"
 127         @echo "                                  the translation"
 128         @echo "  skeleton-update ISOLANG=LL    update Texinfo skeleton files"
 129         @echo "  snippet-update ISOLANG=LL     update ly snippets in Texinfo translation"
 130         @echo "                                  according to docs in English"
 131         @echo "                                  (use with caution)"
 132         @echo
 133         @echo "  LL refers to the desired locale"
 134         @echo "    (most often only the ISO 639 language code)."
 135         @echo
 136
 137 info: $(INFO_FILES)
 138         @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
 139         @echo export PYTHONPATH=$(PYTHONPATH)
 140
 141 xml: $(outdir)/notation/notation.xml $(outdir)/internals/internals.xml
 142
 143
 144 local-clean:
 145         rm -f $(INFO_IMAGES_DIR)
 146
 147 ### Web targets
 148
 149 ifeq ($(out),www)
 150 local-WWW-1: $(OUT_TEXINFO_MANUALS) $(PDF_FILES) info
 151
 152 local-WWW-2: txt-to-html $(OUT_HTML_FILES) $(DEEP_HTML_FILES) $(source-links) $(OMF_FILES)
 153 endif
 154
 155
 156 #########
 157 ### Rules
 158
 159 $(outdir)/lilypond-%.info: $(outdir)/%.texi $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep $(outdir)/version.itexi $(outdir)/weblinks.itexi
 160         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$@ $<
 161
 162 # cd $(outdir) rule gets bit hairy for --srcdir configure builds
 163 txt-to-html:
 164         $(foreach a, $(README_TOP_FILES), cp $(top-src-dir)/$(a) $(outdir)/$(a).txt && ) true
 165         $(PYTHON) $(step-bindir)/text2html.py $(OUT_TXT_FILES)
 166
 167 ifeq ($(out),www)
 168 ## Extra images dependencies
 169 $(OUT_TEXINFO_MANUALS): $(outdir)/pictures
 170
 171 $(outdir)/pictures:
 172         $(MAKE) -C pictures WWW-1
 173         ln -sf ../pictures/$(outdir) $@
 174
 175 $(outdir)/web.texi: $(outdir)/ly-examples
 176
 177 $(outdir)/ly-examples:
 178         $(MAKE) -C web/ly-examples
 179         ln -sf ../web/ly-examples/$(outdir) $@
 180 endif
 181
 182 # Ugh, using '%' twice not possible
 183 $(outdir)/notation/notation.xml: $(outdir)/notation.texi
 184         mkdir -p $(dir $@)
 185         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
 186
 187 $(outdir)/internals/internals.xml: $(outdir)/internals.texi
 188         mkdir -p $(dir $@)
 189         $(MAKEINFO) -I$(src-dir) -I$(outdir) --output=$(dir $@) --docbook $<
 190
 191 $(outdir)/learning.texi $(outdir)/notation.texi: $(OUT_PDF_IMAGES)
 192
 193 $(foreach manual, $(MANUAL_SUBDIRS),\
 194 $(eval $(outdir)/(manual).texi: $(call src-wildcard,$(manual)/*.ite??)))
 195
 196
 197
 198 $(outdir)/source:
 199         @rm -f $(@)
 200         ln -sf $(depth) $(@)
 201
 202 $(outdir)/%/source:
 203         @rm -f $(@)
 204         mkdir -p $(dir $@)
 205         ln -sf $(depth)/.. $(@)
 206
 207
 208 ## Snippets rules idiosyncrases
 209 $(outdir)/%.itely: snippets/%-intro.itely snippets/%.snippet-list
 210         xargs $(LYS_TO_TELY) -f doctitle,texidoc,verbatim --name=$@ --template=$< < $(filter %.snippet-list, $^)
 211
 212 $(outdir)/snippets.texi: $(GENERATED_ITELY_FILES) $(SNIPPET_LY_FILES)
 213
 214 $(outdir)/%.bib: %.bib
 215         ln -f $< $@
 216
 217 ## notation.texi deps
 218 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
 219         $(MAKE) -C $(top-src-dir)/mf
 220
 221 $(outdir)/notation.texi: $(outdir)/ly-grammar.txt
 222
 223 ## Rules for the automatically generated documentation
 224 $(outdir)/ly-grammar.txt: $(top-src-dir)/lily/parser.yy
 225         cd $(outdir) && $(BISON) -v $<
 226         $(buildscript-dir)/yyout2grammar $(outdir)/parser.output $@
 227
 228 # There used to be a dependency on a dummy target, to force a rebuild
 229 # of internals every time.  however, this triggers
 230 # compilation during install, which is a bad thing (tm).
 231
 232 $(outdir)/internals.texi: $(LILYPOND_BINARY)
 233         cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
 234
 235
 236 ###############################################
 237 #  Documentation and translations maintenance #
 238 ###############################################
 239 po-update:
 240         make -C po po-update
 241
 242 all-translations-update: po-update translation-status
 243         $(foreach lang, $(LANGS), make ISOLANG=$(lang) skeleton-update snippet-update &&) true
 244
 245 ifneq ($(NO_COLOR),)
 246 CHECK_TRANSLATION_FLAGS = --no-color
 247 endif
 248
 249 ifneq ($(ISOLANG),)
 250 new-lang-dir:
 251         mkdir -p $(ISOLANG)/$(DIR)
 252         cp fr/GNUmakefile $(ISOLANG)
 253         cp fr/$(DIR)/GNUmakefile $(ISOLANG)/$(DIR)
 254         sed -i -e 's/ISOLANG *= *fr/ISOLANG = $(ISOLANG)/' $(ISOLANG)/GNUmakefile $(ISOLANG)/$(DIR)/GNUmakefile
 255         rm -f $(outdir)/*.*tely $(outdir)/*.*texi
 256         $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) -o doc.pot --skeleton --gettext $$(cd $(ISOLANG) && ls -1 ../$(DIR).tely ../$(DIR).texi)
 257         for i in $$(cd $(outdir) && ls -1 $(DIR).tely $(DIR).texi); do\
 258             test -e $(ISOLANG)/$$i || mv $(outdir)/$$i $(ISOLANG)/$$i;\
 259         done
 260         rm -f $(outdir)/$(DIR).tely $(outdir)/$(DIR).texi
 261         for i in $$(cd $(outdir) && ls -1 *.*tely *.*texi); do\
 262             test -e $(ISOLANG)/$(DIR)/$$i\
 263                 || test -e $(ISOLANG)/$$i\
 264                 || mv $(outdir)/$$i $(ISOLANG)/$(DIR)/$$i;\
 265         done
 266
 267 new-lang:
 268 # Also for updating/adding missing files
 269         mkdir -p $(ISOLANG)
 270         $(foreach i,$(TRANSLATION_DIRS),$(MAKE) new-lang-dir DIR=$(i) &&) :
 271         msgmerge -U po/lilypond-doc.pot $(outdir)/doc.pot
 272         test -e po/$(ISOLANG).po || cp po/lilypond-doc.pot po/$(ISOLANG).po
 273         @echo "***  Please add a language definition for $(ISOLANG) in python/langdefs.py  ***"
 274
 275 TRANSLATION_DIRS = web texidocs
 276 TRANSLATION_FILES = $(shell git ls-files $(ISOLANG) | grep -v GNUmakefile)
 277 TEXI_LANGUTIL_FLAGS += --skeleton
 278
 279 TELY_FILES = $(call src-wildcard,$(ISOLANG)/*.tely)
 280 skeleton-update:
 281         mkdir -p $(ISOLANG)
 282         $(PYTHON) $(auxscript-dir)/texi-langutils.py -d $(outdir) -l $(ISOLANG) $(TEXI_LANGUTIL_FLAGS) $(TELY_FILES:$(ISOLANG)/%.tely=../%.tely)
 283         $(PYTHON) $(auxscript-dir)/texi-skeleton-update.py $(ISOLANG) $(outdir)
 284
 285 snippet-update:
 286         $(PYTHON) $(auxscript-dir)/update-snippets.py user $(ISOLANG) '*.itely'
 287
 288 DOCUMENTS_INCLUDES:=-I $(ISOLANG) \
 289 -I $(top-build-dir)/Documentation/$(ISOLANG)/out-www \
 290 -I $(top-src-dir)/Documentation/snippets \
 291 -I $(top-build-dir)/Documentation/out-www \
 292 -I $(top-build-dir)/Documentation/out
 293
 294 else # ISOLANG is empty
 295
 296 DOCUMENTS_INCLUDES:=-I . \
 297 -I $(top-build-dir)/Documentation/out-www \
 298 -I $(top-src-dir)/Documentation/snippets \
 299 -I $(top-build-dir)/Documentation/snippets/out-www \
 300 -I $(top-build-dir)/Documentation/out
 301
 302 endif # ISOLANG
 303
 304 check-xrefs:
 305         $(PYTHON) $(auxscript-dir)/check_texi_refs.py --batch \
 306         $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
 307
 308 fix-xrefs:
 309         $(PYTHON) $(auxscript-dir)/check_texi_refs.py --auto-fix \
 310         $(DOCUMENTS_INCLUDES) $(auxpython-dir)/manuals_definitions.py
 311
 312 check-translation:
 313         ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 314
 315 update-translation:
 316         ISOLANG=$(ISOLANG) $(PYTHON) $(auxscript-dir)/check_translation.py --update $(CHECK_TRANSLATION_FLAGS) $(TRANSLATION_FILES)
 317
 318 translation-status:
 319         @echo Target temporarily disabled
 320
 321 .SECONDARY: