Mercurial > hg-old > index.cgi

annotate README.MAINT @ 107:69ead2e61763

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added start of a manual and updated maintainer docs to mention generated documentation
author lost
date Wed, 28 Jan 2009 05:02:44 +0000
parents a8a83ccffafd
children
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
107
69ead2e61763 Added start of a manual and updated maintainer docs to mention generated documentation
lost
parents: 2
diff changeset
8 series will have the autotool generated files in the repository as well
69ead2e61763 Added start of a manual and updated maintainer docs to mention generated documentation
lost
parents: 2
diff changeset
9 as any other generated files intended to be distributed.
2
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
10
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
11 Any branch not directly intended to be a release need not include the
107
69ead2e61763 Added start of a manual and updated maintainer docs to mention generated documentation
lost
parents: 2
diff changeset
12 generated files.
2
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
13
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
14 The trunk development stream must not include the autotool generated files
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
15 as these are likely to change rapidly and it can cause a great deal of
107
69ead2e61763 Added start of a manual and updated maintainer docs to mention generated documentation
lost
parents: 2
diff changeset
16 confusion for little gain. Also, the main trunk need not contain such
69ead2e61763 Added start of a manual and updated maintainer docs to mention generated documentation
lost
parents: 2
diff changeset
17 things as generated documentation files for the same reason.
2
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
18
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
19 By including the generated files in the release branches, it is possible
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
20 to replicate any problems users of the package may have, including if it
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
21 is due to problems with the autotools themselves.
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
22
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
23
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
24 Naming of branches and tags should conform to the following guidlines.
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
25
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
26 1. any branch leading to a release series must be named as the base revision
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
27 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
28 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
29 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
30 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
31 be avoided if at all possible.
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
32
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
33 2. any tag for a specific release version will be named as the release. So
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
34 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
35 would be "1.0.1.1".
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
36
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
37 3. branches not associated with a release stream - say for feature development
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
38 or what have you should be named sensibly and should be removed when no longer
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
39 needed. They must not appear to be version numbers.
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
40
a8a83ccffafd Converted to automake/autoconf
lost
parents:
diff changeset
41 4. tags not specifying a release must not look like version numbers