Updating documentation translation

Instead of running check-translation, you may want to execute update-translation, which will run your favorite text editor to update files. First, make sure the environment variable EDITOR is set to a text editor command, then run from Documentation/

make ISOLANG=MY-LANGUAGE update-translation

or, to update a single file,

make TRANSLATION_FILES=MY-LANGUAGE/manual/foo.itely update-translation

For each file to be updated, update-translation will open your text editor with this file and a diff of the file in English; if the diff cannot be generated or is bigger than the file in English itself, the full file in English will be opened instead.

Note: do not forget to update the committish in each file you have completely updated, see Updating translation committishes.

.po message catalogs in Documentation/po/ may be updated by changing to either directory Documentation/ or Documentation/po/ and issuing

make po-update

However, this make target doesn’t work properly right now.

Note: if you run po-update and somebody else does the same and pushes before you push or send a patch to be applied to the git repository, there will be a conflict when you pull.

Updating music snippets can quickly become cumbersome, as most snippets should be identical in all languages. Fortunately, there is a script that can do this odd job for you (to be run from Documentation/):

make ISOLANG=MY-LANGUAGE snippet-update

This make target calls a script to overwrite music snippets in all .itely files in the MY-LANGUAGE/ subdirectory with music snippets taken from the en/ subdirectory. It ignores skeleton files and doesn’t modify music snippets that are preceded by a line starting with @c KEEP LY. It reports an error for each .itely file that has not the same music snippet count in both languages. Always use this script with a lot of care, i.e., run it on a clean git working tree, and check the changes it made with git diff before committing! If you don’t do so, some @lilypond snippets might be broken or make no sense in their context.

See also

Maintaining without updating translations, Adding and editing snippets.


LilyPond Contributor’s Guide v2.25.22 (development-branch).