]> git.donarmstrong.com Git - lilypond.git/commitdiff
Update documentation targets
authorJohn Mandereau <john.mandereau@gmail.com>
Fri, 24 Apr 2009 00:17:47 +0000 (02:17 +0200)
committerJohn Mandereau <john.mandereau@gmail.com>
Sun, 26 Apr 2009 22:49:04 +0000 (00:49 +0200)
- remove old target 'doc': text documentation is already generated
by 'make all'.

- user target name changes:
web -> doc
web-1 -> doc-stage-1
web-clean -> doc-clean
web-install -> install-doc
web-uninstall -> uninstall-doc
info-install -> install-info

- internal target names changes:
do-top-doc -> top-doc
localpo -> local-po

- protect private documentation targets with conditional testing
of out==www;

- automatically generate README.txt and INSTALL.txt even for a Git
checkout when autogen.sh and configure are successful.

22 files changed:
.gitignore
Documentation/GNUmakefile
Documentation/bibliography/GNUmakefile
Documentation/devel/GNUmakefile
Documentation/pictures/GNUmakefile
Documentation/topdocs/GNUmakefile
Documentation/user/GNUmakefile
Documentation/user/compile.itely
GNUmakefile.in
configure.in
input/lsr/GNUmakefile
input/regression/musicxml/GNUmakefile
make/doc-i18n-root-targets.make
make/doc-i18n-topdocs-targets.make
make/doc-i18n-user-targets.make
make/lysdoc-targets.make
make/mutopia-targets.make
stepmake/stepmake/generic-targets.make
stepmake/stepmake/po-targets.make
stepmake/stepmake/texinfo-targets.make
stepmake/stepmake/topdocs-targets.make
stepmake/stepmake/toplevel-targets.make

index 63fb92cb71281fd65c65dd1c87da6c21dd75208f..ab855da8448013a368123ba22accd41a73f5c411 100644 (file)
@@ -47,6 +47,7 @@
 ?.*
 AUTHORS.txt
 INSTALL.txt
+README.txt
 TAGS
 \#*
 \#.*
index 747a8e304e612ed38698c5f6758b4d9b56767c97..eaed920a9a025ce665f58a1bd326b0197305e2f0 100644 (file)
@@ -7,7 +7,6 @@ STEPMAKE_TEMPLATES=documentation texinfo tex
 LOCALSTEPMAKE_TEMPLATES=lilypond ly
 LILYPOND_BOOK_FLAGS=--extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"'
 README_TOP_FILES= DEDICATION THANKS
-EXTRA_DIST_FILES= TRANSLATION
 
 include $(depth)/make/stepmake.make
 
@@ -17,12 +16,14 @@ OUT_CSS_FILES= $(CSS_FILES:%.css=$(outdir)/%.css)
 
 default: local-doc
 
+ifeq ($(out),www)
 local-WWW-2: txt-to-html $(OUT_HTML_FILES)
 
 local-WWW-clean: deep-WWW-clean
 
 deep-WWW-clean:
        rm -rf $(outdir)/wiki-dump
+endif
 
 OUT_TXT_FILES = $(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES)))
 
index 798dad58a65c482e0aaede203dc9cc78dacccd79..06055b58089eff8c7cdb6544fbf97a1f3a984d11 100644 (file)
@@ -15,13 +15,14 @@ dvi: $(DVI_FILES) $(OUT_BIB_FILES)
 
 ps: $(PS_FILES)
 
-# urg
 default:
 
 GENHTMLS = engraving colorado computer-notation
 OUTGENHTMLS = $(addprefix $(outdir)/, $(GENHTMLS:%=%.html))
 
+ifeq ($(out),www)
 local-WWW-2: $(addprefix $(outdir)/, $(BIB_FILES:.bib=.html) index.html)
+endif
 
 $(outdir)/%.bib: %.bib
        ln -f $< $@
index 640afbac98841d964012c6373160e8c9ca4a00d0..1096add366a64cc4c8d28c2391a9fbcde9599af4 100644 (file)
@@ -28,8 +28,10 @@ $(outdir)/%/source:
        mkdir -p $(dir $@)
        ln -sf $(depth)/.. $(@)
 
+ifeq ($(out),www)
 local-WWW-1: $(PDF_FILES)
 
 local-WWW-2: $(HTML_FILES) $(OUT_HTML_FILES) $(source-links)
+endif
 
 $(PDF_FILES) $(HTML_FILES): $(ITEXI_FILES)
