From 9e4cf2b7c2acbe696ea4645a560d1c33a2138534 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Wed, 18 Aug 2010 13:17:15 +0100 Subject: [PATCH] Doc: CG: cleanup formatting in releases chapter. --- Documentation/contributor/release-work.itexi | 179 +++++++++++-------- Documentation/contributor/website-work.itexi | 6 +- 2 files changed, 103 insertions(+), 82 deletions(-) diff --git a/Documentation/contributor/release-work.itexi b/Documentation/contributor/release-work.itexi index 2be94a1f44..bc75eaf623 100644 --- a/Documentation/contributor/release-work.itexi +++ b/Documentation/contributor/release-work.itexi @@ -126,24 +126,31 @@ or two in case there's any major problems. @enumerate @item If you're not the right user on the webserver, remove the -"t" from the rsync command in -@file{test@/-lily/@/rsync@/-lily@/-doc@/.py} and -@file{test@/-lily/@/rsync@/-test@/.py} +@code{t} from the rsync command in: + +@example +test-lily/rsync-lily-doc.py +test-lily/rsync-test.py +@end example @code{graham} owns v2.13; @code{han-wen} owns v2.12. @item Upload GUB by running: -@smallexample -make lilypond-upload LILYPOND_BRANCH=release/unstable LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git -@end smallexample +@example +make lilypond-upload \ + LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git \ + LILYPOND_BRANCH=release/unstable +@end example @noindent or something like: -@smallexample -make lilypond-upload LILYPOND_BRANCH=stable/2.12 LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git -@end smallexample +@example +make lilypond-upload \ + LILYPOND_REPO_URL=git://git.sv.gnu.org/lilypond.git \ + LILYPOND_BRANCH=stable/2.12 +@end example @end enumerate @@ -213,134 +220,148 @@ A @qq{major release} means an update of @code{x} in @code{2.x.0}. @subheading Main requirements -It happens when we have 0 Critical issues for two weeks (14 days) -after the latest release candidate. +This is the current official guidelines. -@subheading Housekeeping requirements +@itemize +@item +0 Critical issues for two weeks (14 days) after the latest release +candidate. -Before the release: +@end itemize + + +@subheading Potential requirements + +These might become official guidelines in the future. @itemize @item -write release notes. note: stringent size requirements for -various websites, so be brief. +Check reg test @item -* write preface section for manual. +Check all 2ly scripts @item -* submit pots for translation: send url of tarball to -translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot +Check for emergencies the docs: -@item -* Check reg test +@example +grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \ + --exclude "snippets/*" ????*/* +@end example @item -* Check all 2ly scripts. +Check for altered regtests, and document as necessary. (update +numbers in the following command as appropriate) -@item -* Run convert-ly on all files, bump parser minimum version. +@example +git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/ +@end example -@item -* update links to distros providing lilypond packages? link in -Documentation/web/download.itexi . This has nothing to do with -the release, but I'm dumping this here so I'll find it when I -reorganize this list later. -gp +@end itemize -@item -* Make FTP directories on lilypond.org -@item -* website: - - Make new table in download.html +@subheading Housekeeping requirements + +Before the release: - - add to documentation list +@itemize +@item +write release notes. note: stringent size requirements for +various websites, so be brief. - - revise examples tour.html/howto.html +@item +Run convert-ly on all files, bump parser minimum version. - - add to front-page quick links +@item +Make FTP directories on lilypond.org - - change all links to the stable documentation +@item +Website: - - make a link from the old unstable to the next stable in - lilypond.org's /doc/ dir. Keep all previous unstable->stable - doc symlinks. +@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. - - doc auto redirects to v2.LATEST-STABLE +@item +doc auto redirects to v2.LATEST-STABLE - - add these two lines to http://www.lilypond.org/robots.txt: +@item +add these two lines to http://www.lilypond.org/robots.txt: @example Disallow: /doc/v2.PREVIOUS-STABLE/ Disallow: /doc/v2.CURRENT-DEVELOPMENT/ @end example -@item -- check for emergencies the docs: +@end itemize -@example -grep FIXME --exclude "misc/*" --exclude "*GNUmakefile" \ - --exclude "snippets/*" ????*/* -@end example +@end itemize + +@subheading Unsorted +@itemize @item -- check for altered regtests, and document as necessary. (update - tags as appropriate) +submit pots for translation: send url of tarball to +translation@@iro.umontreal.ca, mentioning lilypond-VERSION.pot -@example -git diff -u -r release/2.12.0-1 -r release/2.13.13-1 input/regression/ -@end example +@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. @item +Send announcements to... + News: @example - comp.music.research - comp.os.linux.announce +comp.music.research +comp.os.linux.announce - comp.text.tex - rec.music.compose +comp.text.tex +rec.music.compose @end example -@item Mail: @example - info-lilypond@@gnu.org +info-lilypond@@gnu.org linux-audio-announce@@lists.linuxaudio.org linux-audio-user@@lists.linuxaudio.org linux-audio-dev@@lists.linuxaudio.org - tex-music@@icking-music-archive.org +tex-music@@icking-music-archive.org - --- non-existant? - abcusers@@blackmill.net +--- non-existant? +abcusers@@blackmill.net - rosegarden-user@@lists.sourceforge.net - info-gnu@@gnu.org - noteedit-user@@berlios.de +rosegarden-user@@lists.sourceforge.net +info-gnu@@gnu.org +noteedit-user@@berlios.de - gmane.comp.audio.fomus.devel - gmane.linux.audio.users - gmane.linux.audio.announce - gmane.comp.audio.rosegarden.devel +gmane.comp.audio.fomus.devel +gmane.linux.audio.users +gmane.linux.audio.announce +gmane.comp.audio.rosegarden.devel @end example -@item Web: @example - lilypond.org - freshmeat.net - linuxfr.com - http://www.apple.com/downloads - harmony-central.com (news@@harmony-central.com) - versiontracker.com [auto] - hitsquad.com [auto] - http://www.svgx.org - https://savannah.gnu.org/news/submit.php?group_id=1673 @c => planet.gnu.org +lilypond.org +freshmeat.net +linuxfr.com +http://www.apple.com/downloads +harmony-central.com (news@@harmony-central.com) +versiontracker.com [auto] +hitsquad.com [auto] +http://www.svgx.org +https://savannah.gnu.org/news/submit.php?group_id=1673 @c => planet.gnu.org @end example @end itemize diff --git a/Documentation/contributor/website-work.itexi b/Documentation/contributor/website-work.itexi index fc10f0e6f1..037e265b8a 100644 --- a/Documentation/contributor/website-work.itexi +++ b/Documentation/contributor/website-work.itexi @@ -16,10 +16,10 @@ The website is @emph{not} written directly in HTML; instead, the source is Texinfo, which is then generated into HTML, PDF, and Info formats. The sources are -@verbatim +@example Documentation/web.texi Documentation/web/*.texi -@end verbatim +@end example Unless otherwise specified, follow the instructions and policies given in @ref{Documentation work}. That chapter also contains a @@ -43,7 +43,7 @@ the IR or certain NR appendices. @item For anything not listed here, just follow the same style as the -existing texinfo files. +existing website texinfo files. @end itemize -- 2.39.5