Merge branch 'lilypond/translation'

[lilypond.git] / Documentation / contributor / lsr-work.itexi

diff --git a/Documentation/contributor/lsr-work.itexi b/Documentation/contributor/lsr-work.itexi
index e1e770a560c59f9bb898d2735070bdc9483543bb..794ad54937ee17f194192e2a3dae582d719f782c 100644 (file)
--- a/Documentation/contributor/lsr-work.itexi
+++ b/Documentation/contributor/lsr-work.itexi
@@ -8,6 +8,7 @@
 * Approving snippets::
 * LSR to Git::
 * Fixing snippets in LilyPond sources::
 * Approving snippets::
 * LSR to Git::
 * Fixing snippets in LilyPond sources::

+* Renaming a snippet::

 * Updating LSR to a new version::
 @end menu
 
 * Updating LSR to a new version::
 @end menu
 


@@ -80,11 +81,16 @@ When adding a file to this directory, please start the file with
 @example
 \version "2.x.y"
 \header @{
 @example
 \version "2.x.y"
 \header @{

-  lsrtags = "rhythms,expressive-marks"  % use existing LSR tags other than
-%   'docs'; see makelsr.py for the list of tags used to sort snippets.
-  texidoc = "This code demonstrates ..."  % this will be formated by Texinfo
-  doctitle = "Snippet title"  % please put this at the end so that
-    the '% begin verbatim' mark is added correctly by makelsr.py.
+% Use existing LSR tags other than 'docs'; see makelsr.py for
+% the list of tags used to sort snippets.  E.g.:
+  lsrtags = "rhythms,expressive-marks"
+% This texidoc string will be formatted by Texinfo
+  texidoc = "
+This code demonstrates ...
+"
+% Please put doctitle last so that the '% begin verbatim'
+% mark will be added correctly by makelsr.py.
+  doctitle = "Snippet title"

 @}
 @end example
 
 @}
 @end example
 


@@ -218,6 +224,31 @@ In any case, commit all changes to Git.
 @end enumerate
 
 
 @end enumerate
 
 

+@node Renaming a snippet
+@section Renaming a snippet
+
+Due to the potential duality of snippets (i.e. they may exist both
+in the LSR database, and in @code{Documentation/snippets/new/}),
+this process is a bit more involved than we might like.
+
+@enumerate
+@item
+Send an email LSR editor, requesting the renaming.
+
+@item
+The LSR editor does the renaming (or debates the topic with you),
+then warns the LSR-to-git person (wanted: better title) about the
+renaming.
+
+@item
+LSR-to-git person does his normal job, but then also renames any
+copies of the snippets in @code{Documentation/snippets/new/}, and
+any instances of the snippet name in the documentation.
+
+@code{git grep} is highly recommended for this task.
+
+@end enumerate
+

 
 @node Updating LSR to a new version
 @section Updating LSR to a new version
 
 @node Updating LSR to a new version
 @section Updating LSR to a new version


@@ -263,7 +294,7 @@ included, then delete those snippets from
 @end enumerate
 
 
 @end enumerate
 
 

-Here is a shell script to run all @code{.ly} files in a directory
+Here is a shell script to run all @file{@/.ly} files in a directory

 and redirect terminal output to text files, which are then
 searched for the word "failed" to see which snippets do not compile.
 
 and redirect terminal output to text files, which are then
 searched for the word "failed" to see which snippets do not compile.