org.el (org-format-latex-options): Fix docstring
[org-mode.git] / README_maintainer
blob04dc2c0876345b808fda286b5de4e884d69beabc
1 # -*- mode:org -*-
3 #+TITLE: Org 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 * Git workflow
11 The git repository has two branches:
13 - master :: for current development.
15 - maint :: for bug fixes against latest major or minor release.
17 Bug fixes always go on =maint= then are merged on =master=.
19 New features always go on =master=.
21 * Releasing
23 ** Major release
25 The release number for main releases look like this: =7.13=
27 Main releases are made whenever Org is in a state where the feature
28 set is consistent and we feel that the features that are implemented
29 is something we want to support in the future.
31 A major release turns the current state of the master branch into a
32 release.
34 When doing a /major release/, make sure all changes from the maint
35 branch are merged into the the master branch, then merge the master
36 branch back into maint to synchronize the two.
38 ** Minor release
40 The release number for minor releases look like this:  =7.13.1=
42 Minor releases are small amends to main releases.  Usually they fix
43 critical bugs discovered in a main release.  Minor bugs are usually
44 not fixed -- they will be adressed in the next main release.
46 Only the fix to the bug is bundled into a release, without the main
47 development work going on in the master branch.  Since the bug fix
48 will also be needed in the master branch, usually the fix is made in
49 maint then merged in master.
51 ** Tagging the release
53 When doing a major and a minor release, after all necessary merging is
54 done, tag the _maint_ branch for the release with:
56   git tag -a release_7.9.1 -m "Adding release tag"
58 and push tags with
60   git push --tags
62 We also encourage you to sign release tags like this:
64   git tag -s release_7.9.1 -m "Adding release tag"
66 ** Uploading the release files from the orgmode.org server
68 Log on the orgmode.org server as the emacs user and cd to
69 ~/git/org-mode
71 From there do
73   make release
74   make upload
76 to create the .tar.gz and .zip files, the documentation, and to
77 upload everything at the right place.
79 * Available Org's builds on the server
81 There are two cron tasks on the server: one that builds the ELPA
82 packages and one that builds org-latest.tar.gz and org-latest.zip.
84 ELPA packages are built from the *maint* branch.  One ELPA package
85 contains Org's core, another one called "org-plus-contrib" contains
86 Org and contributed libraries.
88 org-latest* snapshots are built from the *master* branch.
90 * Synchronization with Emacs
92 ** Updating etc/ORG-NEWS
94 Latest changes in Emacs are described in Emacs =etc/NEWS=, and latest
95 changes in major Emacs packages are described in =etc/ORG-NEWS=. 
97 If a major release is meant to be merged with the Emacs trunk (as it
98 always should), you need to update Org's =etc/ORG-NEWS= file so that
99 you can merge it with that of Emacs.  There is one top-level section
100 for each release that is merged with Emacs.
102 ** Merging with Emacs trunk branch
104 This is still a significant headache.  Some hand work is needed here.
106 Emacs uses bzr.  A useful introduction to bzr for Emacs developers can
107 be found [[http://www.emacswiki.org/emacs/BzrForEmacsDevs][here]].  While I see all the advantages this would have, I
108 cannot bring myself to switch away from git for my day-to-day work,
109 because I know git so well, and because git seems to me as being much
110 more powerful, conceptionally simple (once you have [[http://newartisans.com/2008/04/git-from-the-bottom-up/][bent your head
111 around it]]), and so much faster.
113 So the way I have been doing things with Emacs is this:
115 1. I do not update the version in Emacs too often.  Just once every
116    few months - this is frequently enough for the Emacs release cycle.
117    Care must be taken to get in a *new and stable* version shortly
118    before Emacs goes into feature freeze and pretest, because that
119    version is going to be in the wild for a long time.
121 2. I watch the Emacs diffs for changes made by the maintainers of
122    Emacs in the org-mode files in Emacs.  Any changes that come up
123    there, I merge into the development version of Org-mode.
124    Occasionally I do not do this, if I do not agree with a change.
125    The changes go into Org /without/ a ChangeLog-like entry in the
126    commit message.  The reason for this is that we will later generate
127    a ChangeLog file from our commit messages, and I do not want double
128    ChangeLog entries in the Emacs ChangeLog file.
130 3. When I have made a release (usually I wait for the minor releases
131    to stabilize), I *copy* org files into the Emacs repository.  Yes,
132    I do not merge, I copy.  This has been the source of some problems
133    in the past - Emacs developers are not happy when I accidentally
134    overwrite changes they made.  But I have not had the patience to
135    work out a better mechanism, and I really dislike the idea that the
136    version in Emacs starts diverging from my own.
138    Careful: Copy /org.texi/ and /orgcard.tex/ into the right places,
139    and also copy the lisp files with *one exception*: Do *not* copy
140    /org-loaddefs.el/, Emacs generates its own autoloads.
142 4. Generate the ChangeLog entries
144    For this, I do in the org-mode git repository
146    : mk/make_emacs_changelog release_7.02.05..release_7.03.02
148    This will spit out ChangeLog entries (for the given commit range)
149    that need to go into the ChangeLog files in Emacs.  Org-mode
150    contributes to 3 different ChangeLog files in Emacs:
152    : lisp/org/ChangeLog    (for lisp changes)
153    : doc/misc/ChangeLog    (for org.texi changes)
154    : etc/ChangeLog         (for refcard changes)
156    When you run the =make_emacs_changelog= program, you will be
157    prompted for a date in ISO format YYYY-MM-DD, this date will be
158    used in the ChangeLog entries - Emacs developers want these dates
159    to be the time when the change has been installed into Emacs, not
160    the time when we made the change in our own repository.  So all the
161    ChangeLog entries will get the same date.  You will also be
162    prompted for the kind of ChangeLog you want to make, possible
163    answers are =lisp=, =texi=, and =card=.  The program will then
164    select the correct entries for the specified ChangeLog file.  If
165    you don't like being prompted, you can give the date and type as
166    second and third command line arguments to =make_emacs_changelog=,
167    for example
169    : mk/make_emacs_changelog release_7.02.05..release_7.03.02 2010-12-11 lisp
171    These entries need to be added to the ChangeLog files in Emacs.
172    You should, in the ChangeLog file, select the inserted region of
173    new entries and do =M-x fill-region=, so that the entries are
174    formatted correctly.  I then do look through the entries quickly to
175    make sure they are formatted properly, that the email addresses
176    look right etc.
178 5. Commit the changes into the bzr repository and you are done.  Emacs
179    developers often look throught the commit and make minor changes -
180    these need to be merged back into our own repo.
182 * Updating the list of hooks/commands/options on Worg
184   Load the =mk/eldo.el= file then =M-x eldo-make-doc RET=.
186   This will produce an org file with the documentation.
188   Import this file into =worg/doc.org=, leaving the header untouched
189   (except for the release number).
191   Then commit and push the change on the =worg.git= repository.
193 * Copyright assignments
195   The maintainer needs to keep track of copyright assignments.
196   Even better, find a volunteer to do this.
198   The assignment form is included in the repository as a file that
199   you can send to contributors: =request-assign-future.txt=
201   The list of all contributors from who we have the papers is kept on
202   Worg at http://orgmode.org/worg/org-contribute.html, so that
203   committers can check if a patch can go into the core.
205   The assignment process does not allways go smoothly, and it has
206   happened several times that it gets stuck or forgotten at the FSF.
207   The contact at the FSF for this is: mailto:copyright-clerk@fsf.org
209   Emails from the paper submitter have been ignored in the past, but
210   an email from me (Carsten) as the maintainer of Org mode has usually
211   fixed such cases within a few days.