This is the mail archive of the
elfutils-devel@sourceware.org
mailing list for the elfutils project.
Re: ChangeLog entries (Was: [PATCH v3] Use fallthrough attribute)
- From: Ulf Hermann <ulf dot hermann at qt dot io>
- To: elfutils-devel at sourceware dot org
- Date: Mon, 12 Feb 2018 10:33:20 +0100
- Subject: Re: ChangeLog entries (Was: [PATCH v3] Use fallthrough attribute)
- Authentication-results: sourceware.org; auth=none
- Authentication-results: spf=none (sender IP is ) smtp.mailfrom=ulf dot hermann at qt dot io;
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=qtcompany.onmicrosoft.com; s=selector1-qt-io; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=DoPNjgx8GP1LtAgSUQlU7RcdaVAvmxQqx1bo4hfRYk0=; b=I7WVWxXni+wqrCqNVyeGo4nDIyH2fLhtsXxXofUY7v71d4xMEm2pB8Gg3qQGvcEYuumAZUUJPkulqEb8ybPZRMsZYoKxU3X0h//QWf9HW4LPtjutGIEPMfaugOfyCQY/RN+qU4wiCMYYUDbZ7JcV1x6KKxea6F+OsyL9ln4fwHg=
- References: <20180208233010.11395-1-JPEWhacker@gmail.com> <20180209162718.5905-1-JPEWhacker@gmail.com> <20180210022643.GD3320@wildebeest.org> <20180210033631.GM24815@redhat.com> <1518266386.3657.32.camel@klomp.org>
- Spamdiagnosticmetadata: NSPM
- Spamdiagnosticoutput: 1:99
> For people that don't like them, what exactly is it about them that you
> don't like? And what would you suggest as replacement?
I don't like them because they constantly give me problems when merging and for me at least they only repeat, in a less convenient form, what the commit message already states. I like to put the "what" part in the commit message, too. And there I can write paragraphs of text that describe changes that span multiple directories. In ChangeLog I have to restrict myself to only that directory, which often doesn't make sense. So, the ChangeLog entries often are glorified "change line X in file Y", which doesn't really tell you what's going on. Also, the format encourages you to keep the ChangeLog entries overly short, which, especially in combination with the other problems, IMO makes them mostly unreadable.
So, as a replacement: Write more verbose commit messages.
br,
Ulf