= Working with git
* To regenerate dependent files created by aclocal and automake,
- use the 'bootstrap' script. It uses the code from the source
+ use the 'bootstrap.sh' script. It uses the code from the source
tree, so the resulting files (aclocal.m4 and Makefile.in) should
be the same as you would get if you install this version of
automake and use it to generate those files. Be sure to have the
- latest stable version of Autoconf installed. If such version is
- not installed as "autoconf", pass it explicitly (along with the
- accompanying "autom4te") when calling 'bootstrap' and 'configure'.
- For example:
- $ AUTOCONF=autoconf2.68 AUTOM4TE=autom4te2.68 ./bootstrap
- $ ./configure AUTOCONF=autoconf2.68 AUTOM4TE=autom4te2.68
-
-* Dependent files aclocal.m4, configure and Makefile.in in all
- directories should be up to date in the git repository, so that
- the changes in them can be easily noticed and analyzed.
-
-* The git tree currently carries a number of branches: master for the
- current development, and release branches named branch-X.Y. The maint
- branch serves as common ground for both master and the active release
- branches. Changes intended for both should be applied to maint, which
- should then be merged to release branches and master, of course after
- suitable testing. It is advisable to merge only after a set of related
- commits have been applied.
-
-* Example work flow for patches to maint:
-
- # 1. Checkout the "maint" branch:
- git checkout maint
-
- # 2. Apply the patch(es) with "git am" (or create them with $EDITOR):
- git am -3 0*.patch
- # 2a. Run required tests, if any ...
-
- # 3. Merge maint into branch-1.11:
- git checkout branch-1.11
- git merge maint
- # 3a. Run required tests, if any ...
-
- # 4. Redo steps 3 and 3a for master:
- git checkout master
- git merge maint
- # testing ...
-
- # 5. Push the maint and master branches:
- git push --dry-run origin maint branch-1.11 master
- # if all seems ok, then actually push:
- git push origin maint branch-1.11 master
+ latest stable version of Autoconf installed and available early
+ in your PATH.
+
+* The Automake git tree currently carries two basic branches: 'master' for
+ the current development, and 'maint' for maintenance and bug fixes. The
+ maint branch should be kept regularly merged into the master branch.
+ It is advisable to merge only after a set of related commits have been
+ applied, to avoid introducing too much noise in the history.
+
+* There may be a number of longer-lived feature branches for new
+ developments. They should be based off of a common ancestor of all
+ active branches to which the feature should or might be merged later.
+ in the future, we might introduce a special branch named 'next' that
+ may serve as common ground for feature merging and testing, should
+ they not yet be ready for master.
+
+* After a major release is done, the master branch is to be merged into
+ the maint branch, and then a "new" master branch created stemming
+ from the resulting commit.
* When fixing a bug (especially a long-standing one), it may be useful
to commit the fix to a new temporary branch based off the commit that
the active branches descending from the buggy commit. This offers a
simple way to fix the bug consistently and effectively.
-* There may be a number of longer-lived feature branches for new developments.
- They should be based off of a common ancestor of all active branches to
- which the feature should or might be merged later. The next branch may
- serve as common ground for feature merging and testing, should they not
- be ready for master yet.
-
* For merges from branches other than maint, prefer 'git merge --log' over
plain 'git merge', so that a later 'git log' gives an indication of which
actual patches were merged even when they don't appear early in the list.
* Use perl coverage information to ensure your new code is thoroughly
tested by your new tests.
-* See file 'tests/README' for more information.
+* See file 't/README' for more information.
================================================================
= Release procedure
releases as well. Where differences are expected, they will be
explicitly described.
-* Fetch new versions of the files that are maintained by the FSF.
- Commit. Unfortunately you need an FSF account to do this.
- (You can also use "make fetch", but that is still woefully incomplete.)
+* Fetch new versions of the files that are maintained by the FSF by
+ running "make fetch". In case any file in the automake repository
+ has been updated, commit and re-run the testsuite.
+
+* Ensure that the copyright notices of the distributed files is up to
+ date. The maintainer-only target "update-copyright" can help with
+ this.
* Update NEWS.
distinguish net and repo versions.)
* Run this:
- ./bootstrap && ./configure && make && make check && make distcheck
+ ./bootstrap.sh && ./configure && make && make check && make distcheck
* Run "make git-tag-release".
- This will run the maintainer checks, check that the NEWS file is
- up-to-date, check that the local git repository and working tree
- are clean and up-to-date, and create a proper signed git tag for
- the release (based on the contents of $(VERSION)).
+ This will run the maintainer checks, verify that the local git
+ repository and working tree are clean and up-to-date, and create
+ a proper signed git tag for the release (based on the contents
+ of $(VERSION)).
* Run "make git-upload-release".
This will first verify that you are releasing from a tagged version
use "make GNUPLOADFLAGS='--user KEY' git-upload-release".
* Update version number in configure.ac to next alpha number.
- Re-run ./bootstrap and commit.
+ Re-run ./bootstrap.sh and commit.
* Don't forget to "git push" your changes so they appear in the public
git tree.
projects / platform / upstream / automake.git / blobdiff