index 35ef738ae4158c785557192665c1f94c84338ea9..4a8f2eb72f0e28a0f003389cce973b062932da2a 100644 (file)
@@ -21,4 +21,7 @@ endif # PLATFORM_WINDOWS
 local-dist: $(icon) 
 xgifs: $(OUTGIF_FILES)
 pngs: $(OUTPNG_FILES)
+
+ifeq ($(out),www)
 local-WWW-1: $(OUTPNG_FILES)
+endif
index 0f81c76f1136828424e8c93a5732f65cbe85a2be..231598d8f4532649070c8046f2f215dcd2b678bb 100644 (file)
@@ -11,6 +11,8 @@ OUTTXT_FILES= $(outdir)/NEWS.txt
 
 include $(depth)/make/stepmake.make
 
+ifeq ($(out),www)
 local-WWW-1: $(OUT_TEXI_FILES)
+endif
 
 .SECONDARY:
index 6e0dbe3a56aa830af3f47bd78af35f1b9af1cbda..237bb973a0426517d90417ba6d9d87ca75953f66 100644 (file)
@@ -122,9 +122,11 @@ $(outdir)/%/source:
        mkdir -p $(dir $@)
        ln -sf $(depth)/.. $(@)
 
+ifeq ($(out),www)
 local-WWW-1: $(MASTER_TEXI_FILES) $(PDF_FILES) info
 
 local-WWW-2: $(HTML_FILES) $(DEEP_HTML_FILES) $(source-links)
+endif
 
 $(outdir)/%.bib: %.bib
        ln -f $< $@
index 50fb3363830ad3ea379487cbbdb90335ff403231..44a9600638ffd791f83bec8c58f9022cf6a98ac9 100644 (file)
@@ -224,7 +224,7 @@ LilyPond binary.
 The documentation is built by issuing
 
 @example
-make web
+make doc
 @end example
 
 After compilation, the HTML documentation tree is available in
@@ -234,7 +234,7 @@ The HTML, PDF and if available Info files can be installed into the
 standard documentation path by issuing
 
 @example
-make web-install
+make install-doc
 @end example
 
 @noindent
@@ -253,14 +253,14 @@ make info
 Separate installation of this documentation is done by issuing
 
 @example
-make info-install
+make install-info
 @end example
 
 @noindent
-Note that to get the images in Info documentation, @code{web-install}
+Note that to get the images in Info documentation, @code{install-doc}
 target creates symbolic links to HTML and PDF installed documentation
 tree in @file{@var{prefix}/share/info}, in order to save disk space,
-whereas @code{info-install} copies images in
+whereas @code{install-info} copies images in
 @file{@var{prefix}/share/info} subdirectories.
 
 It is possible to build a documentation tree in
@@ -269,7 +269,7 @@ used on a website with content negotiation for automatic language
 selection; this can be achieved by issuing
 
 @example
-make WEB_TARGETS=online web
+make WEB_TARGETS=online doc
 @end example
 
 @noindent
@@ -344,7 +344,7 @@ From a fresh Git checkout, do
 ./autogen.sh   # ignore any warning messages
 cp GNUmakefile.in GNUmakefile
 make -C python
-nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
+nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc
 @end example
 
 Please note that this may break sometimes -- for example, if a new
index 426ae7f60c196643eebfeb28f796398e68df3bc0..fec79a01d2f8fb2163a76769ed836d2b156c0b4b 100644 (file)
@@ -49,31 +49,42 @@ ChangeLog: $(outdir)/VERSION
 python-modules:
        $(MAKE) -C python
 
-do-top-doc: python-modules
+top-doc: python-modules
 
 local-clean: local-clean-ChangeLog
 
 local-clean-ChangeLog:
        rm -f ChangeLog
 
-dist-toplevel-txt-files: do-top-doc
+dist-toplevel-txt-files: top-doc
        -mkdir -p $(distdir)
        ln $(TOPDOC_TXT_FILES) $(distdir)/
        ln $(top-src-dir)/stepmake/aclocal.m4 $(distdir)/
 
-doc: 
-       $(MAKE) -C Documentation
-
 info:
        $(foreach d, $(INFO_DIRECTORIES),$(MAKE) -C $(d) out=www info && ) true
 
-info-install: info
+install-info: info
        $(MAKE) out=www COPY_INFO_IMAGES=1 install-info-WWW
 
 install-help2man:
        $(MAKE) -C scripts man install-help2man
        $(MAKE) -C lily man install-help2man
 
