From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Juanma Barranquero Newsgroups: gmane.emacs.devel Subject: Re: [Emacs-diffs] master 5515625: ; ChangeLog.2 fixes Date: Sun, 25 Oct 2015 16:47:15 +0100 Message-ID: References: <20151025140139.5262.2147@vcs.savannah.gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=001a114066d29bff8b0522efc497 X-Trace: ger.gmane.org 1445788082 29690 80.91.229.3 (25 Oct 2015 15:48:02 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 25 Oct 2015 15:48:02 +0000 (UTC) Cc: emacs-devel To: bruce.connor.am@gmail.com Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Oct 25 16:48:02 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ZqNWa-0004fQ-P4 for ged-emacs-devel@m.gmane.org; Sun, 25 Oct 2015 16:48:00 +0100 Original-Received: from localhost ([::1]:48482 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZqNWa-0005Zl-0D for ged-emacs-devel@m.gmane.org; Sun, 25 Oct 2015 11:48:00 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37215) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZqNWW-0005ZU-OK for emacs-devel@gnu.org; Sun, 25 Oct 2015 11:47:57 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZqNWV-0004Fi-MO for emacs-devel@gnu.org; Sun, 25 Oct 2015 11:47:56 -0400 Original-Received: from mail-lf0-x235.google.com ([2a00:1450:4010:c07::235]:36140) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZqNWV-0004Fe-Ea for emacs-devel@gnu.org; Sun, 25 Oct 2015 11:47:55 -0400 Original-Received: by lffz202 with SMTP id z202so124896137lff.3 for ; Sun, 25 Oct 2015 08:47:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type; bh=WbKLavMSwkNe34+hcjY2wT4jwyUP1qRghVhtGnVFYs0=; b=k1nzGxQxh4BBNHafIQPXOVTQlarB+HL+8MzSsfEp8qPQo8UH+kG6T7KfslVPd4AKvE YTxjrddIGsoeX8EOpyNNLprENPN7ytHl6rb4pVrWwR53zXimTbw9hKgIWeRRtTat3vvK gZUDyVFch8s/OWc9cWf2mk+FUDHyDodxhaBHJidWkx3ZXxy71Le6GKYeW5OK7d5elRrH i8vixmy/qtDW14wwyMghNisXPFW5lW3VOJDj+oTaIBkUhAJLSdynOEalcimaM1BW8o/+ tJ+v+/fgLHDjqLS4oofmWU6l3HOsqQO4w1aLeEkbuBwYQ2JjfoCx/XWLXoJ4P9w5//td yUng== X-Received: by 10.25.80.77 with SMTP id e74mr9706543lfb.11.1445788074637; Sun, 25 Oct 2015 08:47:54 -0700 (PDT) Original-Received: by 10.25.217.135 with HTTP; Sun, 25 Oct 2015 08:47:15 -0700 (PDT) In-Reply-To: X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2a00:1450:4010:c07::235 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:192601 Archived-At: --001a114066d29bff8b0522efc497 Content-Type: text/plain; charset=UTF-8 Hi. The CONTRIBUTE file talks about the commit log messages. We generate the ChangeLog from the commit messages, but it is its own thing, and I think that making it more readable, removing redundancies, etc. is good. They mostly have different targets; we developers are now much more likely to use git log or gitk than go fishing into ChangeLogs, while people who downloads a source tarball only has the ChangeLogs. That's why I spend time cleaning them. As for that particular example, I've mostly respected cases of "one line description non-ending in period", but when the one-line description is of the type * file (blabla): some change" I usually change it to * dir/file (blabla): Some change. for coherence with other entries that do not happen to be the one-line description of a commit. I also remove (here and in a patch I'm working on) the one-line description in cases like: Do XXX in function YYY of file ZZZ * ZZZ: Do XXX in function YYY. or Do XXX in function YYY of file ZZZ * ZZZ(YYY): Do XXX. but I've left one-line descriptions untouched when they add information or are formulated differently. That said, I do these changes that I feel make ChangeLog better, but anyone is of course entitled to do the same or revert my changes. Or, if there's some consensus that some of these changes are wrong, I'll adapt to whatever is preferred. Thanks, Juanma --001a114066d29bff8b0522efc497 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable
Hi.

The CONTRIBUTE file talks abo= ut the commit log messages. We generate the ChangeLog from the commit messa= ges, but it is its own thing, and I think that making it more readable, rem= oving redundancies, etc. is good. They mostly have different targets; we de= velopers are now much more likely to use git log or gitk than go fishing in= to ChangeLogs, while people who downloads a source tarball only has the Cha= ngeLogs. That's why I spend time cleaning them.

As f= or that particular example, I've mostly respected cases of "one li= ne description non-ending in period", but when the one-line descriptio= n is of the type

=C2=A0 =C2=A0 * file (blabla): so= me change"

I usually change it to
<= br>
=C2=A0 =C2=A0 * dir/file (blabla): Some change.
for coherence with other entries that do not happen to be the o= ne-line description of a commit.

I also remove (he= re and in a patch I'm working on) the one-line description in cases lik= e:

=C2=A0 =C2=A0Do XXX in function YYY of fil= e ZZZ

=C2=A0 =C2=A0* ZZZ: Do XXX in function YYY.<= /div>

or

=C2=A0 =C2= =A0Do XXX in function YYY of file ZZZ

=C2=A0 =C2= =A0* ZZZ(YYY): Do XXX.

but I've left one= -line descriptions untouched when they add information or are formulated di= fferently.

That said, I do these changes that I fe= el make ChangeLog better, but anyone is of course entitled to do the same o= r revert my changes. Or, if there's some consensus that some of these c= hanges are wrong, I'll adapt to whatever is preferred.

Thanks,

=C2=A0 =C2=A0 Juanma
--001a114066d29bff8b0522efc497--