Implement proper handling of agenda markers when using sticky agendas
[org-mode/org-tableheadings.git] / README_maintainer
bloba4a93c704c8c799828f26b9533b8819bc2ed0f57
1 # -*- mode:org -*-
3 #+title: Maintainer tasks
4 #+startup: noindent
6 This document describes the tasks the Org-mode maintainer has to do
7 and how they are performed.
9 * Working with patchwork
11 John Wiegley is running a patchwork server that looks at the
12 emacs-orgmode mailing list and extracts patches.  The maintainer and
13 his helpers should work through such patches, give feedback on them
14 and apply the ones which are good and done.  A task for the maintainer
15 is to every now and then try to get old stuff out of that list, by
16 asking some helpers to investigate the patch, by rejecting or
17 accepting it.
19 I have found that the best workflow for this is using the pw script by
20 Nate Case, with the modifications for Org-mode made by John Wiegley
21 and Carsten Dominik.  The correct version of this script that should
22 be used with Org mode is distributed in the UTILITIES directory of the
23 Org mode distribution.  Here is the basic workflow for this.
25 ** Access to the patchwork server
27 If you want to work on patchwork patches, you need write access at the
28 patchwork server.  You need to contact John Wiegley to get this
29 access.
31 There is a web interface to look at the patches and to change the
32 status of patches.  This interface is self-explanatory.  There is also
33 a command line script which can be very convenient to use.
35 ** Testing patches
37 To start testing a patch, first assign it to yourself
39 : pw update -s "Under Review" -d DELEGATE-NAME NNN
41 where =NNN= is a patch number and =DELEGATE-NAME= is your user name on
42 the patchwork server.
44 The get the patch into a branch:
46 : pw branch NNN
48 This will create a local topic branch in your git repository with the
49 name =t/patchNNN=.  You will also be switched to the branch so that
50 you can immediately start testing it.  Quite often small amends need
51 to be made, or documentation has to be added.  Also, many contributors
52 do not yet provide the proper ChangeLog-like entries in the commit
53 message for the patch.  As a maintainer, you have two options here.
54 Either ask the contributor to make the changes and resubmit the patch,
55 or fix it yourself.  In principle, asking to contributor to change the
56 patch until it is complete is the best route, because it will educate
57 the contributor and minimize the work for the maintainer.  However,
58 sometimes it can be less hassle to fix things directly and commit the
59 changes to the same branch =t/patchNNN=.
61 If you ask the contributor to make the changes, the patch should be
62 marked on the patchwork server as "changes requested".
64 : pw update -s "Changes Requested" -m "What to change" NNN
66 This will send an email to the contributor and the mailing list with a
67 request for changes.  The =-m= message should not be more than one
68 sentence and describe the requested changes.  If you need to explain
69 in more detail, write a separate email to the contributor.
71 When a new version of the patch arrives, you mark the old one as
72 superseded
74 : pw update -s "Superseded" NNN
76 and start working at the new one.
78 ** Merging a final patch
80 Once the patch has been iterated and is final (including the
81 ChangeLog-like entries in the commit message), it should be merged.
82 The assumption here is that the final version of the patch is given by
83 the HEAD state in the branch =t/patchNNN=.  To merge, do this:
85 : pw merge -m "maintainer comment" NNN
87 This will merge the patch into master, switch back to master and send
88 an email to both contributor and mailing list stating that this change
89 has been accepted, along with the comment given in the =-m= message.
91 At some point you might then want to remove the topic branch
93 : git branch -d t/patchNNN
95 * Releases
97 ** Main releases
99 The release number for main releases look like this:  =7.13=
101 Main releases are made whenever Org is in a state where the feature
102 set is consistent and we feel that the features that are implemented
103 is something we want to support in the future.
105 A major release turns the current state of the master branch into a
106 release.  The release process is a single make command:
108 : make release TAG=7.13
110 Before issuing this command, you should make sure that everything
111 during the process will work right, you can do so by running
113 : make testrelease TAG=7.13
115 When this fails, make sure to clean up.  =git reset --hard= if
116 necessary, and check if there are unwanted files, directories, or
117 branches left over from the testing.
119 ** Minor releases
121 The release number for minor releases look like this:  =7.13.01=
123 Minor releases are small amends to main releases.  Usually they fix
124 critical bugs discovered in a main release.  Minor bugs are not
125 fixed - they will be adressed in the next main release.  Only the fix
126 to the bug is bundled into a release, without the main development
127 work going on in the master branch.  Since the bug fix will also be
128 needed in the master branch, usually the fix is made in master and
129 then cherry-picked into maint.  When this is done, a release is made
130 from maint with this command:
132 : make fixrelease TAG=7.13.01
134 ** Updating release files on orgmode.org server
136 As of 2011-01-15, these directives of the Makefile are meant to be
137 used /from orgmode.org server/ and will copy the release files to the
138 webserver directory.
140 - ~$ make makerelease :: creates a =RELEASE/= directory containing
141      manuals and release files (=org.tar.gz=, =org.zip=, etc.)
143 - ~$ make sync_release :: copy the content of =RELEASE/= to the right
144      location on the server
146 - ~$ make sync_manuals :: copy the manuals from =doc/= to the right
147      location on the server
149 - ~$ make relup :: call the three directives described above.
151 ** Between releases
153 While working on master between releases, I used to use something like
154 7.02trans as the version string.  I no longer do this.  =M-x
155 org-version= will spit ut complete version infor related to git, with
156 the nearest commit and tag.  I you ever need to set a special version
157 number, use this:
159 : UTILITIES/set_version 7.02trans
161 and commit the result.  Note that the above command does not change
162 the version string in the file from which Org's homepage is generated.
163 To change that as well, you would use a =--all= flag.  To change only
164 this file, use =--only=.
166 * Synchonization with Emacs
168 This is still a significant headache.  Some hand work is needed here.
170 Emacs uses bzr.  A useful introduction to bzr for Emacs developers can
171 be found [[http://www.emacswiki.org/emacs/BzrForEmacsDevs][here]].  While I see all the advantages this would have, I
172 cannot bring myself to switch away from git for my day-to-day work,
173 because I know git so well, and because git seems to me as being much
174 more powerful, conceptionally simple (once you have [[http://newartisans.com/2008/04/git-from-the-bottom-up/][bent your head
175 around it]]), and so much faster.
177 So the way I have been doing things with Emacs is this:
179 1. I do not update the version in Emacs too often.  Just once every
180    few months - this is frequently enough for the Emacs release cycle.
181    Care must be taken to get in a *new and stable* version shortly
182    before Emacs goes into feature freeze and pretest, because that
183    version is going to be in the wild for a long time.
185 2. I watch the Emacs diffs for changes made by the maintainers of
186    Emacs in the org-mode files in Emacs.  Any changes that come up
187    there, I merge into the development version of Org-mode.
188    Occasionally I do not do this, if I do not agree with a change.
189    The changes go into Org /without/ a ChangeLog-like entry in the
190    commit message.  The reason for this is that we will later generate
191    a ChangeLog file from our commit messages, and I do not want double
192    ChangeLog entries in the Emacs ChangeLog file.
194 3. When I have made a release (usually I wait for the minor releases
195    to stabilize), I *copy* org files into the Emacs repository.  Yes,
196    I do not merge, I copy.  This has been the source of some problems
197    in the past - Emacs developers are not happy when I accidentally
198    overwrite changes they made.  But I have not had the patience to
199    work out a better mechanism, and I really dislike the idea that the
200    version in Emacs starts diverging from my own.
202    Careful: Copy /org.texi/ and /orgcard.tex/ into the right places,
203    and also copy the lisp files with *two exceptions*: Do *not* copy
204    /org-colview-xemacs.el/ and /org-install.el/.  The former does not
205    belong in Emacs.  And the latter would actually be harmful because
206    Emacs generates its own autoloads.  The Emacs distribution contains
207    an empty /org-install.el/, so that users can have =(require
208    'org-install)= in .emacs with no ill effects.  So if you were to
209    copy /org-install.el/, you would overwrite that empty placeholder
210    file.
212 4. Generate the ChangeLog entries
214    For this, I do in the org-mode git repository
216    : UTILITIES/make_emacs_changelog release_7.02.05..release_7.03.02
218    This will spit out ChangeLog entries (for the given commit range)
219    that need to go into the ChangeLog files in Emacs.  Org-mode
220    contributes to 3 different ChangeLog files in Emacs:
222    : lisp/org/ChangeLog    (for lisp changes)
223    : doc/misc/ChangeLog    (for org.texi changes)
224    : etc/ChangeLog         (for refcard changes)
226    When you run the =make_emacs_changelog= program, you will be
227    prompted for a date in ISO format YYYY-MM-DD, this date will be
228    used in the ChangeLog entries - Emacs developers want these dates
229    to be the time when the change has been installed into Emacs, not
230    the time when we made the change in our own repository.  So all the
231    ChangeLog entries will get the same date.  You will also be
232    prompted for the kind of ChangeLog you want to make, possible
233    answers are =lisp=, =texi=, and =card=.  The program will then
234    select the correct entries for the specified ChangeLog file.  If
235    you don't like being prompted, you can give the date and type as
236    second and third command line arguments to =make_emacs_changelog=,
237    for example
239    : UTILITIES/make_emacs_changelog release_7.02.05..release_7.03.02 2010-12-11 lisp
241    These entries need to be added to the ChangeLog files in Emacs.
242    You should, in the ChangeLog file, select the inserted region of
243    new entries and do =M-x fill-region=, so that the entries are
244    formatted correctly.  I then do look through the entries quickly to
245    make sure they are formatted properly, that the email addresses
246    look right etc.
248 5. Commit the changes into the bzr repository and you are done.  Emacs
249    developers often look throught the commit and make minor changes -
250    these need to be merged back into our own repo.
252 * Updating the list of hooks on Worg
254   The file /org-configs/org-hooks.org/ contains a list of all hooks in
255   Org.  This list has to be updated after hooks have been added or
256   removed.  The perl script /UTILITIES/list-hooks.pl/ creates the
257   entire section "Hooks and Function variables", including its
258   level-one headline.  I guess babel code could be used to update this
259   automatically, but I have not implemented this - I have been doing
260   it by hand every few months.
262 * Copyright assignments
264   The maintainer needs to keep track of copyright assignments.  Even
265   better, find a volunteer to do this.  
267   The list of all contributors from who we have the papers is kept on
268   Worg at http://orgmode.org/worg/org-contribute.php, so that
269   committers can check if a patch can go into the core.
271   The assignment process does not allways go smoothly, and it has
272   happened several times that it gets stuck or forgotten at the FSF.
273   The contact at the FSF for this is: copyright-clerk@fsf.org 
275   Emails from the paper submitter have been ignored in the past, but
276   an email from me (Carsten) as the maintainer of Org mode has usually
277   fixed such cases within a few days.