[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Update roadmap, make and make doc info. (issue 5811043)

From: julien . rioux
Subject: Update roadmap, make and make doc info. (issue 5811043)
Date: Tue, 13 Mar 2012 20:33:29 +0000


Please review.

Update roadmap, make and make doc info.

CG: Review info about the build system.
CG: Update info about make doc.

Please review this at

Affected files:
  M Documentation/contributor/build-notes.itexi
  M Documentation/included/compile.itexi

Index: Documentation/contributor/build-notes.itexi
diff --git a/Documentation/contributor/build-notes.itexi b/Documentation/contributor/build-notes.itexi index bf779982290e370c48f89f3c5ecb92731b12ef02..a1e258cc91a369eb8b65d06c70a8e2efe411f3d6 100644
--- a/Documentation/contributor/build-notes.itexi
+++ b/Documentation/contributor/build-notes.itexi
@@ -117,9 +117,11 @@ include $(configure-srcdir)/

 The variable @code{depth} is used throughout the make system to
 track how far down the directory structure the make is.  The first
-include sets lots of variables but doesn't "do" anything.  The
-second runs the file @file{} from the top level
-source directory.
+include sets lots of variables but doesn't "do" anything.  Default
+values for these variables are automatically detected at the
+./configure step, which creates the file @file{config.make}.
+The second include runs the file @file{} from
+the top level source directory.

 This sets another load of variables, and then includes (i.e.
 immediately runs) @file{stepmake.make} from the @file{make}
@@ -957,6 +959,7 @@ described to some extent at

 The file @file{lily-bib.bst} also has fairly extensive commenting.

 @node Website build
 @section Website build

Index: Documentation/included/compile.itexi
diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index f4ed097da593411c2e20e41b1193735345a83616..c3aa45de1cffeaaae70ba9c589b04c9e68eec87c 100644
--- a/Documentation/included/compile.itexi
+++ b/Documentation/included/compile.itexi
@@ -605,7 +605,6 @@ Edit/compile cycle:
 make address@hidden                  @emph{## needed if editing outside}
                             @emph{##   Documentation/, but useful anyway}
                             @emph{##   for finding Texinfo errors.}
-touch Documentation/*te??   @emph{## bug workaround}
make address@hidden address@hidden doc @emph{## usually faster than initial build.}
 @end example

@@ -655,6 +654,17 @@ on their own with:
 make LANGS='' doc
 @end example

address@hidden Similarly, it is possible to compile a subset of the
+translated documentation by specifying their language codes on the
+command line.  For example, the French and German translations are
+compiled with:
+make LANGS='de fr' doc
address@hidden example
address@hidden Note that this will also compile the English version.
 Compilation of documentation in Info format with images can be
 done separately by issuing:

@@ -705,6 +715,18 @@ However, this will rebuild all of the manuals
 indiscriminately---it is more efficient to @command{touch} only
 the affected files.

+Another typical issue when switching branches between master and
+lilypond/translation is the appearance/disappearance of translated
+versions of some manuals.  If you see such a warning from make:
+No rule to make target `X', needed by `Y'
address@hidden example
+Your best bet is to delete the file Y.dep and to try again.
 @node Building a single document
 @unnumberedsubsubsec Building a single document
 It's possible to build a single document.  For example, to rebuild
diff --git a/ROADMAP b/ROADMAP
index 8b66091810a62b4c49cdc1ce0cfbeff5e877be81..99ad6b7fb6afe707b9079195a50a8a4f1fbc0f0a 100644
@@ -26,7 +26,6 @@ LilyPond's source files.
 |   |-- notation/        Notation Reference
 |   |-- usage/           Usage
 |   |-- web/             The website
-|   |   `-- ly-examples/ .ly files for the "Examples" page
 |   |
 |   |
@@ -36,6 +35,7 @@ LilyPond's source files.
 |   |          * individual chapters for each manual
 |   |       2) a texidocs/ directory for snippet translations
 |   |
+|   |-- cs/              Czech
 |   |-- de/              German
 |   |-- es/              Spanish
 |   |-- fr/              French
@@ -43,6 +43,7 @@ LilyPond's source files.
 |   |-- it/              Italian
 |   |-- ja/              Japanese
 |   |-- nl/              Dutch
+|   |-- zh/              Chinese
 |   |
 |   |
@@ -50,6 +51,7 @@ LilyPond's source files.
 |   |-- css/             CSS files for HTML docs
 |   |-- included/        .ly files used in the manuals
 |   |-- logo/            Web logo and "note" icon
+|   |-- ly-examples/     .ly files for the "Examples" webpage
 |   |-- misc/            Old announcements, ChangeLogs and NEWS
 |   |-- pictures/        Images used (eps/jpg/png/svg)
 |   |   `-- pdf/         (pdf)
@@ -95,6 +97,8 @@ LilyPond's source files.
 |-- input/
 |   `-- regression/      .ly regression tests
 |       |-- abc2ly/      .abc regression tests
+|       |-- lilypond-book/  lilypond-book regression tests
+|       |-- midi/        midi2ly regression tests
 |       `-- musicxml/    .xml and .itexi regression tests

reply via email to

[Prev in Thread] Current Thread [Next in Thread]