1
/* Copyright (c) 2003, Theodore Roth
4
Redistribution and use in source and binary forms, with or without
5
modification, are permitted provided that the following conditions are met:
7
* Redistributions of source code must retain the above copyright
8
notice, this list of conditions and the following disclaimer.
9
* Redistributions in binary form must reproduce the above copyright
10
notice, this list of conditions and the following disclaimer in
11
the documentation and/or other materials provided with the
14
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24
POSSIBILITY OF SUCH DAMAGE. */
26
/* $Id: rel-method.dox,v 1.6 2003/09/30 23:05:17 troth Exp $ */
28
/** \page release_method Release Numbering and Methodology
30
\section version_info Release Version Numbering Scheme
32
\subsection version_stable Stable Versions
34
A stable release will always have a minor number that is an even number. This
35
implies that you should be able to upgrade to a new version of the library
36
with the same major and minor numbers without fear that any of the APIs have
37
changed. The only changes that should be made to a stable branch are bug fixes
38
and under some circumstances, additional functionality (e.g. adding support
41
If major version number has changed, this implies that the required versions
42
of gcc and binutils have changed. Consult the README file in the toplevel
43
directory of the AVR Libc source for which versions are required.
45
\subsection version_dev Development Versions
47
The major version number of a development series is always the same as the
50
The minor version number of a development series is always an odd number and
51
is 1 more than the last stable release.
53
The patch version number of a development series is always 0 until a new
54
branch is cut at which point the patch number is changed to 90 to denote the
55
branch is approaching a release and the date appended to the version to denote
56
that it is still in development.
58
All versions in development in cvs will also always have the date appended as
59
a fourth version number. The format of the date will be YYYYMMDD.
61
So, the development version number will look like this:
67
While a pre-release version number on a branch (destined to become either 1.2
68
or 2.0) will look like this:
74
\section release_info Releasing AVR Libc
76
The information in this section is only relevant to AVR Libc developers and
77
can be ignored by end users.
79
\note In what follows, I assume you know how to use cvs and how to checkout
80
multiple source trees in a single directory without having them clobber each
81
other. If you don't know how to do this, you probably shouldn't be making
82
releases or cutting branches.
84
\subsection release_branch Creating a cvs branch
86
The following steps should be taken to cut a branch in cvs:
88
-# Check out a fresh source tree from cvs HEAD.
89
-# Update the NEWS file with pending release number and commit to cvs HEAD:<br>
90
Change "Changes since avr-libc-\<last_release\>:" to
91
"Changes in avr-libc-\<this_relelase\>:".
92
-# Set the branch-point tag (setting \<major\> and \<minor\> accordingly):<br>
93
'cvs tag avr-libc-\<major\>_\<minor\>-branchpoint'
94
-# Create the branch:<br>
95
'cvs tag -b avr-lib-\<major\>_\<minor\>-branch'
96
-# Update the package version in configure.in and commit configure.in to cvs
98
Change minor number to next odd value.
99
-# Update the NEWS file and commit to cvs HEAD:<br>
100
Add "Changes since avr-libc-\<this_release\>:"
101
-# Check out a new tree for the branch:<br>
102
'cvs co -r avr-lib-\<major\>_\<minor\>-branch'
103
-# Update the package version in configure.in and commit configure.in to cvs
105
Change the patch number to 90 to denote that this now a branch leading up
106
to a release. Be sure to leave the \<date\> part of the version.
107
-# Bring the build system up to date by running reconf and doconf.
108
-# Perform a 'make distcheck' and make sure it succeeds. This will create the
109
snapshot source tarball. This should be considered the first release
111
-# Upload the snapshot tarball to savannah.
112
-# Announce the branch and the branch tag to the avr-libc-dev list so other
113
developers can checkout the branch.
115
\note CVS tags do not allow the use of periods ('.').
117
\subsection release_rolling Making a release
119
A stable release will only be done on a branch, not from the cvs HEAD.
121
The following steps should be taken when making a release:
123
-# Make sure the source tree you are working from is on the correct branch:<br>
124
'cvs update -r avr-lib-\<major\>_\<minor\>-branch'
125
-# Update the package version in configure.in and commit it to cvs.
126
-# Update the gnu tool chain version requirements in the README and commit
128
-# Update the ChangeLog file to note the release and commit to cvs on the
130
Add "Released avr-libc-\<this_release\>."
131
-# Bring the build system up to date by running reconf and doconf.
132
-# Perform a 'make distcheck' and make sure it succeeds. This will create the
134
-# Tag the release (_\<patch\> is not given if this is the first release on
136
'cvs tag avr-lib-\<major\>_\<minor\>_\<patch\>-release'
137
-# Upload the tarball to savannah.
138
-# Generate the latest documentation and upload to savannah.
139
-# Announce the release.
141
The following hypothetical diagram should help clarify version and branch
144
\image html releases.png "Release tree"
145
\image latex releases.eps "Release tree" width=5in
added
removed
doc/api/rel-method.dox
