]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/release-work.itexi
Doc: Updates to CG, Extending, LM and Paper-defaults.ly
[lilypond.git] / Documentation / contributor / release-work.itexi
index 5dbc3082540a000a12acbdffc72198b85b31c420..3869505630435d485154fbee19250a5d8041a8bc 100644 (file)
@@ -74,11 +74,46 @@ A @qq{minor release} means an update of @code{y} in @code{2.x.y}.
 
 @enumerate
 
+@item
+Don't forget to prepare the GUB build machine by deleting and moving unneeded
+files: see @qq{Subsequent builds} in @ref{Notes on builds with GUB}.
+
 @item
 Using any system with git pull access (not necessarily the GUB
-build machine), use the commands below to switch to the release
-branch, get changes and prepare the release
-announcement.  This requires a system which has the release/unstable
+build machine), use the commands below to do the following:
+
+@itemize
+@item
+switch to the release branch
+
+@item
+update the release branch from origin/master
+
+@item
+update the translation files
+
+@item
+create the release announcement
+
+@item
+update the build versions.
+
+@itemize
+@item
+VERSION_DEVEL = the current development version (previous VERSION_DEVEL + 0.01)
+
+@item
+VERSION_STABLE = the current stable version (probably no change here)
+
+@end itemize
+
+@item
+update the @qq{Welcome to LilyPond} version numbers to the version about to be
+released
+
+@end itemize
+
+This requires a system which has the release/unstable
 branch.  If you get a warning saying you are in @code{detached HEAD}
 state, then you should create a release/unstable branch with
 @code{git checkout release/unstable}.
@@ -98,17 +133,9 @@ make -C $LILYPOND_BUILD_DIR po-replace
 mv $LILYPOND_BUILD_DIR/po/lilypond.pot po/
 gedit Documentation/web/news-front.itexi Documentation/web/news.itexi
 gedit VERSION
+gedit ly/Wel*.ly
 @end example
 
-@itemize
-@item
-VERSION_DEVEL = the current development version (previous VERSION_DEVEL + 0.01)
-
-@item
-VERSION_STABLE = the current stable version (probably no change here)
-
-@end itemize
-
 @item
 Commit, push, switch back to master (or wherever else):
 
@@ -116,6 +143,7 @@ Commit, push, switch back to master (or wherever else):
 git commit -m "Release: bump VERSION_DEVEL." VERSION
 git commit -m "PO: update template." po/lilypond.pot
 git commit -m "Release: update news." Documentation/web/
+git commit -m "Release: bump Welcome versions." ly/Wel*.ly
 git push origin HEAD:release/unstable
 git checkout master
 @end example
@@ -261,7 +289,7 @@ A @qq{major release} means an update of @code{x} in @code{2.x.0}.
 
 @subheading Main requirements
 
-This is the current official guidelines.
+These are the current official guidelines.
 
 @itemize
 @item
@@ -291,11 +319,11 @@ grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \
 @end example
 
 @item
-Check for altered regtests, and document as necessary.  (update
-numbers in the following command as appropriate)
+Check for altered regtests, and document as necessary:
 
 @example
-git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/
+git diff -u -r release/2.@var{FIRST-CURRENT-STABLE} \
+  -r release/2.@var{LAST-CURRENT-DEVELOPMENT} input/regression/
 @end example
 
 @end itemize
@@ -325,55 +353,53 @@ mv $LILYPOND_BUILD_DIR/po/lilypond.pot po/
 Make directories on lilypond.org:
 
 @example
-~/web/download/sources/v2.14
-~/web/download/sources/v2.15
+~/download/sources/v2.@var{NEW-STABLE}
+~/download/sources/v2.@var{NEW-DEVELOPMENT}
 @end example
 
 @item
 Shortly after the release, move all current contributors to
-previous contributors in:
+previous contributors in
+@file{Documentation/included/authors.itexi}.
 
-@example
-Documentation/included/authors.itexi
-@end example
-
-Also, delete old material in:
+@item
+Delete old material in @file{Documentation/changes.tely}, but
+don't forget to check it still compiles!  Also update the version
+numbers:
 
 @example
-Documentation/changes.tely
+@@node Top
+@@top New features in 2.@var{NEW-STABLE} since 2.@var{OLD-STABLE}
 @end example
 
-but don't forget to check it still compiles!  also update the
-version numbers.
-
 @item
 Website:
 
 @itemize
 @item
 make a link from the old unstable to the next stable in
-lilypond.org's /doc/ dir.  Keep all previous unstable->stable doc
-symlinks.
+lilypond.org's @file{/doc/} dir.  Keep all previous unstable->stable
+doc symlinks.
 
 Also, make the old docs self-contained -- if there's a redirect in
-/doc/v2.12/Documentation/index.html , replace it with the
-index.html.old-2.12 files.
+@file{/doc/v2.@var{OLD-STABLE}/Documentation/index.html} , replace it with the
+@file{index.html.old-2.@var{OLD-STABLE}} files.
 
 The post-2.13 docs will need another way of handling the
 self-containment.  It won't be hard to whip up a python script
-that changes the link to ../../../../manuals.html to
-../website/manuals.html , but it's still a 30-minute task that
+that changes the link to @file{../../../../manuals.html} to
+@file{../website/manuals.html}, but it's still a 30-minute task that
 needs to be done before 2.16.
 
 @item
-doc auto redirects  to v2.LATEST-STABLE
+doc auto redirects to @code{v2.@var{NEW-STABLE}}
 
 @item
-add these two lines to http://www.lilypond.org/robots.txt:
+add these two lines to @file{Documentation/web/server/robots.txt}:
 
 @example
-Disallow: /doc/v2.PREVIOUS-STABLE/
-Disallow: /doc/v2.CURRENT-DEVELOPMENT/
+Disallow: /doc/v2.@var{OLD-STABLE}/
+Disallow: /doc/v2.@var{NEW-DEVELOPMENT}/
 @end example
 
 @end itemize
@@ -385,14 +411,15 @@ Disallow: /doc/v2.CURRENT-DEVELOPMENT/
 @itemize
 @item
 submit po template for translation: send url of tarball to
-coordinator@@translationproject.org, mentioning lilypond-VERSION.pot
+@email{coordinator@@translationproject.org}, mentioning
+lilypond-VERSION.pot
 
 @item
 update links to distros providing lilypond packages?  link in:
 @file{Documentation/web/download.itexi}
 
-This has nothing to do with the release, but it's a "periodic
-maintenance" task that might make sense to include with releases.
+This has nothing to do with the release, but it's a @qq{periodic
+maintenance} task that might make sense to include with releases.
 
 @item
 Send announcements to...
@@ -561,7 +588,7 @@ to continue uninterrupted.
 Download GUB and start the set up:
 
 @example
-git clone git://github.com/gperciva/gub/gub.git
+git clone git://github.com/gperciva/gub.git
 cd gub
 make bootstrap
 @end example