public inbox for gdb@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Luis Machado <luis.machado@linaro.org>
Cc: vapier@gentoo.org, gdb@sourceware.org
Subject: Re: sim: replacing ChangeLog files with online git logs
Date: Wed, 17 Mar 2021 17:40:56 +0200	[thread overview]
Message-ID: <83mtv1dbzr.fsf@gnu.org> (raw)
In-Reply-To: <18f4f0e2-0a35-a6c5-1886-943f81f817fd@linaro.org> (message from Luis Machado on Wed, 17 Mar 2021 12:22:46 -0300)

> Cc: vapier@gentoo.org, gdb@sourceware.org
> From: Luis Machado <luis.machado@linaro.org>
> Date: Wed, 17 Mar 2021 12:22:46 -0300
> 
> Given the idea is to drop ChangeLog files for sim/ (for reasons Mike has 
> exposed), it would make no sense to keep embedding a manually-written 
> ChangeLog entry in the git commit message. So the only two sections left 
> in the commit message would be the subject line and the description.

That doesn't have to be so, though.  How to format the Git log
messages when ChangeLog files are dropped is a separate discussion.

> The list of changes would be auto-generated by a script, but it will 
> certainly be less descriptive than a manually-written ChangeLog entry. 
> It will only list things like "modified" or "new file".
> 
> > 
> > For example, in Emacs we ask contributors to format the Git log
> > messages according to ChangeLog format, and then the generated
> > ChangeLog file looks exactly like the manual one would.
> > 
> 
> I may be mistaken, but I think the idea is to drop ChangeLog 
> dependencies even from commit messages. That will simplify the 
> contribution process given ChangeLog files/entries will be 
> auto-generated by the mentioned script.

The list of files touched by a changeset can be easily generated, but
the functions/macros/classes not so easily, and not necessarily
accurately enough, even if we will use the more elaborate script that
is used by glibc.  So some information loss will be present.

OTOH, the ChangeLog-format Git log messages don't require one to have
the ChangeLog file, they just require to use the same format when
describing the changeset.  If you use Emacs to make the changes
themselves and commit the changes into Git, you just need to use the
Emacs commands to format the Git log messages, those commands will
produce the same information as the manual ChangeLog files
automatically.

If that is not an option that this community wants to adopt, then
gitlog-to-changelog is probably not the adequate solution, and we
should try using vcs-to-changelog.py (also in Gnulib).

  reply	other threads:[~2021-03-17 15:41 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-13  2:53 Mike Frysinger
2021-03-13  7:30 ` Eli Zaretskii
2021-03-13 15:12   ` Mike Frysinger
2021-03-13 16:02     ` Eli Zaretskii
2021-03-13 16:26       ` Mike Frysinger
2021-03-13 16:38         ` Eli Zaretskii
2021-03-13 18:21           ` Mike Frysinger
2021-03-13 18:32             ` Eli Zaretskii
2021-03-17  6:07               ` Mike Frysinger
2021-03-17 13:14                 ` Eli Zaretskii
2021-03-17 14:31                   ` Luis Machado
2021-03-17 14:47                     ` Eli Zaretskii
2021-03-17 14:52                       ` Luis Machado
2021-03-17 15:09                         ` Eli Zaretskii
2021-03-17 15:22                           ` Luis Machado
2021-03-17 15:40                             ` Eli Zaretskii [this message]
2021-03-17 15:52                               ` Simon Marchi
2021-03-17 16:09                                 ` Eli Zaretskii
2021-03-17 17:24                                   ` Luis Machado
2021-03-17 17:53                                     ` Eli Zaretskii
2021-03-17 20:53                                       ` Luis Machado
2021-03-18  9:31                                       ` Andrew Burgess
2021-03-18  9:48                                         ` Eli Zaretskii
2021-03-22  2:19                                           ` Maciej W. Rozycki
2021-03-22  3:38                                             ` Eli Zaretskii
2021-03-23  4:57                                               ` Mike Frysinger
2021-03-23  5:05                   ` Mike Frysinger
2021-03-23 11:06                     ` Andrew Burgess
2021-03-24  3:45                       ` Mike Frysinger
2021-03-24 16:46                         ` Eli Zaretskii
2021-03-24 16:59                           ` Andrew Burgess
2021-03-24 17:39                             ` Eli Zaretskii
2021-03-24 18:44                               ` Mike Frysinger
2021-03-31  2:27                                 ` Mike Frysinger
2021-03-31  3:27                                   ` Joel Brobecker
2021-03-31 11:35                                     ` Luis Machado
2021-03-31 15:29                                       ` Joel Brobecker
2021-04-01  3:41                                     ` Mike Frysinger
2021-04-19  0:52                                       ` Mike Frysinger
2021-04-19  2:32                                         ` Joel Brobecker
2021-04-19  4:31                                           ` Mike Frysinger
2021-04-19  5:00                                             ` Joel Brobecker
2021-05-23  3:26                                               ` Mike Frysinger
2021-06-10 12:11                                                 ` Luis Machado
2021-03-13 18:34             ` Paul Smith

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

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

  git send-email \
    --in-reply-to=83mtv1dbzr.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb@sourceware.org \
    --cc=luis.machado@linaro.org \
    --cc=vapier@gentoo.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).