annotate old-trunk/README.MAINT @ 339:eb230fa7d28e

Prepare for migration to hg
author lost
date Fri, 19 Mar 2010 02:54:14 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
339
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
1 This file is intended for source package maintainers/distributors.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
2
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
3 Before a release is made, a branch for that release must be made. Within
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
4 that branch, all files that will be distributed with the particular release
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
5 must be generated and added to the repository on that branch. Once the
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
6 release is deemed stable and ready for release, the release tag should
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
7 be generated from the head of that particular branch. Thus all release
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
8 series will have the autotool generated files in the repository as well
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
9 as any other generated files intended to be distributed.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
10
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
11 Any branch not directly intended to be a release need not include the
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
12 generated files.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
13
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
14 The trunk development stream must not include the autotool generated files
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
15 as these are likely to change rapidly and it can cause a great deal of
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
16 confusion for little gain. Also, the main trunk need not contain such
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
17 things as generated documentation files for the same reason.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
18
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
19 By including the generated files in the release branches, it is possible
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
20 to replicate any problems users of the package may have, including if it
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
21 is due to problems with the autotools themselves.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
22
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
23
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
24 Naming of branches and tags should conform to the following guidlines.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
25
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
26 1. any branch leading to a release series must be named as the base revision
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
27 of the series. Thus, for a 1.0 release, the branch is called 1.0 and will
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
28 contain the results for a 1.0 release, a 1.0.1 release, and so on. If a
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
29 sub-release will occur, say under 1.0.1, then a branch named "1.0.1" would
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
30 be created and then releases such as 1.0.1.1 would be created. This should
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
31 be avoided if at all possible.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
32
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
33 2. any tag for a specific release version will be named as the release. So
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
34 for a 1.0 release, the name would be "1.0". For version 1.0.1.1, the name
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
35 would be "1.0.1.1".
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
36
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
37 3. branches not associated with a release stream - say for feature development
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
38 or what have you should be named sensibly and should be removed when no longer
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
39 needed. They must not appear to be version numbers.
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
40
eb230fa7d28e Prepare for migration to hg
lost
parents:
diff changeset
41 4. tags not specifying a release must not look like version numbers