bug-gnulib@gnu.org mirror (unofficial)
 help / color / mirror / Atom feed
From: Jim Meyering <jim@meyering.net>
To: Simon Josefsson <simon@josefsson.org>
Cc: "bug-gnulib@gnu.org List" <bug-gnulib@gnu.org>
Subject: Re: [PATCH] announce-gen: Mention git commit in release announcement.
Date: Sun, 12 May 2024 09:27:38 -0700	[thread overview]
Message-ID: <CA+8g5KGH_1E=P953WYw9cJZ9T2orcn8h66VN7qf0T=1oZ6FCgg@mail.gmail.com> (raw)
In-Reply-To: <875xvj3ukq.fsf@kaka.sjd.se>

[-- Attachment #1: Type: text/plain, Size: 1906 bytes --]

I like it. Wording and placement are spot on.

Thanks.

On Sun, May 12, 2024, 08:42 Simon Josefsson via Gnulib discussion list <
bug-gnulib@gnu.org> wrote:

> All,
>
> Our release announcements does not mention the git commit hash that was
> used to prepare the release.  While SHA1 is broken, I still think
> including the commit hash provide some additional information that may
> be useful further down the line, and hopefully including doesn't incur
> too much cognitive load on the reader (that isn't already present..).
>
> I haven't pushed the attached patch since I'm not a native speaker.
> Could someone suggest better wording, if needed?  Or better placement in
> the announcement?
>
> To read the result of the patch in context, take some earlier
> announcement:
>
> https://lists.gnu.org/archive/html/info-gnu/2024-03/msg00006.html
>
> and then consider that the patch would turn the following snippet (for a
> hypothethical upcoming GNU inetutils release) text:
>
> This release was bootstrapped with the following tools:
>   Gnulib aacceb6eff
>   Autoconf 2.71
>   Automake 1.16.5
>   Bison 3.8.2
>   M4 1.4.18
>   Makeinfo 6.8
>   Help2man 1.49.1
>   Make 4.3
>   Gzip 1.10
>   Tar 1.34
>
> and turn that into this:
>
> This release was built bootstrapped with the following tools
> using inetutils git commit 524d4b6934db12b9f43be410d2f201fdb40cfc97:
>
>   Gnulib aacceb6eff
>   Autoconf 2.71
>   Automake 1.16.5
>   Bison 3.8.2
>   M4 1.4.18
>   Makeinfo 6.8
>   Help2man 1.49.1
>   Make 4.3
>   Gzip 1.10
>   Tar 1.34
>
> Does this make sense?  Is the location in the announcement e-mail a good
> one?  This hides it a bit further down which I think makes sense.  Few
> readers care about git commit and bootstrapping versions, and the
> information is related.  The new version adds an empty line which I
> think is more consistent with the other paragraphs.
>
> Thoughts?
>
> /Simon
>

[-- Attachment #2: Type: text/html, Size: 2558 bytes --]

  reply	other threads:[~2024-05-12 16:28 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-12 15:42 [PATCH] announce-gen: Mention git commit in release announcement Simon Josefsson via Gnulib discussion list
2024-05-12 16:27 ` Jim Meyering [this message]
2024-05-12 16:46   ` Paul Eggert
2024-05-12 19:50 ` Bruno Haible
2024-05-12 20:47   ` Paul Eggert

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://lists.gnu.org/mailman/listinfo/bug-gnulib

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CA+8g5KGH_1E=P953WYw9cJZ9T2orcn8h66VN7qf0T=1oZ6FCgg@mail.gmail.com' \
    --to=jim@meyering.net \
    --cc=bug-gnulib@gnu.org \
    --cc=simon@josefsson.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).