+install-doc:
+       $(MAKE) out=www install-WWW
+       $(MAKE) out=www install-info-WWW
+
+uninstall-doc:
+       $(MAKE) out=www uninstall-WWW
+
+local-install:
+       $(INSTALL) -d $(DESTDIR)$(local_lilypond_datadir)
+
+final-install:
+       @true
+
+ifeq ($(out),www)
 # All web targets, except info image symlinks and info docs are
 # installed in non-recursing target from TOP-SRC-DIR
 install-WWW:
@@ -83,25 +94,12 @@ install-WWW:
 install-info-WWW:
        $(foreach d, $(INFO_DIRECTORIES),$(MAKE) -C $(d) install-info && ) true
 
-web-install:
-       $(MAKE) out=www install-WWW
-       $(MAKE) out=www install-info-WWW
-
 uninstall-WWW:
        rm -rf $(DESTDIR)$(webdir)
        -rmdir $(package_docdir)
        $(MAKE) -C Documentation/user uninstall
        $(MAKE) -C input/lsr uninstall
 
-web-uninstall:
-       $(MAKE) out=www uninstall-WWW
-
-local-install:
-       $(INSTALL) -d $(DESTDIR)$(local_lilypond_datadir)
-
-final-install:
-       @true
-
 
 # For online docs with content negotiation, issue `make web WEB_TARGETS=online'
 # For both online and offline docs, issue `make web WEB_TARGETS="offline online"'
@@ -114,6 +112,7 @@ WWW-post:
        find $(outdir) -name '*-root' | xargs rm -rf
        $(buildscript-dir)/www_post $(PACKAGE_NAME) $(TOPLEVEL_VERSION) $(outdir) "$(WEB_TARGETS)"
        find $(outdir)/offline-root -type l -delete
+endif
 
 
 tree-prefix = $(outdir)
@@ -133,7 +132,7 @@ c-clean:
 
 src-ext = c cc yy ll hh icc py scm tex ps texi itexi tely itely sh
 
-web-clean: snippets-clean $(tree-share-prefix)/lilypond-force
+doc-clean: snippets-clean $(tree-share-prefix)/lilypond-force
 
 default: $(config_h) build-dir-setup
 
index d45c4c0a44ebe77acf8871f7d0dc3a037d52783b..b067305f9dcf38c807099c986524dd54bd279cec 100644 (file)
@@ -205,6 +205,11 @@ STEPMAKE_END
 
 test -n "$CONFIGURATION" && mc=" conf=$CONFIGURATION" || mc=""
 
+if make top-doc 1>/dev/null 2>&1; then
+    rm -f INSTALL.txt && ln Documentation/topdocs/out/INSTALL.txt .
+    rm -f README.txt && ln Documentation/topdocs/out/README.txt .
+fi
+
 cat <<EOF
 
 Type:
index 9f06be94de31cec20fdf954cacafdf67613a54b5..8afa862bb217cfa1666e9099027c2b5e18e50392 100644 (file)
@@ -50,19 +50,21 @@ $(INFO_FILES):
        true
 endif
 
