]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/contributor/administration.itexi
Fix white space
[lilypond.git] / Documentation / contributor / administration.itexi
1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @node Administrative policies
3 @chapter Administrative policies
4
5 This chapter discusses miscellaneous administrative issues which
6 don't fit anywhere else.
7
8 @menu
9 * Meta-policy for this document::
10 * Meisters::
11 * Administrative mailing list::
12 * Grand Organization Project (GOP)::
13 * Grand LilyPond Input Syntax Standardization (GLISS)::
14 * Unsorted policies::
15 @end menu
16
17 @node Meta-policy for this document
18 @section Meta-policy for this document
19
20 The Contributor's Guide as a whole is still a work in progress,
21 but some chapters are much more complete than others.  Chapters
22 which are @qq{almost finished} should not have major changes
23 without a discussion on @code{-devel}; in other chapters, a
24 disorganized @qq{wiki-style dump} of information is encouraged.
25
26 Do not change (other than spelling mistakes) without discussion:
27
28 @itemize
29
30 @item
31 @ref{Introduction to contributing}
32
33 @item
34 @ref{Working with source code}
35
36 @end itemize
37
38 Please dump info in an appropriate @@section within these manuals,
39 but discuss any large-scale reorganization:
40
41 @itemize
42
43 @item
44 @ref{Compiling}
45
46 @item
47 @ref{Documentation work}
48
49 @item
50 @ref{Issues}
51
52 @item
53 @ref{Regression tests}
54
55 @item
56 @ref{Programming work}
57
58
59 @end itemize
60
61 Totally disorganized; do whatever the mao you want:
62
63 @itemize
64
65 @item
66 @ref{Website work}
67
68 @item
69 @ref{LSR work}
70
71 @item
72 @ref{Release work}
73
74 @item
75 @ref{Administrative policies}
76
77 @end itemize
78
79
80
81 @node Meisters
82 @section Meisters
83
84 We have four jobs for organizing a team of contributors:
85
86 @itemize
87
88 @item
89 Bug Meister: trains new Bug Squad volunteers, organizes who works
90 on which part of their job, checks to make sure that everything is
91 running smoothly, and has final say on our policy for Issues.
92
93 Currently: Phil
94
95 @item
96 Doc Meister: trains new doc editors/writers, organizes who works
97 on which part of the job, checks to make sure that everything is
98 running smoothly, and has final say on our policy for
99 Documentation.  Also includes LSR work.
100
101 Currently: Graham
102
103 @item
104 Translation Meister: trains new translators, updates the
105 translation priority list, and handles merging branches (in both
106 directions).
107
108 Currently: Francisco
109
110 @item
111 Frog Meister: is responsible for code patches from (relatively)
112 inexperienced contributors.  Keeps track of patches, does initial
113 reviewing of those patches, sends them to @code{-devel} when
114 they've had some initial review on the Frog list, pesters the
115 @code{-devel} community into actually reviewing said patches, and
116 finally pushes the patches once they're accepted.  This person is
117 @emph{not} responsible for training new programmers, because that
118 would be far too much work -- he job is @qq{only} to guide
119 completed patches through our process.
120
121 Currently: Carl
122
123 @end itemize
124
125 @node Administrative mailing list
126 @section Administrative mailing list
127
128 An mailing list for administrative issues is maintained at
129 @code{lilypond-hackers@@gnu.org}.
130
131 This list is intended to be used for discussions that should be kept
132 private. Therefore, the archives are closed to the public.
133
134 Subscription to this list is limited to certain senior developers.
135
136 At the present time, the list is dormant.
137
138 Details about the criteria for membership, the types of discussion
139 to take place on the list, and other policies for the hackers list
140 will be finalized during the
141 @ref{Grand Organization Project (GOP)}.
142
143
144
145 @node Grand Organization Project (GOP)
146 @section Grand Organization Project (GOP)
147
148 GOP has two goals:
149
150 @itemize
151 @item
152 Clarify the various development tasks by writing down the polices
153 and techniques and/or simplifying the tasks directly.
154
155 @item
156 Get more people involved in development: specifically, find people
157 to do easy tasks to allow advanced developers to concentrate on
158 difficult tasks.
159
160 @end itemize
161
162 @menu
163 * Motivation::
164 * Ongoing jobs::
165 * Policy decisions::
166 @end menu
167
168 @node Motivation
169 @subsection Motivation
170
171 Most readers are probably familiar with the LilyPond Grand
172 Documentation Project, which ran from Aug 2007 to Aug 2008. This
173 project involved over 20 people and resulted in an almost complete
174 rewrite of the documentation. Most of those contributors were
175 normal users who decided to volunteer their time and effort to
176 improve lilypond for everybody. By any measure, it was a great
177 success.
178
179 The Grand Organization Project aims to do the same thing with a
180 larger scope -- instead of focusing purely on documentation, the
181 project aims to improve all parts of LilyPond and its community.
182 Just as with GDP, the main goal is to encourage and train users to
183 become more involved.
184
185 If you have never contributed to an open-source project before --
186 especially if you use Windows or OSX and do not know how to
187 program or compile programs -- you may be wondering if there's
188 anything you can do. Rest assured that you @emph{can} help.
189
190 @subheading "Trickle-up" development
191
192 One of the reasons I'm organizing GOP is "trickle-up"
193 development.  The idea is this: doing easy tasks frees up advanced
194 developers to do harder tasks.  Don't ask "am I the @emph{best}
195 person for this job"; instead, ask "am I @emph{capable} of doing
196 this job, so that the current person can do stuff I @emph{can't}
197 do?".
198
199 For example, consider lilypond's poor handling of grace notes in
200 conjunction with clef and tempo changes. Fixing this will require
201 a fair amount of code rewriting, and would take an advanced
202 developer a few weeks to do. It's clearly beyond the scope of a
203 normal user, so we might as well sit back and do nothing, right?
204
205 No; we @emph{can} help, indirectly. Suppose that our normal user
206 starts answering more emails on lilypond-user. This in turn means
207 that documentation writers don't need to answer those emails, so
208 they can spend more time improving the docs. I've noticed that all
209 doc writers tackle harder and harder subjects, and when they start
210 writing docs on scheme programming and advanced tweaks, they start
211 contributing bug fixes to lilypond. Having people performing these
212 easy-to-moderate bug fixes frees up the advanced developers to
213 work on the really hard stuff... like rewriting the grace note
214 code.
215
216 Having 1 more normal user answering emails on lilypond-user won't
217 have a dramatic trick-up affect all by himself, of course. But if
218 we had 8 users volunteering to answer emails, 6 users starting to
219 write documentation, and 2 users editing LSR... well, that would
220 free up a lot of current bug-fixing-capable contributors to focus
221 on that, and we could start to make a real dent in the number of
222 bugs in lilypond. Quite apart from the eased workload, having that
223 many new helpers will provide a great moral boost!
224
225 @node Ongoing jobs
226 @subsection Ongoing jobs
227
228 Although GOP is a short-term project, the main goal is to train
229 more people to handle ongoing jobs. The more people doing these
230 jobs, the ligher the work will be, and the more we can get done
231 with lilypond!
232
233 Also, it would be nice if we had at least one "replacement" /
234 "understudy" for each role -- too many tasks are only being done
235 by one person, so if that person goes on vacation or gets very
236 busy with other matters, work in that area grinds to a halt.
237
238 @subheading Jobs for normal users
239
240 @itemize
241 @item Consultant:
242 LilyPond is sometimes critized for not listening to users, but
243 whenever we ask for opinions about specific issues, we never get
244 enough feedback. This is somewhat aggravating.
245 We need a group of users to make a dedicated effort to test and
246 give feedback. If there's new documentation, read it. If there's
247 an experimental binary, download it and try compiling a score with
248 it. If we're trying to name a new command, think about it and give
249 serious suggestions.
250
251 @item lilypond-user support:
252 I think it would be nice if we had an official team of users
253 helping other users.
254
255 @item LilyPond Report:
256 Keeping a monthly newsletter running is a non-trivial task.  A lot
257 of work is needed to organize it; it would be great if we could
258 split up the work. One person could write the Snippet of the
259 Month, another person could do Quotes of the Month, another person
260 could do interviews, etc.
261
262 @item Documentation:
263 Although GDP (the Grand Documentation Project) did great work,
264 there's still many tasks remaining.
265
266 @item Translations:
267 Keeping the documentation translations is a monumental task; we
268 need all the help we can get!
269
270 @end itemize
271
272 @subheading Jobs for advanced users for developers
273
274 @itemize
275 @item Git help for writers:
276 We often receive reports of typos and minor text updates to the
277 documentation. It would be great if somebody could create
278 properly-formatted patches for these corrections.
279
280 Technical requirements: ability to run @ref{Lilydev}.
281
282 @item LSR editor:
283 LSR contains many useful examples of lilypond, but some snippets
284 are out of date and need updating. Other snippets need to be
285 advertized, and new snippets need to be sorted. We could use
286 another person to handle LSR.
287
288 Technical requirements: use of a web browser. LilyPond
289 requirements: you should be familiar with most of Notation
290 chapters 1 and 2 (or be willing to read the docs to find out).
291
292 @item Join the Frogs:
293 "Frogs" are a team of bug-fixers (because frogs eat bugs, and you
294 often find them in Ponds of Lilies) and new feature implementors.
295
296 Technical requirements: development environment (such as
297 @ref{Lilydev}), ability to read+write scheme and/or C++ code.
298
299 @end itemize
300
301
302 @node Policy decisions
303 @subsection Policy decisions
304
305 There are a number of policy decisions -- some of them fairly
306 important -- which we have been postponing for a few years.  When
307 GOP begins, we will start discussing them.
308
309 @warning{The fact that we are not arguing about them right now is
310 not, I repeat @strong{not}, an indication that we do not feel that
311 these issues are not important.  It is simply that if we began
312 talking about them now, it would postpone the 2.14 release for a
313 few months.}
314
315 Note that the presence of an item on this list does @emph{not}
316 mean that everybody thinks that something needs to be done.
317 Inclusion in this simply means that one developer thinks that we
318 should discuss it.  We are not going to filter this list; if any
319 developer thinks we should discuss something, just add it to the
320 bottom of the list.  (the list is unsorted)
321
322 Once GOP starts, the list will be sorted into a rough agenda.  We
323 will probably introduce one topic each week -- yes, it will
324 therefore take months to get through everything, but we must
325 balance productive work vs. policy administration.  If we find
326 that we settle questions faster (or slower) than predicted, we
327 will of course change the speed of new topic introductions.
328
329 There are some item(s) not displayed here; these are questions
330 that were posed to me privately, and I do not feel justified in
331 discussing them publicly without the consent of the person(s) that
332 brought them up. They will initially be discussed privately on the
333 lilypond-hackers mailing list -- but the first question will be
334 "do we absolutely need to do this privately", and if not, the
335 discussion will take place on lilypond-devel like the other items.
336
337 In most policy discussions in lilypond over the past few years,
338 the first half (or more) is wasted arguing on the basis of
339 incorrect or incomplete data; once all the relevant facts are
340 brought to light, the argument is generally resolved fairly
341 quickly.  In order to keep the GOP discussions focused, each topic
342 will be introduced with a collection of relevant facts and/or
343 proposals.  It is, of course, impossible to predict exactly which
344 facts will be relevant to the discussion -- but spending an hour
345 or two collecting information could still save hours of
346 discussion.
347
348 @warning{The estimated time required for "prep work", and the
349 following discussion, has been added to each item.  At the moment,
350 there is an estimated 30 hours of prep work and 140 hours of
351 discussion.}
352
353 @itemize
354 @item @strong{Patch reviewing}:
355 At the time of this writing, we have 23 (known) patches waiting
356 for review.  Some from main developers; some from new developers.
357 We desperately need more people helping with lilypond, but
358 ignoring patches is the best way to drive potential contributors
359 away.  This is not good.
360
361 (prep: 2 hours.  discuss: 10 hours)
362
363 @item @strong{Lessons from the 2.14 release; future release policy}:
364 What went well; what went badly? (how) should we change any
365 policies pertaining to releases? Should an undocumented new
366 feature count as release-blocking?
367
368 (prep: 1 hour.  discuss: 15 hours)
369
370 @item @strong{lilypond-hackers mailing list}:
371 Should we have a private mailing list for senior developers?  If
372 so, who should be on it?
373
374 (prep: 2 hours+3 weeks.  discuss: 10 hours)
375
376 @item @strong{Hackers B}:
377
378
379 @item @strong{Code style}:
380 New contributors sometimes struggle to follow our indentation and
381 code style -- this is especially difficult when parts of our
382 existing source code doesn't have a consistent style. This is
383 problematic... we want new contributors to be struggling with the
384 lilypond architecture, not playing games in their text editors!
385 (ok, we don't actually want them to be struggling with lilypond
386 internals... but given the current state of the CG, it's
387 understandable, and at any rate it's still better than struggling
388 with code style)
389 Speaking academically, C++ code style is a "solved problem". Let's
390 pick one of the existing solutions (probably either astyle,
391 uncrustify, or emacs), and let a computer deal with this.
392
393 (prep: 5 hours.  discuss: 15 hours)
394
395 @item @strong{Git repository(s)}:
396 We currently have a web/ branch in our main repo; this seems
397 misleading to new developers. More generally, should we have
398 branches that aren't related to the master? i.e. should we
399 restrict a git branch to code which is an actual "branch" of
400 development? Also, some of our code (notably the windows and osx
401 lilypad) isn't in a git repository at all.
402 We can add new repositories very easily; should make repositories
403 like
404 @example
405 git://git.sv.gnu.org/lilypond/gub.git
406 git://git.sv.gnu.org/lilypond/lilypad.git
407 git://git.sv.gnu.org/lilypond/misc.git
408 @end example
409 ? More information here:
410 @uref{http://code.google.com/p/lilypond/issues/detail?id=980}
411
412 (prep: 2 hours.  discuss: 10 hours)
413
414 @item @strong{Roadmap of future development}:
415 Many projects have a roadmap of planned (or desired) future work.
416 Should we use one? If so, what should go on it, bearing in mind
417 our volunteer status? Is there any way of having a roadmap that
418 isn't vaporware?
419
420 (prep: 1 hour.  discuss: 5 hours)
421
422 @item @strong{Official links to other organizations?}:
423 There's something called the "software freedom conservancy", and
424 in general, there's a bunch of "umbrella organizations". Joining
425 some of these might give us more visibility, possibly leading to
426 more users, more developers, maybe even financial grants or use in
427 schools, etc.
428
429 (prep: 2 hours.  discuss: 5 hours)
430
431 @item @strong{Mailing lists}:
432 We currently have a mix of official GNU mailing lists and lilynet
433 lists. Is there a strong rationale for having separate mailing
434 list servers? Why not pick one place, and put all our lists there?
435 (or at least, all "permanent" lists?)
436
437 (prep: 1 hour.  discuss: 5 hours)
438
439 @item @strong{Issue tracking with google code}:
440 We use the google issue tracker, but this means that we are
441 relying on a commercial entity for a large part of our
442 development. Would it be better (safer in the long run) to use the
443 savannah bug tracker?
444
445 (prep: 1 hour.  discuss: 5 hours)
446
447 @item @strong{Patch review tool}:
448 Reitveld is inconvenient in some respects: it requires a google
449 account, and there's no way to see all patches relating to
450 lilypond. Should we switch to something like gerritt?
451 @uref{http://code.google.com/p/lilypond/issues/detail?id=1184}
452
453 (prep: 5 hours.  discuss: 15 hours)
454
455 @item @strong{Subdomains of *.lilypond.org}:
456 Unless Jan has a really weird DNS hosting setup, there are no
457 technical barriers to having names like lsr.lilypond.org,
458 frog.lilypond.org, or news.lilypond.org. Is this something that we
459 want to do?
460
461 (prep: 1 hours+2 weeks.  discuss: 5 hours)
462
463 @item @strong{Authorship in source files}:
464 Our documentation currently does not attempt to track individual
465 authors of each file, while our source code makes a confused and
466 jumbled attempt to track this. A number of guidelines for F/OSS
467 projects explicitly recommends _not_ tracking this in individual
468 files, since the code repository will track that for you.
469
470 (prep: 2 hours.  discuss: 15 hours)
471
472 @item @strong{Clarity for sponsorships}:
473 We currently do not advertize bounties and sponsorships on the
474 webpage.  How much advertising do we want, and what type?
475 Should we change the "structure" / "framework" for bounties?
476
477 (prep: 2 hours.  discuss: 10 hours)
478
479 @item @strong{Separate branches for active development}:
480 it might be good to have @emph{everybody} working on separate
481 branches.  This complicates the git setup, but with sufficient
482 logic in lily-git.tcl, we can probably make it transparent to
483 newbies.  However, we'd need a reliable person to handle all the
484 required merging and stuff.
485
486 (prep: 2 hours.  discuss: 10 hours)
487
488 @item @strong{Precise definition of Critical issues}:
489 at the moment, a stable release is entirely dependent on the
490 number of Critical issues, but there's some questions about
491 precisely what a "Critical issue" should be.  We should clarify
492 this, in conjunction with a general discussion about how often we
493 want to have stable releases, how permissive we want to be about
494 patches, etc etc.
495
496 (prep: 1 hour.  discuss: 5 hours)
497
498 @item @strong{When do we add regtests?}:
499 There is a discrepancy between our stated policy on adding
500 regtests, and our actual practice in handling bugs and patches.
501 Clarify.
502
503 There is also a wider question how to organize the regtests, such
504 as where to put interesting-console-output regtests, including
505 stuff like lilypond-book and midi2ly in a sensible manner, and
506 possibly including regtests for currently-broken functionality.
507
508 (prep: 2 hours.  discuss: 5 hours)
509
510 @item @strong{code readability}:
511 "Our aim when producing source code for Lilypond in whatever
512 language is that it should be totally comprehensible to a
513 relatively inexperienced developer at the second reading."
514
515 Rationale:
516 - aids maintainability of code base
517 - "second reading" so newer developers can look up unfamiliar
518   stuff
519 - will help to keep things simple, even if the code is doing
520   complex stuff discourages "secret squirrel" coding, e.g.  "how
521   much functionality can I squeeze into as few characters as
522   possible" "comments are for wimps"
523 - will aid not *discouraging* new developers to join the project
524
525 (prep: 2 hours.  discuss: 10 hours)
526
527 @item @strong{C++ vs. scheme}:
528 what should be in scheme, what should be in C++, what can/should
529 be ported from one to the other, etc.  Questions of
530 maintainability, speed (especially considering guile 2.0), and the
531 amount of current material in either form, are important.
532
533 (prep: 5 hours.  discuss: 15 hours)
534
535 @end itemize
536
537
538
539 @node Grand LilyPond Input Syntax Standardization (GLISS)
540 @section Grand LilyPond Input Syntax Standardization (GLISS)
541
542 @subheading Summary
543
544 @itemize
545 @item
546 Start: sortly after 2.14 comes out, which is currently estimated
547 to happen in January 2011.
548
549 @item
550 Length: 6-12 months.  We're not going to rush this.
551
552 @item
553 Goal: define an input which we commit to being
554 machine-updateable for the forseeable future.  Any future patches
555 which change the syntax in a non-convert-ly-able format will be
556 rejected.  (subject to the limitations, below)
557 Once this is finished, we will release lilypond 3.0.
558
559 @end itemize
560
561
562 @subheading The Problem
563
564 One of the biggest complaints people have with lilypond -- other
565 than silly thing like "there's no gui" -- is the changing syntax.
566 Now, inventing a language or standards is difficult.  If you set
567 it in stone too soon, you risk being stuck with decisions which
568 may limit matters.  If you keep on updating the syntax,
569 interaction with older data (and other programs!) becomes complex.
570
571 @subheading Scope and Limitations
572
573 @itemize
574 @item
575 tweaks will not be included.  Anything with \override, \set,
576 \overrideProperty, \tweak, \revert, \unset... including even those
577 command names themselves... is still fair game for NOT_SMART
578 convert-ly updates.
579
580 @item
581 other than that, everything is on the table.  Is it a problem to
582 have the tagline inside \header?  What should the default behavior
583 of \include be?  When we abolish \times, do we move to \tuplet 3:2
584 or \tuplet 2/3 or what (for typical triplets in 4/4 time)?
585
586 @item
587 we need to get standards for command names.  This will help users
588 remember them, and reduce the options for future names (and
589 potential renamings later on).  \commandOn and \commandOff seem to
590 work well (should we *always* have an Off command?), but what
591 about the "command" part?  Should it be \nounVerbOn, or
592 \verbNounOn ?  Or \verbNotesWithExtraInformationOn ?
593
594 @item
595 we need standards for the location of commands.  Ligature
596 brackets, I'm looking at you.  (non-postfix notation must die!)
597
598 @item
599 this Grand Project doesn't affect whether we have a 2.16 or not.
600 The main problem will be deciding what to do (with a bit of
601 messiness anticipated for \tuplet); we should definitely release a
602 2.16 before merging _any_ of these changes.
603
604 @item
605 we obviously can't /guarantee/ that we'll /never/ make any
606 non-convert-ly changes in the basic format.  But we *can*
607 guarantee that such changes would force lilypond 4.0, and that we
608 would only do so for overwhelmingly good reasons.
609
610 @end itemize
611
612 @subheading Workflow
613
614 @itemize
615 @item
616 We're going to have lots and lots of emails flying around.  The
617 vast majority won't really fit into either -devel or -user, so
618 we'll use a list devoted to syntax issues.
619
620 @item
621 Once we have a serious proposal that gained general acceptance
622 from the separate syntax mailing list, I'll bring it to -devel.
623 We're not going to make any changes without discussing it on
624 -devel, but if we're going to have huge threads about English
625 grammar and silly ideas, and I don't want to clutter up -devel.
626 Once whatever chaotic silliness on the syntax list is settled
627 down, I'll bring the ideas to -devel.
628
629 @item
630 as with GDP, I'll moderate the discussion.  Not as with mailist
631 moderation, but rather by introducing issues at specific times.
632 We don't want a free-for-all discussion of all parts of the syntax
633 at once; nothing will get resolved.
634
635 @item
636 Whenever possible, we'll decide on policies at the highest level
637 of abstraction.  For example, consider \numericTimeSignature,
638 \slurUp, \xNotesOn, \startTextSpan, and \verylongfermata.  One of
639 them starts with the name of the notation first (slur).  One has
640 an abbreviation (x instead of cross).  One has the verb at the end
641 (On), another has it at the beginning (start).  The adjective can
642 come at the beginning (numeric, x) or end (Up).  Most are in
643 camelCase, but one isn't (verylongfermata).
644
645 @item
646 Instead of arguing about each individual command, we'll decide on
647 abstract questions.  Should each command begin the notation-noun,
648 or the verb?  Should all commands be in camelCase, or should we
649 make everything other than articulations in camelCase but make
650 articulations all lower-case?  Are abbreviations allowed?
651
652 @item
653 Once we've answered such fundamental questions, most of the syntax
654 should fall into place pretty easily.  There might be a few odd
655 questions left ("is it a span, or a spanner?"), but those can be
656 settled fairly quickly.
657
658 @end itemize
659
660 @subheading Implementation
661
662 Nothing until the project is finished, then we declare the next
663 stable release (2.16.0 or 2.18.0 ?) to be the final 2.x version,
664 release it, then apply all the GLISS syntax changes and start
665 testing a beta for 3.0 a week or two later.
666
667 @subheading Discussion
668
669 Don't respond to any of the specifics yet.  Yes, we all have our
670 pet irritations (like "what's up with \paper and \layout?!").
671 There will be plenty of time to discuss them once GLISS starts.
672
673 That said, we have a list of specific items that people really
674 wanted to have written down.  See @ref{Specific GLISS issues}.
675
676 @menu
677 * Specific GLISS issues::
678 @end menu
679
680
681 @node Specific GLISS issues
682 @subsection Specific GLISS issues
683
684 @itemize
685 @item
686 add regtests for every piece of syntax (not one-command-per-file,
687 but making a few files which, between them, use every single piece
688 of syntax.)  This is a great test for convert-ly.
689
690 @item
691 should GLISS cover suggested conventions?  (indentation,
692 one-bar-per-line, etc -- the kind of stuff we list for the
693 lilypond formatting in the docs ?)
694
695 @item
696 how much (if any) syntactic sugar should we add?  i.e.
697 @example
698   \instrumentName #'foo
699 % instead of
700   \set Staff.instrumentName
701 @end example
702 ?  Carl: maybe yes, Neil: no.  (for example, it fails for
703 pianostaff)
704
705 @item
706 the values that are used as arguments to common used overrides.
707 Sometimes they are a symbol (e.g. #'around), sometimes a
708 predefined variable referring to a Scheme value or object (e.g.
709 #LEFT, #all-visible ). The main trouble is that for novice users
710 it is not clear when there should be an apostrophe and when not.
711
712 @item
713 When do we need -\command and when is it just \command ?
714
715
716 @item
717 Command-line options to the lilypond binary.  -dfoo counts as a
718 tweak; we won't be trying to pin those down.
719
720 @item
721 @verbatim
722 \layout {
723   \context { \Score
724 % vs.
725 \layout {
726   \context {
727     \Score
728 @end verbatim
729
730 @item
731 If would be pedagogically simpler to realize this difference if
732 the syntax was separate if you define a context from scratch (as
733 is the case with \RemoveEmptyStaffContext) or if it's defined by
734 adding onto an existing context. For example, a syntax like
735
736 @verbatim
737 \context{
738  % Copy the current settings of the Staff context:
739  \use Staff
740  % do whatever additional settings
741 }
742 %%% could be used to distinguish from
743 \context{
744  % Take settings from a variable:
745  \Variable
746  % do whatever additional settings
747 }
748
749 %%% and
750
751 \context{
752  % Start from scratch:
753  \type ...
754  \name ...
755  \consists ...
756  ...
757 }
758 @end verbatim
759
760 @item
761 Capitalization of identifiers: \VoiceOne ?
762
763 @item
764 @verbatim
765 %%% Allow
766 { music expression } * 4
767 %%% instead of
768 \repeat unfold 4 { music expression }
769 @end verbatim
770
771 ?  patch here:
772 @uref{http://lists.gnu.org/archive/html/lilypond-devel/2010-04/msg00467.html}
773
774 @item
775 Personally, I find it easier to understand when there's a repeated
776 8 in the half-bar position; it's much easier to see that you have
777 two groups of 4:
778
779 @example
780 c8 c c c c8 c c c
781 %%% instead of one group of eight:
782 c8 c c c c c c c
783 @end example
784
785 @item
786 trivially simple bar-lines:
787
788 c1 | c1 |
789
790 encourage, allow, or discourage, or disallow?
791
792 @item
793 indentation of \\ inside a @{@} construct.
794
795
796 @item
797 barline checks at the end of line should be preceded by at least 2
798 spaces?  barline checks should line up if possible (i.e.  if you
799 can use less than 4, 8, X empty spaces before a barline check to
800 make them line up?)
801
802 @item
803 Why doesn't \transpose respect \relative mode?
804
805
806 @item
807 on \score vs. \new Score
808
809 But in the light of a consistent syntax and semantic, I see no
810 reason (from the users POV) to disallow it.  After all, the real
811 top-level context is a \book @{@}, isn't it, and I don't see a point
812 in disallowing a \new Score construct just like \new Staff.
813
814 From a syntactical POV, I see the following pros for \new Score:
815 - You can write \with @{ ... @} for every other context but \Score,
816 which (for consistency) should also work with \new Score.
817 - When there's a \new Foo Bar, there's also a \context Foo Bar,
818   which makes the same as a parallel instantiation of all Bar's.
819 - [Quoting Rune from
820 @uref{http://www.mail-archive.com/lilypond-devel@@gnu.org/msg14713.html}
821   "I know that the \score-statement is a syntactical construct,
822 but I think it would be nice to hide this fact from the users.  I
823 think we could make the use of score-block much more intuitive if
824 changing the syntax to \new \Score and adding an implicit
825 sequential-statement to the score."
826
827
828 @item
829 Discussion on
830 http://code.google.com/p/lilypond/issues/detail?id=1322
831 about \new vs. \context.
832
833
834 @item
835 Let users add their own items to the parser?  comment 11 on:
836 http://code.google.com/p/lilypond/issues/detail?id=1322
837
838 @item
839 should engravers be pluralized (note_heads_engraver) or not
840 (note_head_engraver) ?
841
842 @item
843 should we allow numbers in identifier names?  Issue:
844 http://code.google.com/p/lilypond/issues/detail?id=1670
845
846 @item
847 should we officially allow accented characters?  in general, how
848 do we feel about utf-8 stuff?
849
850 @item
851 for the sake of completeness/simplicity, what about *disallowing*
852 the "one-note" form of a music expression?  i.e. only allowing
853 stuff like
854 @verbatim
855   \transpose c d { e1 }
856   \transpose c d << e1 >>
857 @end verbatim
858
859 and never allowing
860 @verbatim
861   \transpose c d e1
862 @end verbatim
863
864 @end itemize
865
866
867 @node Unsorted policies
868 @section Unsorted policies
869
870 @subsubheading Language-specific mailing lists
871
872 A translator can ask for an official lilypond-xy mailing list once
873 they've finished all @qq{priority 1} translation items.
874
875 @subsubheading Performing yearly copyright update (@qq{grand-replace})
876
877 At the start of each year, copyright notices for all source files
878 should be refreshed by running the following command from the top of
879 the source tree:
880
881 @example
882 make grand-replace
883 @end example
884
885 Internally, this invokes the script @file{scripts/build/grand-replace.py},
886 which performs a regular expression substitution for old-year -> new-year
887 wherever it finds a valid copyright notice.
888
889 Note that snapshots of third party files such as @file{texinfo.tex} should
890 not be included in the automatic update; @file{grand-replace.py} ignores these
891 files if they are listed in the variable @code{copied_files}.
892
893
894 @subsubheading Push git access
895
896 Git access is given out when a contributor has a significant
897 record of patches being accepted without problems.  If existing
898 developers are tired of pushing patches for a contributor, we'll
899 discuss giving them push access.  Unsolicited requests from
900 contributors for access will almost always be turned down.
901