summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorStefano Lattarini <stefano.lattarini@gmail.com>2011-12-20 14:14:08 +0100
committerStefano Lattarini <stefano.lattarini@gmail.com>2011-12-20 14:14:08 +0100
commitc5f878aba841b360f499cf528a60ec49064fa269 (patch)
tree67575c70e970b2c9a73a5909813b9c3563c6c923 /HACKING
parent47587d15b0749575e95a49443c6b0e17e0722678 (diff)
parent63da4921d542b2c329cf95f58c955b9972c5d161 (diff)
downloadautomake-c5f878aba841b360f499cf528a60ec49064fa269.tar.gz
Merge branch 'maint'
* maint: test defs: hack to support autoconf-wrapper programs tests: fix a minor spurious failure with FreeBSD make tests: make two test scripts executable readme: reference webpages for automake mailing lists readme: update advice about testsuite execution readme: don't reference the old homepage at sources.redhat.com hacking: some more fixlets * NEWS: Fix typo in 'make dist-bzip2' description. release: don't run "make distcheck" automatically hacking: update on-line documentation for stable releases only hacking: described release procedure applies to beta releases too readme: the documentation is production quality now hacking: tell about platform-testers mailing list hacking: we don't use sources.redhat.com anymore hacking: miscellaneous minor fixes
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING47
1 files changed, 23 insertions, 24 deletions
diff --git a/HACKING b/HACKING
index 1cc43fe3e..0fbcbe6f4 100644
--- a/HACKING
+++ b/HACKING
@@ -10,12 +10,18 @@
================================================================
= Administrivia
+* The correct response to most actual bugs is to write a new test case
+ which demonstrates the bug. Then fix the bug, re-run the test suite,
+ and check everything in.
+
* If you incorporate a change from somebody on the net:
First, if it is a large change, you must make sure they have signed the
appropriate paperwork.
Second, be sure to add their name and email address to THANKS
* If a change fixes a test, mention the test in the ChangeLog entry.
+ If a change fixes a bug registered in the Automake debbugs tracker,
+ mention the bug number in the ChangeLog entry.
* If somebody reports a new bug, mention his name in the ChangeLog entry
and in the test case you write. Put him into THANKS.
@@ -24,10 +30,6 @@
sure to add a test case for it, and to reference such test case from
a proper Texinfo comment.
-* The correct response to most actual bugs is to write a new test case
- which demonstrates the bug. Then fix the bug, re-run the test suite,
- and check everything in.
-
* Some files in the automake package are not owned by automake. These
files should never be edited here. These files are
COPYING (from FSF),
@@ -151,9 +153,9 @@
* 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 be merged later. The next branch may serve as
- common ground for feature merging and testing, should they not be ready
- for master yet.
+ 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
@@ -187,6 +189,10 @@
================================================================
= Release procedure
+* The steps outlined here are meant to be followed for alpha and stable
+ 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.)
@@ -200,13 +206,14 @@
* Update ChangeLog.
-* Run ./bootstrap, ./configure, make.
+* Run this:
+ ./bootstrap && ./configure && make && make check && make distcheck
* Run `make release-stats' if release statistics in doc/automake.texi
have not been updated yet.
* Run `make git-release'.
- This will run distcheck to create the tarballs, commit the last
+ This will run "make dist" to create the tarballs, commit the last
NEWS/configure.ac/ChangeLog changes, tag the repository, sign
the tarballs, and upload them.
Use `make GNUPLOADFLAGS="--user key" git-release' to sign with
@@ -218,18 +225,7 @@
* Don't forget to `git push' your changes so they appear in the public
git tree.
-* Update the web pages at sources.redhat.com:
- - bump version in index.rst,
- - add entry to news.rst,
- - run `make' to update .html files,
- - create manuals:
- cd doc
- make pdf
- make html MAKEINFOFLAGS=--no-split
- - copy automake.html and automake.pdf to web cvs,
- - add ChangeLog entry and commit.
-
-* Update the manuals at www.gnu.org:
+* For stable releases, update the manuals at www.gnu.org:
- Generate manuals:
cd doc
wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
@@ -240,9 +236,12 @@
- Check for link errors, fix them, recheck until convergence:
<http://validator.w3.org/checklink>
-* Send announcement at least to autotools-announce@gnu.org, and
- automake@gnu.org. If not an alpha, announcement must also go to
- info-gnu@gnu.org. Copy this announcement into the NEWS feed at
+* Send the announcement at least to <autotools-announce@gnu.org> and
+ <automake@gnu.org>. If the release is a stable one, the announcement
+ must also go to <info-gnu@gnu.org>; if it is an alpha or beta release,
+ announcement should be sent also to <platform-testers@gnu.org>, to
+ maximize the possibility of early testing on exotic or proprietary
+ systems. Finally, copy the announcement into the NEWS feed at
<https://savannah.gnu.org/projects/automake>.
-----