From: John Mandereau Date: Fri, 9 Jan 2009 19:32:27 +0000 (+0100) Subject: Add Contributors' Guide stub and clean up makefiles X-Git-Tag: release/2.12.2-1~39 X-Git-Url: https://git.donarmstrong.com/?p=lilypond.git;a=commitdiff_plain;h=859d050f0220c0b45c52a37b9825482eec0fea8c Add Contributors' Guide stub and clean up makefiles * add Contributors' Guide stub in new directory Documentation/devel/; * move Documentation/devel.html.in to Documentation/devel/index.html.in to avoid clashing directory and file names on lilypond.org; * cleanup topdocs and Texinfo makefiles; * fix links accordingly; * fix 'make dist'. --- diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index 790b046047..747a8e304e 100644 --- a/Documentation/GNUmakefile +++ b/Documentation/GNUmakefile @@ -2,7 +2,7 @@ depth = .. NAME = documentation LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py) -SUBDIRS=user bibliography pictures topdocs misc po $(LANGS) +SUBDIRS=devel user bibliography pictures topdocs misc po $(LANGS) STEPMAKE_TEMPLATES=documentation texinfo tex LOCALSTEPMAKE_TEMPLATES=lilypond ly LILYPOND_BOOK_FLAGS=--extra-options '-e "(ly:set-option (quote internal-type-checking) \#t)"' @@ -11,7 +11,7 @@ EXTRA_DIST_FILES= TRANSLATION include $(depth)/make/stepmake.make -HTML_PAGE_NAMES= index devel translations +HTML_PAGE_NAMES= index translations OUT_HTML_FILES= $(HTML_PAGE_NAMES:%=$(outdir)/%.html) OUT_CSS_FILES= $(CSS_FILES:%.css=$(outdir)/%.css) diff --git a/Documentation/de/index.html.in b/Documentation/de/index.html.in index ee95ddede8..5d9bae5359 100644 --- a/Documentation/de/index.html.in +++ b/Documentation/de/index.html.in @@ -100,7 +100,7 @@ als PDF) diff --git a/Documentation/devel.html.in b/Documentation/devel.html.in deleted file mode 100644 index 703a3d776f..0000000000 --- a/Documentation/devel.html.in +++ /dev/null @@ -1,84 +0,0 @@ - - - - LilyPond @TOPLEVEL_VERSION@ Developers Resources - - - - - - - -
-

LilyPond developers resources

-
- -
-

- Version @TOPLEVEL_VERSION@ -
- @DATE@ -

-
- - - - - - - - - - - - - -

Go back to the Documentation index.

- - - diff --git a/Documentation/devel/GNUmakefile b/Documentation/devel/GNUmakefile new file mode 100644 index 0000000000..5c10ebef9c --- /dev/null +++ b/Documentation/devel/GNUmakefile @@ -0,0 +1,21 @@ +depth = ../.. + +STEPMAKE_TEMPLATES = documentation tex texinfo topdocs +LOCALSTEPMAKE_TEMPLATES = ly + +include $(depth)/make/stepmake.make + +HTML_PAGE_NAMES = index +OUT_HTML_FILES = $(HTML_PAGE_NAMES:%=$(outdir)/%.html) + + +MASTER_TEXI_FILES = contrib-guide.texi +PDF_FILES = $(MASTER_TEXI_FILES:%.texi=$(outdir)/%.pdf) +HTML_FILES = $(MASTER_TEXI_FILES:%.texi=$(outdir)/%/index.html) \ + $(MASTER_TEXI_FILES:%.texi=$(outdir)/%-big-page.html) + +default: local-doc + +local-WWW-1: $(PDF_FILES) + +local-WWW-2: $(HTML_FILES) $(OUT_HTML_FILES) diff --git a/Documentation/devel/contrib-guide.texi b/Documentation/devel/contrib-guide.texi new file mode 100644 index 0000000000..6e8ec88788 --- /dev/null +++ b/Documentation/devel/contrib-guide.texi @@ -0,0 +1,16 @@ +\input texinfo @c -*- coding: utf-8; mode: texinfo; -*- +@setfilename contrib-guide.info +@settitle LilyPond Contributors' Guide + +@include macros.itexi + +@documentencoding utf-8 +@documentlanguage en + +@finalout + +@node Top +@top LilyPond Contributors' Guide + + +@bye diff --git a/Documentation/devel/index.html.in b/Documentation/devel/index.html.in new file mode 100644 index 0000000000..3cc188d826 --- /dev/null +++ b/Documentation/devel/index.html.in @@ -0,0 +1,97 @@ + + + + LilyPond @TOPLEVEL_VERSION@ Developers Resources + + + + + + + +
+

