From 456d20f8f4a581e3ac77b0e1d912b90f682af08e Mon Sep 17 00:00:00 2001 From: John Mandereau Date: Fri, 24 Apr 2009 02:17:47 +0200 Subject: [PATCH] Update documentation targets - 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. (cherry picked from commit 55c49859e8b5125438e0503c681d565d2944a01f) --- .gitignore | 1 + Documentation/GNUmakefile | 3 +- Documentation/bibliography/GNUmakefile | 3 +- Documentation/devel/GNUmakefile | 2 ++ Documentation/pictures/GNUmakefile | 3 ++ Documentation/topdocs/GNUmakefile | 2 ++ Documentation/user/GNUmakefile | 2 ++ Documentation/user/compile.itely | 14 ++++----- GNUmakefile.in | 39 ++++++++++++------------- configure.in | 5 ++++ input/lsr/GNUmakefile | 8 +++-- input/regression/musicxml/GNUmakefile | 2 ++ make/doc-i18n-root-targets.make | 2 ++ make/doc-i18n-topdocs-targets.make | 4 +++ make/doc-i18n-user-targets.make | 2 ++ make/lysdoc-targets.make | 2 ++ make/mutopia-targets.make | 2 ++ stepmake/stepmake/generic-targets.make | 21 +++++++------ stepmake/stepmake/po-targets.make | 6 ++-- stepmake/stepmake/texinfo-targets.make | 2 ++ stepmake/stepmake/topdocs-targets.make | 4 ++- stepmake/stepmake/toplevel-targets.make | 24 +++++++-------- 22 files changed, 96 insertions(+), 57 deletions(-) diff --git a/.gitignore b/.gitignore index ab48958870..5f51beb6fe 100644 --- a/.gitignore +++ b/.gitignore @@ -47,6 +47,7 @@ ?.* AUTHORS.txt INSTALL.txt +README.txt TAGS \#* \#.* diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index 747a8e304e..eaed920a9a 100644 --- a/Documentation/GNUmakefile +++ b/Documentation/GNUmakefile @@ -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))) diff --git a/Documentation/bibliography/GNUmakefile b/Documentation/bibliography/GNUmakefile index 798dad58a6..06055b5808 100644 --- a/Documentation/bibliography/GNUmakefile +++ b/Documentation/bibliography/GNUmakefile @@ -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 $< $@ diff --git a/Documentation/devel/GNUmakefile b/Documentation/devel/GNUmakefile index 640afbac98..1096add366 100644 --- a/Documentation/devel/GNUmakefile +++ b/Documentation/devel/GNUmakefile @@ -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) diff --git a/Documentation/pictures/GNUmakefile b/Documentation/pictures/GNUmakefile index 35ef738ae4..4a8f2eb72f 100644 --- a/Documentation/pictures/GNUmakefile +++ b/Documentation/pictures/GNUmakefile @@ -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 diff --git a/Documentation/topdocs/GNUmakefile b/Documentation/topdocs/GNUmakefile index 0f81c76f11..231598d8f4 100644 --- a/Documentation/topdocs/GNUmakefile +++ b/Documentation/topdocs/GNUmakefile @@ -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: diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index 6e0dbe3a56..237bb973a0 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -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 $< $@ diff --git a/Documentation/user/compile.itely b/Documentation/user/compile.itely index 5ceaa57720..4f9ac333a5 100644 --- a/Documentation/user/compile.itely +++ b/Documentation/user/compile.itely @@ -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 diff --git a/GNUmakefile.in b/GNUmakefile.in index aee8bfe20b..a45f486208 100644 --- a/GNUmakefile.in +++ b/GNUmakefile.in @@ -59,31 +59,42 @@ refresh-release-files: 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: @@ -93,25 +104,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"' @@ -124,6 +122,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) @@ -143,7 +142,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 diff --git a/configure.in b/configure.in index d45c4c0a44..b067305f9d 100644 --- a/configure.in +++ b/configure.in @@ -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 <