annotate README.MAINT @ 60:309810f39ab7

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