Carl D. Sorensen a écrit :
When you run makelsr.py, do you get a message about new snippets that have
been added, so you know snippet names to search the documentation for?
After you have run makelsr.py and cheked for unsafe snippets with the
recommended commands, just look for "new file" in "git status" output.
OK, so how about this for proposal 3 for something to go into the CG:
Let me amend each paragraph according to latest changes in makelsr.py --
what you read below will be valid if and only if my suggestion to bypass
"lilypond --safe" check for input/new is accepted.
"If a new snippet created for documentation purposes will compile in
the current LSR version, the snippet should be added to the LSR, and a
reference to the snippet should be added to the documentation.
If the new snippet uses new features that are not available in the
current LSR version, the snippet should be added to input/new and a
reference should be added to the manual.
Because snippets added to the LSR and input/new are not available until
makelsr.py has been run, the manual reference to new snippets should be
surrounded by @cod...@ignore} and @cod...@end ignore}.
This paragraph should be replaced with
"Snippets created or updated in input/new should be copied to input/lsr
by invoking at top of the source tree
@example
scripts/auxiliar/makelsr.py
@end example
To have a snippet appear in the documentation before the LSR update and/or
makelsr.py run have been completed, copy the snippet to input/lsr. Modify
the copy of the snippet in input/lsr by adding @code{ % begin verbatim }
immediately after the header. Remove the @cod...@ignore} block from
the documentation, and run make web. Be sure that make web runs
successfully before submitting a patch, to prevent breaking compilation.
The last sentence of this paragraph should be kept, the rest should be
removed.
The handmade snippet copy in input/lsr will be overwritten by an
automatically-generated copy when makelsr.py is executed by the snippet
maintainer."
I think this is not necessary.
Thanks for yout work Carl; maybe this could be completed with
information from input/new/README. Btw we may want to junk
input/lsr/README, as (or if) its contents is in the CG.
IMHO you should push this to Git soon, as all essential techical issues
are solved (besides the point in makelsr.py).
Best,
John
_______________________________________________
lilypond-devel mailing list
lilypond-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/lilypond-devel
