[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
CG section 5 (Documentation work) and doc scripts
From: |
Greg |
Subject: |
CG section 5 (Documentation work) and doc scripts |
Date: |
Tue, 22 Dec 2015 21:21:28 +0000 |
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.
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.
Thanks,
Greg.
0001-Doc-CG-5-Documentation-work-capitalisation-of-Git-an.patch
Description: Binary data
0002-Doc-CG-5.7.1-Documentation-work-esp.-build-subdirect.patch
Description: Binary data
- CG section 5 (Documentation work) and doc scripts,
Greg <=