[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Patches to README-release
From: |
Jim Meyering |
Subject: |
Re: Patches to README-release |
Date: |
Fri, 27 Jan 2012 19:21:40 +0100 |
Reuben Thomas wrote:
> Ping? The patches still apply cleanly to HEAD.
>
> On 22 December 2011 19:54, Reuben Thomas <address@hidden> wrote:
>> A series of patches that attempt to improve a few minor formatting
>> problems and also streamline some of the steps.
...
>>
>> From 1949b5fc095e746bac4ab90c30b373b79aa6507d Mon Sep 17 00:00:00 2001
>> From: Reuben Thomas <address@hidden>
>> Date: Mon, 19 Dec 2011 09:46:16 +0100
>> Subject: [PATCH 2/4] * top/README-release: fix punctuation and spacing.
>> Remove
A one-line summary should not start with "*"
>> MIME-Version: 1.0
>> Content-Type: text/plain; charset=UTF-8
>> Content-Transfer-Encoding: 8bit
>>
>> paragraph about checking version of installed autotools, as this
>> is not usually needed for each release (the required and installed
>> versions won’t change often), and running bootstrap will check
>> them anyway.
>> ---
>> ChangeLog | 6 +++++-
>> top/README-release | 4 ----
>> 2 files changed, 5 insertions(+), 5 deletions(-)
>>
>> diff --git a/ChangeLog b/ChangeLog
>> index 3296d79..01ce24f 100644
>> --- a/ChangeLog
>> +++ b/ChangeLog
>> @@ -1,7 +1,11 @@
>> 2011-12-22 Reuben Thomas <address@hidden>
>>
>> Improvements to README-release
>> - * top/README-release: fix punctuation and spacing.
>> + * top/README-release: fix punctuation and spacing. Remove
>> + paragraph about checking version of installed autotools, as this
>> + is not usually needed for each release (the required and installed
>> + versions won’t change often), and running bootstrap will check
>> + them anyway.
>>
>> 2011-12-19 Reuben Thomas <address@hidden>
>>
>> diff --git a/top/README-release b/top/README-release
>> index 2c3d117..6c1e70c 100644
>> --- a/top/README-release
>> +++ b/top/README-release
>> @@ -6,10 +6,6 @@ Here are most of the steps we (maintainers) follow
>> when making a release.
>> git checkout master
>> git pull origin master
>>
>> -* Ensure that the desired versions of autoconf, automake, etc.
>> - are in your PATH. See the buildreq list in bootstrap.conf for
>> - the complete list.
That paragraph is trying to say that one should be careful not to
prepare a release using anything less than the latest stable releases.
That is *not* checked by running bootstrap, and hence why I mentioned
it here. For example, if I have a working directory with lib/getdate.c
generated from before the preceding bison release, I should be careful
to remove it (make maintainer-clean) and regenerate it with the newer
version of bison. In this case, "make distclean" is insufficient.
I.e., you're welcome to reword it, but not to remove it altogether.
>> * Ensure that you're on "master" with no uncommitted diffs.
>> This should produce no output:
>>
...
>> From 5c9a2d71451b27aeaa73fc5d9e513cb9c2a2aee6 Mon Sep 17 00:00:00 2001
>> From: Reuben Thomas <address@hidden>
>> Date: Mon, 19 Dec 2011 12:16:36 +0100
>> Subject: [PATCH 4/4] README-release: improvements to README-release
>>
>> * top/README-release: fix punctuation and spacing. Give a
>> command to push changes for the release. Add "distcheck" to
>> list of other pre-release checks. Fix instance of "make
>> stable" which should be "make type".
>> ---
>> ChangeLog | 5 ++++-
>> top/README-release | 26 ++++++++++++--------------
>> 2 files changed, 16 insertions(+), 15 deletions(-)
>>
>> diff --git a/ChangeLog b/ChangeLog
>> index 37aa35c..b292cfd 100644
>> --- a/ChangeLog
>> +++ b/ChangeLog
>> @@ -5,7 +5,10 @@
>> paragraph about checking version of installed autotools, as this
>> is not usually needed for each release (the required and installed
>> versions won’t change often), and running bootstrap will check
>> - them anyway. Remove redundant "git checkout master".
>> + them anyway. Remove redundant "git checkout master". Give a
>> + command to push changes for the release. Add "distcheck" to list
>> + of other pre-release checks. Fix instance of "make stable" which
>> + should be "make type".
>>
>> 2011-12-19 Reuben Thomas <address@hidden>
>>
>> diff --git a/top/README-release b/top/README-release
>> index 365bb77..3d43df0 100644
>> --- a/top/README-release
>> +++ b/top/README-release
>> @@ -9,17 +9,17 @@ Here are most of the steps we (maintainers) follow
>> when making a release.
>> * Ensure you have no uncommitted diffs: "git diff" should produce no
>> output.
>>
>> -* Ensure that you've pushed all changes that belong in the release
>> - and that the NixOS/Hydra autobuilder is reporting all is well:
>> +* Ensure that you've pushed all changes that belong in the release:
>> + "git push origin master".
>> +
>> +* Check that the NixOS/Hydra autobuilder is reporting all is well:
>>
>> http://hydra.nixos.org/jobset/gnu/@address@hidden
>>
>> * Run "./bootstrap && ./configure". This downloads any new translations.
>>
>> -* Pre-release testing:
>> - Ensure that "make check syntax-check" succeeds.
>> -
>> -* Run "make distcheck"
>> +* Pre-release testing: ensure that "make check syntax-check distcheck"
>> + succeeds.
>>
>> * Set the date, version number, and release type [stable/alpha/beta] on
>> line 3 of NEWS, commit that, and tag the release by running e.g.,
>> @@ -31,8 +31,7 @@ Here are most of the steps we (maintainers) follow
>> when making a release.
>> The different destinations are specified in cfg.mk. See the definitions
>> of gnu_ftp_host-{alpha,beta,stable}.
>>
>> - # "TYPE" must be stable, beta or alpha
>> - make TYPE
>> + make TYPE # "TYPE" must be stable, beta or alpha
>>
>> * Test the tarball. Copy it to a few odd-ball systems and ensure that
>> it builds and passes all tests.
>> @@ -43,7 +42,7 @@ Here are most of the steps we (maintainers) follow
>> when making a release.
>>
>> Once all the builds and tests have passed,
>>
>> -* Run the gnupload command that was suggested by your "make stable" run
>> above.
>> +* Run the gnupload command that was suggested by your "make TYPE" run above.
This is a bug fix. Thanks!
It could easily go in a separate commit.
>> * Wait a few minutes (maybe up to 30?) and then use the release URLs to
>> download all tarball/signature pairs and use gpg --verify to ensure
>> @@ -54,12 +53,11 @@ Once all the builds and tests have passed,
>> v=$(cat .prev-version)
>> git push origin master tag v$v
>>
>> -* Announce it on Savannah first, so you can include the preferable
>> - savannah.org announcement link in the email message.
>> +* Announce it on Savannah first, so you can include the savannah.org
>> + announcement link in the email message.
>>
>> - From here:
>> - https://savannah.gnu.org/projects/@PACKAGE@/
I prefer to keep this on a line by itself.
That makes it easier to triple-click (from a text window)
and mouse into a browser.
>> - click on the "submit news", then write something like the following:
>> + From here: https://savannah.gnu.org/projects/@PACKAGE@/
>> + click on "submit news", then write something like the following:
>> (If there is no such button, then enable "News" for the project via
>> the Main -> "Select Features" menu item, or via this link:
>> https://savannah.gnu.org/project/admin/address@hidden@)
>> --
>> 1.7.5.4
>>
>> --
>> http://rrt.sc3d.org/
- Re: Patches to README-release, Reuben Thomas, 2012/01/27
- Re: Patches to README-release,
Jim Meyering <=
- Re: Patches to README-release, Gary V. Vaughan, 2012/01/27
- Re: Patches to README-release, Jim Meyering, 2012/01/28
- Re: Patches to README-release, Gary V. Vaughan, 2012/01/28
- Re: Patches to README-release, Jim Meyering, 2012/01/28
- Re: Patches to README-release, Gary V. Vaughan, 2012/01/28
- Re: Patches to README-release, Jim Meyering, 2012/01/28
- Re: Patches to README-release, Jim Meyering, 2012/01/28