+local-clean:
+       rm -f $(INFO_IMAGES_DIR)
+
+ifeq ($(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
 
-local-clean:
-       rm -f $(INFO_IMAGES_DIR)
-
 local-WWW-1: info $(outdir)/lilypond-snippets.pdf \
   $(outdir)/lilypond-snippets.texi
 
 local-WWW-2: $(outdir)/lilypond-snippets/index.html \
   $(outdir)/lilypond-snippets-big-page.html \
   $(source-links)
+endif
 
 .SECONDARY:
index 888616e7e7c47af7d3595de054bd32cc319790a2..b5ca56513ec43859e726e737fc9ac9440579caa5 100644 (file)
@@ -17,7 +17,9 @@ include $(depth)/make/stepmake.make
 TITLE=Unofficial MusicXML test suite
 TEST_SUITE_VERSION=0.1
 
+ifeq ($(out),www)
 local-WWW-2: zip
+endif
 
 zip: $(outdir)/MusicXML-TestSuite-$(TEST_SUITE_VERSION).zip
 
index 3b97883dfd129fc3da7a85827ddcbc9736467d0b..213e478fa86ac38228276726ba287e7b1e67ebae 100644 (file)
@@ -1,4 +1,6 @@
 default:
 
+ifeq ($(out),www)
 local-WWW-2: $(OUT_HTML_FILES)
        $(buildscript-dir)/mass-link --prepend-suffix .$(ISOLANG) hard $(outdir) $(top-build-dir)/Documentation/$(outdir) $(HTML_FILES)
+endif
index 0c0a018b7aa30e1ca7e8bf09ea192b101c5e38eb..d7e26a95ce3cec42d8eb8cf8ee647564509fb4ac 100644 (file)
@@ -1,5 +1,9 @@
+default:
+
+ifeq ($(out),www)
 local-WWW-1: $(MASTER_TEXI_FILES) $(PDF_FILES)
 
 local-WWW-2: $(HTML_FILES)
        find $(outdir) -name '*.html' | sed 's!$(outdir)/!!g' | xargs $(buildscript-dir)/mass-link --prepend-suffix .$(ISOLANG) hard $(outdir) $(top-build-dir)/Documentation/topdocs/$(outdir) NEWS.pdf
        find $(outdir) \( -name 'lily-*.png' -o -name 'lily-*.ly' \) | sed 's!$(outdir)/!!g' | xargs $(buildscript-dir)/mass-link hard $(outdir) $(top-build-dir)/Documentation/topdocs/$(outdir)
+endif
index 4bb7c5b9c9d78acacec8a1ac3badc3a2dce8061c..478bfac498bb55c24293eade5691ab51982bd7b7 100644 (file)
@@ -1,5 +1,6 @@
 default:
 
+ifeq ($(out),www)
 local-WWW-1: $(MASTER_TEXI_FILES) $(PDF_FILES) $(XREF_MAPS_FILES)
 
 local-WWW-2: $(DEEP_HTML_FILES) $(BIG_PAGE_HTML_FILES) $(DOCUMENTATION_LOCALE_TARGET)
@@ -10,3 +11,4 @@ local-WWW-2: $(DEEP_HTML_FILES) $(BIG_PAGE_HTML_FILES) $(DOCUMENTATION_LOCALE_TA
 $(DOCUMENTATION_LOCALE_TARGET):
        $(MAKE) -C $(depth)/Documentation/po out=www messages
        touch $@
+endif
index 0b5d6ec2ed493d57143ccedf53fa3d524772e7e5..7f58e9692f09fc79bfeee8deec62a32a3eba5d35 100644 (file)
@@ -1,6 +1,8 @@
+ifeq ($(out),www)
 local-WWW-1: $(outdir)/collated-files.texi $(outdir)/collated-files.pdf
 
 local-WWW-2: $(outdir)/collated-files.html
+endif
 
 local-test-baseline:
        rm -rf $(outdir)-baseline
index deaf2408616932a5375971f2ae79596ba559d91d..f89fcc4060a1a605ed64aa35bdbdd0acd6b3649c 100644 (file)
@@ -6,7 +6,9 @@
 
 all: $(OUT_FILES)
 
+ifeq ($(out),www)
 local-WWW-1: $(ly_examples) $(pdf_examples) $(png_examples)
+endif
 
 tar:
        mkdir -p $(outdir)/$(tarball)
index d0c0bf44d14bd0e1284f2df603468097cf6ceb36..a36faaeb2360a079498748fac63dcfe9c0f031cf 100644 (file)
@@ -1,5 +1,5 @@
-.PHONY : all clean bin-clean config default dist doc exe help html lib TAGS\
-        po web web-1 WWW-1 WWW-2 WWW-post local-WWW-1 local-WWW-2
+.PHONY : all clean bin-clean config default dist exe help html lib TAGS\
+        po doc doc-stage-1 WWW-1 WWW-2 WWW-post local-WWW-1 local-WWW-2
 
 all:    default
        $(LOOP)
@@ -56,17 +56,18 @@ Targets specific to current directory:\n"
 
 help: generic-help local-help
        @echo -e "Generic targets:\n\
-  all *       update everything except website documentation\n\
+  all *       update everything except documentation with images\n\
   clean *     remove all generated stuff in $(outdir)\n\
   bin-clean * same as clean, except that mf/out is preserved\n\
   default     same as the empty target\n\
+  doc *       update documentation with images in directory \`out-www'\n\
+  doc-stage-1 * update only PDF and Info documentation in directory \`out-www'\n\
+  doc-clean * clean \`out-www' directory\n\
   exe         update all executables\n\
   help        this help\n\
   install *   install programs and data (prefix=$(prefix))\n\
-  uninstall*  uninstall programs and data\n\
   lib         update all libraries\n\
-  web *       update website in directory \`out-www'\n\
-  web-clean * clean \`out-www' directory\n\
+  uninstall*  uninstall programs and data\n\
   TAGS        generate tagfiles\n\
 \n\
 \`make' may be invoked from any subdirectory.\n\
@@ -173,6 +174,7 @@ $(config_make): $(top-src-dir)/configure
 # plus WWW-post (only at toplevel)
 # see INSTALL for more information.
 
+ifeq ($(out),www)
 local-WWW-1:
 local-WWW-2:
 WWW-post:
@@ -182,14 +184,15 @@ WWW-1: local-WWW-1
 
 WWW-2: local-WWW-2
        $(LOOP)
+endif
 
-web: web-1
+doc: doc-stage-1
        $(MAKE) out=www WWW-2
        $(MAKE) out=www WWW-post
 
-web-1:
+doc-stage-1:
        $(MAKE) -C $(depth)/scripts/build out=
        $(MAKE) out=www WWW-1
 
-web-clean:
+doc-clean:
        $(MAKE) out=www clean
index 4221f8ed45363e2c3191bcc7ee69e56ab2ba99a3..05088ee1700a49164a67681a3e5f84d75ded7c06 100644 (file)
@@ -12,13 +12,13 @@ new-po:
 ifeq ($(strip $(depth)),.)
 po: new-po
        $(LOOP)
-localpo:
+local-po:
        @true
 else
-po: localpo
+po: local-po
        $(LOOP)
 ALL_PO_SOURCES = $(ALL_C_SOURCES) $(ALL_CC_SOURCES) $(PYTHON_SCRIPTS_IN) $(PY_MODULES_IN) $(SCM_FILES) $(wildcard $(outdir)/*.hh) $(wildcard $(outdir)/*.cc)
-localpo:
+local-po:
 ifneq ($(strip $(ALL_PO_SOURCES)),)
        @echo $(ALL_PO_SOURCES)
        xgettext --default-domain=$(package) --join \
index e9cbf16aec7a1f91c5a2b85550c52de187985a5f..133a9bb218058659a987e2e1c2c5850a42ef10ec 100644 (file)
@@ -2,7 +2,9 @@
 
 default: $(INFO_FILES)
 
+ifeq ($(out),www)
 local-WWW-1: $(XREF_MAPS_FILES)
+endif
 
 local-doc:  $(OUTTXT_FILES)
 
index 93d2f9cccf3c3d6b05c22a52c0f41811630ff890..acacbb3c698160216c519f691b86f315bab5a8a1 100644 (file)
@@ -1,8 +1,10 @@
 
 default: local-doc
 
+ifeq ($(out),www)
 local-WWW-1: $(PDF_FILES)
 
 local-WWW-2: $(HTML_FILES)
+endif
 
-make-txt-files: $(TO_TOP_FILES)
+txt-files: $(TO_TOP_FILES)
index cc4a156e1ae7e8b5726b18b2625a62a1c1ad9109..94f9e234f3a03898b770464957d8a756541dd8a3 100644 (file)
@@ -1,6 +1,6 @@
-.PHONY: web-install
-web-install:
-web-uninstall:
+.PHONY: install-doc uninstall-doc
+install-doc:
+uninstall-doc:
 
 local-dist: configure
 
@@ -30,11 +30,11 @@ $(package-icon):
        $(MAKE) -C Documentation/pictures icon
 
 
-do-top-doc:
-       -$(MAKE) -C Documentation/topdocs/ README_TOP_FILES="$(TOPDOC_FILES)" make-txt-files
+top-doc:
+       $(MAKE) -C Documentation/topdocs/ README_TOP_FILES="$(TOPDOC_FILES)" txt-files
 
 
-$(README_TXT_FILES): do-top-doc
+$(README_TXT_FILES): top-doc
 
 local-clean:
 
@@ -44,7 +44,7 @@ ifeq ($(strip $(SRCMAKE)),)
        $(MAKE) final-install
 endif
 
-local-dist: do-top-doc
+local-dist: top-doc
 
 dist:
        rm -rf $(distdir)
@@ -59,17 +59,17 @@ local-help:
   config      rerun configure\n\
   dist        roll tarball: $(depth)/$(outdir)/$(distname).tar.gz\n\
   distclean   also remove configure output\n\
-  doc         update all documentation (without images)\n\
-  info        build Info documentation with images\n\
-  info-install  install Info documentation with images\n\
   cvs-clean   also remove out directories and generated files\n\
   maintainerclean also remove distributed generated files\n\
   po          make new translation Portable Object database\n\
   po-replace  do po-update and replace catalogs with msgmerged versions\n\
   po-update   update translation Portable Object database\n\
-  web-install * install website documentation in (webdir=$(webdir))\n\
+\n\
+  install-doc install website documentation in (webdir=$(webdir))\n\
               and Info documentation with images\n\
-  web-uninstall *  remove installed documentation with images\n\
+  uninstall-doc remove installed documentation with images\n\
+  info        build Info documentation with images\n\
+  install-info  install Info documentation with images\n\
 \n\
 Some more targets are available for testing changes:\n\
   test-baseline  check  test-redo  test-clean\n\