LilyPond developers resources

+
+ +
+

+ Version @TOPLEVEL_VERSION@ +
+ @DATE@ +

+
+ + + + + +
+
+ Contributors' + Guide + (in one + big page, in PDF) +
(how to participate in development) +
+ + + + + + + + + + + + + +

Go back to the Documentation index.

+ + + diff --git a/Documentation/es/index.html.in b/Documentation/es/index.html.in index d5721ba5f4..5c987014e9 100644 --- a/Documentation/es/index.html.in +++ b/Documentation/es/index.html.in @@ -93,7 +93,7 @@ diff --git a/Documentation/fr/index.html.in b/Documentation/fr/index.html.in index f01889be69..da2d55073c 100644 --- a/Documentation/fr/index.html.in +++ b/Documentation/fr/index.html.in @@ -91,7 +91,7 @@ au format PDF) diff --git a/Documentation/index.html.in b/Documentation/index.html.in index 99ec9d8e0e..9836f53491 100644 --- a/Documentation/index.html.in +++ b/Documentation/index.html.in @@ -98,7 +98,7 @@ in PDF) diff --git a/Documentation/topdocs/GNUmakefile b/Documentation/topdocs/GNUmakefile index 537f761b0a..0f81c76f11 100644 --- a/Documentation/topdocs/GNUmakefile +++ b/Documentation/topdocs/GNUmakefile @@ -11,10 +11,6 @@ OUTTXT_FILES= $(outdir)/NEWS.txt include $(depth)/make/stepmake.make -MAKEINFO_FLAGS += -I $(top-src-dir)/Documentation/user -TEXI2HTML_FLAGS += -I $(top-src-dir)/Documentation/user - local-WWW-1: $(OUT_TEXI_FILES) .SECONDARY: - diff --git a/GNUmakefile.in b/GNUmakefile.in index f6389fbe3f..36ade426bd 100644 --- a/GNUmakefile.in +++ b/GNUmakefile.in @@ -22,7 +22,7 @@ TOPDOC_FILES = AUTHORS INSTALL README NEWS TOPDOC_TXT_FILES = $(addprefix $(top-build-dir)/Documentation/topdocs/$(outdir)/,$(addsuffix .txt,$(TOPDOC_FILES))) IN_FILES := $(call src-wildcard,*.in) -EXTRA_DIST_FILES = VERSION .gitignore SConstruct lilypond-texi2html.init \ +EXTRA_DIST_FILES = VERSION .gitignore lilypond-texi2html.init \ $(README_FILES) $(SCRIPTS) $(IN_FILES) INSTALLATION_DIR=$(local_lilypond_datadir) INSTALLATION_FILES=$(config_make) VERSION @@ -88,6 +88,7 @@ WEB_TARGETS = offline WWW-post: # need UTF8 setting in case this is hosted on a website. + $(MAKE) -C scripts/build out= echo -e 'AddDefaultCharset utf-8\nAddCharset utf-8 .html\nAddCharset utf-8 .en\nAddCharset utf-8 .nl\nAddCharset utf-8 .txt\n' > $(top-build-dir)/.htaccess $(buildscript-dir)/mutopia-index -o $(outdir)/examples.html input/ find $(outdir) -name '*-root' | xargs rm -rf diff --git a/scripts/build/www_post.py b/scripts/build/www_post.py index 29f80cf09f..21ce380ce3 100644 --- a/scripts/build/www_post.py +++ b/scripts/build/www_post.py @@ -35,9 +35,13 @@ static_files = { } for l in langdefs.LANGUAGES: - static_files[os.path.join ('Documentation', 'user', outdir, l.file_name ('index', '.html'))] = \ - '\nRedirecting to the documentation index...\n' + static_files[os.path.join ( + 'Documentation', + 'user', + outdir, + l.file_name ('index', '.html'))] = \ + '\nRedirecting to the documentation index...\n' for f, contents in static_files.items (): open (f, 'w').write (contents) @@ -46,7 +50,9 @@ sys.stderr.write ("Mirrorring...\n") dirs, symlinks, files = mirrortree.walk_tree ( tree_roots = doc_dirs, process_dirs = outdir, - exclude_dirs = '(^|/)(' + r'|po|out|out-test|.*?[.]t2d|\w*?-root)(/|$)|Documentation/(' + '|'.join ([l.code for l in langdefs.LANGUAGES]) + ')', + exclude_dirs = '(^|/)((' + \ + r'po|out|out-test|out-cov|.*?[.]t2d|\w*?-root)|^Documentation/(' + \ + '|'.join ([l.code for l in langdefs.LANGUAGES]) + '))(/|$)', find_files = r'.*?\.(?:midi|html|pdf|png|txt|i?ly|signature|css)$|VERSION', exclude_files = r'lily-[0-9a-f]+.*\.(pdf|txt)') diff --git a/stepmake/stepmake/texinfo-rules.make b/stepmake/stepmake/texinfo-rules.make index 05627f18da..a49c86a87f 100644 --- a/stepmake/stepmake/texinfo-rules.make +++ b/stepmake/stepmake/texinfo-rules.make @@ -64,16 +64,17 @@ $(outdir)/%.ps.gz.omf: %.texi $(outdir)/%.pdf: $(outdir)/%.texi $(outdir)/version.itexi cd $(outdir); texi2pdf $(TEXI2PDF_FLAGS) --batch $(TEXINFO_PAPERSIZE_OPTION) $( $@ @@ -81,4 +82,5 @@ $(outdir)/version.%: $(top-src-dir)/VERSION echo '@end macro'>> $@ .SECONDARY: $(outdir)/version.itexi $(outdir)/version.texi \ - $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep + $(outdir)/$(INFO_IMAGES_DIR).info-images-dir-dep \ + $(outdir)/*.texi diff --git a/stepmake/stepmake/texinfo-targets.make b/stepmake/stepmake/texinfo-targets.make index 492e1f6366..6754b77f5f 100644 --- a/stepmake/stepmake/texinfo-targets.make +++ b/stepmake/stepmake/texinfo-targets.make @@ -4,7 +4,7 @@ default: $(INFO_FILES) local-WWW-1: $(XREF_MAPS_FILES) -local-doc: $(OUTTXT_FILES) +local-doc: $(OUTTXT_FILES) check-info: texinfo-all-menus-update diff --git a/stepmake/stepmake/texinfo-vars.make b/stepmake/stepmake/texinfo-vars.make index ca567b6868..d3d237843c 100644 --- a/stepmake/stepmake/texinfo-vars.make +++ b/stepmake/stepmake/texinfo-vars.make @@ -10,7 +10,7 @@ GENERATE_OMF = $(buildscript-dir)/texi2omf --format $(1) --location $(webdir)/$( TEXINFO_PAPERSIZE_OPTION= $(if $(findstring $(PAPERSIZE),a4),,-t @afourpaper) -MAKEINFO_FLAGS = --enable-encoding +MAKEINFO_FLAGS += --enable-encoding $(DOCUMENTATION_INCLUDES) MAKEINFO = LANG= $(MAKEINFO_PROGRAM) $(MAKEINFO_FLAGS) # texi2html xref map files @@ -25,6 +25,8 @@ TEXI2HTML_FLAGS += $(DOCUMENTATION_INCLUDES) --I=$(XREF_MAPS_DIR) TEXI2HTML_INIT = --init-file=$(top-src-dir)/lilypond-texi2html.init TEXI2HTML = $(TEXI2HTML_PROGRAM) $(TEXI2HTML_FLAGS) $(TEXI2HTML_LANG) +TEXI2PDF_FLAGS += $(DOCUMENTATION_INCLUDES) + ifdef QUIET_BUILD TEXI2PDF_FLAGS += -q endif diff --git a/stepmake/stepmake/topdocs-vars.make b/stepmake/stepmake/topdocs-vars.make index 73adc87046..89786ea768 100644 --- a/stepmake/stepmake/topdocs-vars.make +++ b/stepmake/stepmake/topdocs-vars.make @@ -1,2 +1,3 @@ TO_TOP_FILES=$(addprefix $(outdir)/, $(addsuffix .txt, $(README_TOP_FILES))) +DOCUMENTATION_INCLUDES = -I $(top-src-dir)/Documentation/user diff --git a/tex/GNUmakefile b/tex/GNUmakefile index 9f275d7041..64e2653bd9 100644 --- a/tex/GNUmakefile +++ b/tex/GNUmakefile @@ -1,7 +1,7 @@ depth = .. TEXINFO_FILES = texinfo.tex $(call src-wildcard,txi-*.tex) -TEX_FILES = $(filter-out $TEXINFO_FILES,$(call src-wildcard,*.tex)) +TEX_FILES = $(filter-out $(TEXINFO_FILES),$(call src-wildcard,*.tex)) EXTRA_DIST_FILES = $(TEX_FILES) $(TEXINFO_FILES) STEPMAKE_TEMPLATES = install install-out