X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fcontributor%2Fissues.itexi;h=56b97d38be4e6dc50a00250631adea3f90827110;hb=54b02666750062788185bd3f99e644d621e348c2;hp=dbd1421ae0cdf4a630c26810b749d0d731d9cbd4;hpb=ec005c75b76a86d93911580f9c7980defaf82d45;p=lilypond.git diff --git a/Documentation/contributor/issues.itexi b/Documentation/contributor/issues.itexi index dbd1421ae0..56b97d38be 100644 --- a/Documentation/contributor/issues.itexi +++ b/Documentation/contributor/issues.itexi @@ -11,8 +11,8 @@ miscellaneous development tasks. * Bug Squad checklists:: * Issue classification:: * Adding issues to the tracker:: +* Patch handling:: * Summary of project status:: -* Finding the cause of a regression:: @end menu @@ -50,9 +50,7 @@ you sort your folders alphabetically. @enumerate @item -Skim through every section of this chapter, @ref{Issues}. Read in -detail any sections called @qq{Bug Squad...}, or any page linked -from @ref{Bug Squad checklists}. +Read every section of this chapter, @ref{Issues}. @item If you do not have one already, create a gmail account and send @@ -80,8 +78,8 @@ Sign in to google code by clicking in the top-right corner of: @uref{http://code.google.com/p/lilypond/issues/list} @end example -You cannot log if you have Google Sharing -@uref{http://www.googlesharing.net/} enabled. +You cannot log on if you have Google Sharing enabled +@uref{http://www.googlesharing.net/}. @item Go to your @qq{Profile}, and select @qq{Settings}. @@ -139,7 +137,7 @@ should go into a separate @code{bug-current} folder. @section Bug Squad checklists When you do Bug Squad work, start at the top of this page and work -your way down. Stop when you've done 15 minutes. +your way down. Stop when you've done 20 minutes. Please use the email sorting described in @ref{Bug Squad setup}. This means that (as Bug Squad members) you will only ever respond @@ -149,7 +147,7 @@ to emails sent or CC'd to the @code{bug-lilypond} mailing list. @subsubheading Emails to you personally You are not expected to work on Bug Squad matters outside of your -15 minutes, but sometimes a confused user will send a bug report +20 minutes, but sometimes a confused user will send a bug report (or an update to a report) to you personally. If that happens, please forward such emails to the @code{bug-lilypond} list so that the currently-active Bug Squad member(s) can handle the message. @@ -157,16 +155,16 @@ the currently-active Bug Squad member(s) can handle the message. @subsubheading Daily schedule -The Bug Meister is omitted from the daily schedule. +@c spacing is deliberate to help reinforce the "cyclic" nature @example -Sunday: Colin -Monday: Dmytro -Tuesday: James Bailey -Wednesday: Ralph -Thursday: Patrick -Friday: Urs -Saturday: Kieren +Monday: Dmytro +Tuesday: Colin +Wednesday: Derek +Thursday: Dmytro +Friday: Colin +Saturday: Derek +Sunday: Phil @end example @@ -331,8 +329,8 @@ More information is available from in @item Issues to verify: try to reproduce the bug with the latest -version; if you cannot reproduce the bug, mark the item -@qq{Verified} (i.e. @qq{the fix has been verified to work}). +official GUB version; if you cannot reproduce the bug, mark the +item @qq{Verified} (i.e. @qq{the fix has been verified to work}). @example @uref{http://code.google.com/p/lilypond/issues/list?can=7} @@ -343,34 +341,17 @@ build system or fundamental architecture changes; there is no way for you to verify these. Leave those issues alone; somebody else will handle them. -@end itemize - - -@ignore -@c try omitting from daily tasks for now. -gp - -Once every @strong{two weeks} or so: - -@itemize - @item Check for any incorrectly-classified items in the tracker. This generally just means looking at the grid to see any items without a Type or Priority. -@item -Check for any items with @code{label:patch}. If it's been more -than a week since the last action on the issue, send an email to --devel to remind them about it. If the patch was withdrawn for -more work, then remove the @code{patch} label. - -@example -@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:patch} -@end example - @end itemize +@ignore +@c try omitting from daily tasks for now. -gp + @subheading Irregular maintenance @warning{These tasks are a lot of work; gathering more volunteers @@ -507,7 +488,7 @@ Currently, only Critical items will block a stable release. Priority-Critical: LilyPond segfaults, a regression (see below) against a previous stable version or a regression against a fix developed for this version. This does not apply where the -"regression" occurred because a feature was removed +@qq{regression} occurred because a feature was removed deliberately - this is not a bug. @item @@ -546,6 +527,40 @@ be downgraded from Priority-Critical by one of the programmers. Issues that only affect specific operating systems. +@subheading Patch (optional) + +Normal Bug Squad members should not add or modify Patch issues; +leave them to the Patch Meister. + +@itemize + +@item +Patch-new: the patch has not been checked for @qq{obvious} +mistakes. When in doubt, use this tag. + +@item +Patch-review: the patch has no @qq{obvious} mistakes (as checked +by the Patch Meister), and is ready for review from main +developers. + +Developers with git push ability can use this category, skipping +over @code{patch-new}. + +@item +Patch-needs_work: a developer has some concerns about the patch. +This does not necessarily mean that the patch must be changed; in +some cases, the developer's concerns can be resolved simply by +discussion the situation or providing notation examples. + +If the patch is updated, the category should be changed to +@code{patch-new} (for normal contributors) or @code{patch-review} +(for developers who are very confident about their patch). + +@item +Patch-abandoned: the author has not responded to review comments +for a few months. + +@end itemize @subheading Other items (optional) @@ -582,9 +597,6 @@ recategorised or marked invalid. In particular, anything that breaks a regression test is a regression. -@item -Patch: a patch to fix an issue is attached. - @item Frog: the fix is believed to be suitable for a new contributor (does not require a great deal of knowledge about LilyPond). The @@ -627,8 +639,6 @@ follow the guidelines for @rweb{Bug reports}.} In order to assign labels to issues, Bug Squad members should log in to their google account before adding an item. -@subsubheading Normal issues - @enumerate @item @@ -671,6 +681,15 @@ If the issue requires one or two pages of output, then generate a lilypond --png bug.ly @end example +@item +Images created as @file{bug.png} may be trimmed to a minimum size +by using the @code{trimtagline.sh} script, which can be found at +@uref{https://raw.github.com/gperciva/lilypond-extra/master/bug-squad/trimtagline.sh} + +@example +trimtagline.sh bug.ly +@end example + @item If the issue cannot be shown with less than three pages, then generate a @file{bug.pdf} file with: @@ -695,201 +714,168 @@ email should contain a link to the issue you just added. @end enumerate -@subsubheading Patch reminders + +@node Patch handling +@section Patch handling @warning{This is not a Bug Squad responsibility; we have a separate person handling this task.} -There is a special category of issues: reminders of an existing -patch. These should be added if a patch has been sent to a -lilypond mailing list (generally @code{lilypond-devel}, but they -sometimes appear on @code{bug-lilypond} as well) and has had no -discussion for at least @strong{3 days}. Do not add issues for -patches under active discussion. - -Before adding a patch-reminder issue, do a quick check to see if -it was pushed without sending any email. This can be checked for -searching for relevant terms (from the patch subject or commit -message) on the webgit page: +There is a single Patch Meister, and a number of Patch Helpers +(rename this?). The list of known patches awaiting review is: @example -@uref{http://git.savannah.gnu.org/gitweb/?p=lilypond.git} +@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:patch&sort=patch} @end example -After adding the issue, please send a response email to the same -group(s) that the initial patch was sent to. If the initial email -was sent to multiple mailing lists (such as both @code{bugs} and -@code{devel}), then reply to all those mailing lists as well. The -email should contain a link to the issue you just added. +@subheading Helpers: adding patches +The primary duty is to add patches to the google tracker; we have +a bad track record of losing patches in email. Patches generally +come to the @code{lilypond-devel} mailing list, but are sometimes +sent to @code{bug-lilypond}, @code{lilypond-users}, or +@code{frogs} mailing list instead. -@node Summary of project status -@section Summary of project status - -The best overview of our current status is given by the grid view: - -@example -@uref{http://code.google.com/p/lilypond/issues/list?mode=grid&y=Priority&x=Type&cells=ids} -@end example - -Also of interest might be the issues hindering future development: +@itemize +@item +Unless a patch is clearly in response to an existing issue, add a +new issue with the @code{Patch-new} label and a link to the patch +(either on the mailing list archives or the codereview url). -@example -@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:Maintainability&mode=grid&y=Priority&x=Type&cells=ids} -@end example +Issue numbers are cheap; losing developers because they got fed up +with us losing their hard work is expensive. -Finally, issues tagged with @code{Frog} indicates a task suitable -for a relatively new contributor. The time given is a quick -(inaccurate) estimate of the time required for somebody who is -familiar with material in this manual, but does not know anything -else about LilyPond development. +@c if we enter patches immediately, I don't think this is relevant. +@ignore +@item +Before adding a patch-reminder issue, do a quick check to see if +it was pushed without sending any email. This can be checked for +searching for relevant terms (from the patch subject or commit +message) on the webgit page: @example -@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:Frog&mode=grid&y=Priority&x=Type&cells=ids} +@uref{http://git.savannah.gnu.org/gitweb/?p=lilypond.git} @end example +@end ignore +@item +If the patch is clearly in response to an existing issue, then +update that issue with the @code{Patch-new} label and a link to +the patch (either on the mailing list archives or the codereview +url). -@node Finding the cause of a regression -@section Finding the cause of a regression - -@warning{This is not a @qq{simple} task; it requires a fair amount -of technical knowledge.} +@item +After adding the issue, please send a response email to the same +group(s) that the initial patch was sent to. -Git has special functionality to help tracking down the exact -commit which causes a problem. See the git manual page for -@code{git bisect}. This is a job that non-programmers can do, -although it requires familiarity with git, ability to compile -LilyPond, and generally a fair amount of technical knowledge. A -brief summary is given below, but you may need to consult other -documentation for in-depth explanations. +If the initial email was sent to multiple mailing lists (such as +both @code{bugs} and @code{devel}), then reply to all those +mailing lists as well. The email should contain a link to the +issue you just added. -Even if you are not familiar with git or are not able to compile -LilyPond you can still help to narrow down the cause of a -regression simply by downloading the binary releases of different -LilyPond versions and testing them for the regression. Knowing -which version of LilyPond first exhibited the regression is -helpful to a developer as it shortens the @code{git bisect} -procedure. +@end itemize -Once a problematic commit is identified, the programmers' job is -much easier. In fact, for most regression bugs, the majority of -the time is spent simply finding the problematic commit. +@subheading Helpers: @code{Patch-review} label -More information is in @ref{Regression tests}. +The secondary duty is to do make sure that every issue in the +tracker with a @code{Patch-review} label has passed these +@qq{obvious} tests: -@subheading git bisect setup +@itemize +@item +Applies automatically to git master. -We need to set up the bisect for each problem we want to -investigate. +It's ok to have offsets, but not conflicts. -Suppose we have an input file which compiled in version 2.13.32, -but fails in version 2.13.38 and above. +@item +Regtest comparison looks ok; no unexpected changes. -@enumerate @item -Begin the process: +Descriptive subject line. -@example -git bisect start -@end example +Avoid subjects like @qq{fixes 123}; instead write @qq{Doc: discuss +stacking-dir for BassFigureAlignment (fix 123)}. @item -Give it the earliest known bad tag: +Compiles docs from scratch. Only check this if you have reason to +suspect it might not work. -@example -git bisect bad release/2.13.38-1 -@end example +@item +(maybe) -(you can see tags with: @code{git tag} ) +Check code indentation and style. This should be easier post-GOP +when we have a better-defined code style. -@item -Give it the latest known good tag: +@end itemize -@example -git bisect good release/2.13.32-1 -@end example -You should now see something like: -@example -Bisecting: 195 revisions left to test after this (roughly 8 steps) -[b17e2f3d7a5853a30f7d5a3cdc6b5079e77a3d2a] Web: Announcement -update for the new "LilyPond Report" -@end example +@subheading Patch Meister -@end enumerate +The Patch Meister will: -@subheading git bisect actual +@itemize -@enumerate +@item +send @qq{countdown} emails to +@code{lilypond-devel} when patches appear to be ready. @item -Compile the source: +send general requests to review patches, or even nasty requests to +review patches. -@example -make -@end example +@item +downgrade patches from @code{Patch-review} to +@code{Patch-needs_work} as appropriate. @item -Test your input file: +downgrade patches from @code{Patch-needs_work} to +@code{Patch-abandoned} if no actions have been taken in four +weeks. -@example -out/bin/lilypond test.ly -@end example +@end itemize -@item -Test results? -@itemize -@item -Does it crash, or is the output bad? If so: -@example -git bisect bad -@end example -@item -Does your input file produce good output? If so: +@node Summary of project status +@section Summary of project status -@example -git bisect good -@end example +@subsubheading Project overview -@end itemize +Grid view provides the best overview: -@item -Once the exact problem commit has been identified, git will inform -you with a message like: +@smallexample +@uref{http://code.google.com/p/lilypond/issues/list?mode=grid&y=Priority&x=Type&cells=ids} +@end smallexample -@example -6d28aebbaaab1be9961a00bf15a1ef93acb91e30 is the first bad commit -%%% ... blah blah blah ... -@end example +@subsubheading Hindering development -If there is still a range of commits, then git will automatically -select a new version for you to test. Go to step #1. +These issues stop or slow development work: -@end enumerate +@smallexample +@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:Maintainability} +@end smallexample -@subheading Recommendation: use two terminal windows +@subsubheading Easy tasks -@itemize -@item -One window is open to the @code{build/} directory, and alternates -between these commands: +Issues tagged with @code{Frog} indicates a task suitable for a +relatively new contributor. The time given is a quick +(inaccurate) estimate of the time required for somebody who is +familiar with material in this manual, but does not know anything +else about LilyPond development. -@example -make -out/bin/lilypond test.ly -@end example +@smallexample +@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:Frog} +@end smallexample -@item -One window is open to the top source directory, and alternates -between these commands: +@subsubheading Patches to review + +Patches which have no @qq{obvious} problems: @example -git bisect good -git bisect bad +@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:patch-review} @end example -@end itemize + +