[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Doc patch for relative includes.
From: |
Graham Percival |
Subject: |
Re: Doc patch for relative includes. |
Date: |
Wed, 31 Dec 2008 14:21:26 -0800 |
User-agent: |
Mutt/1.5.18 (2008-05-17) |
LGTM.
Ideally we'd want an example in there, but I'm not certain how to
do it without breaking compiling (other than putting it inside
@examlpe rather than @lilypond). But this is the kind of thing
that a new doc contributor should play with, not you. :)
Cheers,
- Graham
On Thu, Jan 01, 2009 at 09:18:15AM +1100, Joe Neeman wrote:
> Here is a patch to the documentation regarding bug 391 (relative \include
> paths). Could a doc writer please take a quick look?
>
> Joe
>
> From 85333ead871d09ad4a40f8096b6c71a2086ceb76 Mon Sep 17 00:00:00 2001
> From: Joe Neeman <address@hidden>
> Date: Thu, 1 Jan 2009 09:09:46 +1100
> Subject: [PATCH] Add documentation recommending the use of
> -drelative-includes.
>
> ---
> Documentation/user/input.itely | 12 ++++++++++--
> 1 files changed, 10 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/user/input.itely b/Documentation/user/input.itely
> index c990b3b..13a8612 100644
> --- a/Documentation/user/input.itely
> +++ b/Documentation/user/input.itely
> @@ -849,11 +849,19 @@ subdirectory called @file{parts} within the current
> directory, use
> @end example
>
> Files which are to be included can also contain @code{\include}
> -statements of their own. These second-level
> +statements of their own. By default, these second-level
> @code{\include} statements are not interpreted until they have
> been brought into the main file, so the file names they specify
> must all be relative to the directory containing the main file,
> -not the directory containing the included file.
> +not the directory containing the included file. However,
> +this behavior can be changed by passing the option
> address@hidden option at the command line
> +(or by adding using @code{#(ly:set-option 'relative-includes #t)}
> +at the top of the main input file). With @code{relative-includes}
> +set, the path for each @code{\include} command will be taken
> +relative to the file containing that command. This behavior is
> +recommended and it will become the default behavior in a future
> +version of lilypond.
>
> Files can also be included from a directory in a search path
> specified as an option when invoking LilyPond from the command
> --
> 1.6.0.2
>
> _______________________________________________
> lilypond-devel mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/lilypond-devel