pgsql: Improve 9.5 release notes.

Started by Andres Freundalmost 11 years ago9 messageshackers
Jump to latest
#1Andres Freund
andres@anarazel.de

Improve 9.5 release notes.

1) Add sgml comments referencing commits. This is useful to search for
missing items etc.

The comments containing the commit notes are an excerpt from:
git log --date=short \
--pretty='format:%cd [%h] %<(8,trunc)%cN: %<(48,trunc)%s%n%n%w(,4,4)%b%n' \
$(git merge-base origin/master upstream/REL9_4_STABLE)..origin/master
2) Improve a handful of existing notes
3) Add missing entries about a couple features.
4) Add a bunch of straight-forward FIXMEs

Branch
------
master

Details
-------
http://git.postgresql.org/pg/commitdiff/c0b0501925eacbf2d9c10cd231bf8a14e7c9ef4c

Modified Files
--------------
doc/src/sgml/release-9.5.sgml | 688 ++++++++++++++++++++++++++++++++++++++---
1 file changed, 651 insertions(+), 37 deletions(-)

--
Sent via pgsql-committers mailing list (pgsql-committers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-committers

In reply to: Andres Freund (#1)
Re: pgsql: Improve 9.5 release notes.

On Tue, Jun 30, 2015 at 12:00 PM, Andres Freund <andres@anarazel.de> wrote:

Improve 9.5 release notes.

Noticed a typo:

"compact and cheap to to update by"

--
Peter Geoghegan

--
Sent via pgsql-committers mailing list (pgsql-committers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-committers

#3Bruce Momjian
bruce@momjian.us
In reply to: Andres Freund (#1)
Adding commit details to SGML release notes

On Tue, Jun 30, 2015 at 07:00:45PM +0000, Andres Freund wrote:

Improve 9.5 release notes.

1) Add sgml comments referencing commits. This is useful to search for
missing items etc.

The comments containing the commit notes are an excerpt from:
git log --date=short \
--pretty='format:%cd [%h] %<(8,trunc)%cN: %<(48,trunc)%s%n%n%w(,4,4)%b%n' \
$(git merge-base origin/master upstream/REL9_4_STABLE)..origin/master

To simplify the creation of the release note with the commit tag as an
SGML comment, I think src/tools/git_changelog should be modified to
output this string. The format "trunc" feature was added in git 1.8.3.
Is that old enough for everyone?

I am not going to need this until the 9.6 release notes. Should I add
it or someone else?

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ Everyone has their own god. +

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#4Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Bruce Momjian (#3)
Re: Adding commit details to SGML release notes

Bruce Momjian wrote:

To simplify the creation of the release note with the commit tag as an
SGML comment, I think src/tools/git_changelog should be modified to
output this string. The format "trunc" feature was added in git 1.8.3.
Is that old enough for everyone?

Hmm, that's pretty new actually,

commit edca4152560522a431a51fc0a06147fc680b5b18
Author: Junio C Hamano <gitster@pobox.com>
AuthorDate: Fri May 24 11:34:46 2013 -0700
CommitDate: Fri May 24 11:34:46 2013 -0700

Git 1.8.3

Since it's only needed by people preparing the release notes, I would
guess it's okay --- evidently Tom was able to use it.

Maybe an option is to use trunc when git 1.8.3 or newer is detected, and
plain (no trunc) otherwise?

--
�lvaro Herrera http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#5Tom Lane
tgl@sss.pgh.pa.us
In reply to: Alvaro Herrera (#4)
Re: Adding commit details to SGML release notes

Alvaro Herrera <alvherre@2ndquadrant.com> writes:

Bruce Momjian wrote:

To simplify the creation of the release note with the commit tag as an
SGML comment, I think src/tools/git_changelog should be modified to
output this string. The format "trunc" feature was added in git 1.8.3.
Is that old enough for everyone?

Since it's only needed by people preparing the release notes, I would
guess it's okay --- evidently Tom was able to use it.

Well, that's only because I'm running a hand-installed git rather than
what RHEL6 comes with.

Maybe an option is to use trunc when git 1.8.3 or newer is detected, and
plain (no trunc) otherwise?

Personally I find that truncated output to be pretty unreadable, and
would strongly object to changing git_changelog so that that was the only
possible format. However, I have no objection to making it an option
("git_changelog --short", or so), and that would dodge any concerns about
failing on git versions without the feature.

regards, tom lane

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#6Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#5)
Re: Adding commit details to SGML release notes

On Fri, Aug 28, 2015 at 05:32:38PM -0400, Tom Lane wrote:

Alvaro Herrera <alvherre@2ndquadrant.com> writes:

Bruce Momjian wrote:

To simplify the creation of the release note with the commit tag as an
SGML comment, I think src/tools/git_changelog should be modified to
output this string. The format "trunc" feature was added in git 1.8.3.
Is that old enough for everyone?

Since it's only needed by people preparing the release notes, I would
guess it's okay --- evidently Tom was able to use it.

Well, that's only because I'm running a hand-installed git rather than
what RHEL6 comes with.

Yes, I am running git 1.7.2.5 on Debian Squeeze, but I will be upgrading
in the next month, before the next major release notes are due, so I
would avoid the problem that way. :-)

Maybe an option is to use trunc when git 1.8.3 or newer is detected, and
plain (no trunc) otherwise?

Personally I find that truncated output to be pretty unreadable, and
would strongly object to changing git_changelog so that that was the only
possible format. However, I have no objection to making it an option
("git_changelog --short", or so), and that would dodge any concerns about
failing on git versions without the feature.

Well, my idea would be to change this git_changelog line:

Branch: master [01051a987] 2015-07-09 11:38:34 +0300

to output something in the new 'trunc' format, so we have it right next
to the release note text and the release notes easily get that comment.

If we _don't_ do that, how do you easily get those lines into the
release notes? I can't imagine how hard it was for Andres to add that
text to the 9.5 release notes:

/messages/by-id/E1ZA0lx-0006FM-PU@gemulon.postgresql.org

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ Everyone has their own god. +

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#7Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#6)
Re: Adding commit details to SGML release notes

Bruce Momjian <bruce@momjian.us> writes:

On Fri, Aug 28, 2015 at 05:32:38PM -0400, Tom Lane wrote:

Personally I find that truncated output to be pretty unreadable, and
would strongly object to changing git_changelog so that that was the only
possible format. However, I have no objection to making it an option
("git_changelog --short", or so), and that would dodge any concerns about
failing on git versions without the feature.

Well, my idea would be to change this git_changelog line:

Branch: master [01051a987] 2015-07-09 11:38:34 +0300

to output something in the new 'trunc' format, so we have it right next
to the release note text and the release notes easily get that comment.

Right, I'm merely saying that I want the current format by default, and
the trunc format only with a command-line option.

regards, tom lane

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#8Andres Freund
andres@anarazel.de
In reply to: Bruce Momjian (#6)
Re: Adding commit details to SGML release notes

On 2015-08-28 17:49:35 -0400, Bruce Momjian wrote:

If we _don't_ do that, how do you easily get those lines into the
release notes? I can't imagine how hard it was for Andres to add that
text to the 9.5 release notes:

Formatting the log wasn't the hard part, that was finding out which item
in the release notes corresponds to which commits. Sometimes that's not
that easy to see. For the formatting I had an emacs macro.

Greetings,

Andres Freund

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#9Bruce Momjian
bruce@momjian.us
In reply to: Andres Freund (#8)
Re: Adding commit details to SGML release notes

On Sat, Aug 29, 2015 at 12:23:30AM +0200, Andres Freund wrote:

On 2015-08-28 17:49:35 -0400, Bruce Momjian wrote:

If we _don't_ do that, how do you easily get those lines into the
release notes? I can't imagine how hard it was for Andres to add that
text to the 9.5 release notes:

Formatting the log wasn't the hard part, that was finding out which item
in the release notes corresponds to which commits. Sometimes that's not
that easy to see. For the formatting I had an emacs macro.

Right, the formatting is easy with any good editor, but having the text
there as you are writing the release notes is a huge time-saver, and if
we want that text, it should be present in the git_changelog output when
creating those release notes.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ Everyone has their own god. +

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers