[Top][All Lists]

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

Re: CG section 5 (Documentation work) and doc scripts

From: James
Subject: Re: CG section 5 (Documentation work) and doc scripts
Date: Wed, 23 Dec 2015 19:37:56 +0000
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.4.0

Hello Greg,.

On 22/12/15 21:21, Greg wrote:
> I have made some improvements to the Contributors' Guide: section 5
> (Documentation work) and attach two patches.
> Attached patch 0001 corrects some capitalisation of 'Git' and 'HTML'
> (c.f.
> [http://www.lilypond.org/doc/v2.19/Documentation/source/Documentation/contributor/other-text-concerns]).
> Attached patch 0002 improves
> [http://www.lilypond.org/doc/v2.19/Documentation/source/Documentation/contributor/scripts-to-test-the-documentation],
> particularly with regard to the build/ subdirectory.

Thank you I have created


for your patches

I will add you as a CC to the Rietveld Issue for code review purposes.

> Being new to editing the docs, I have also noticed a couple of problems
> with scripts/auxiliar/doc-section.sh and scripts/auxiliar/cg-section.sh.
> If you run doc-section.sh without lilypond-book having been built under
> the build/ subdirectory, the script fails. Perhaps the script could test
> for the presence of an installed version of lilypond-book (version 2.19)
> and use this instead if a copy is not available in build/. It is of
> course possible to alter LILYPOND_BOOK, which could instead be mentioned
> in the docs.
> There is also a problem with cg-section.sh compared with doc-section.sh.
> If cg-section.sh is run without the build/ and build/tempdocs/
> subdirectories, the script fails with mkdir errors. However,
> doc-section.sh does have better checking for missing subdirectories. It
> would be helpful if cg-section.sh could check for missing subdirectories
> and create them as necessary.
Added as a build enhancement


> Thanks,
> Greg.

Thank you.


reply via email to

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