all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Dmitry Gutov <dgutov@yandex.ru>
To: Glenn Morris <rgm@gnu.org>, 20328@debbugs.gnu.org
Subject: bug#20328: outdated CONTRIBUTE info re ChangeLogs
Date: Wed, 15 Apr 2015 02:26:28 +0300	[thread overview]
Message-ID: <552DA224.6020801@yandex.ru> (raw)
In-Reply-To: <91a8ybmdkq.fsf@fencepost.gnu.org>

On 04/14/2015 09:25 AM, Glenn Morris wrote:

> CONTRIBUTE contains outdated information re ChangeLogs.
> Someone should review it and update it.

I don't know if they're all actually incorrect. Based on an non-obvious 
distinction - yes.

Since a commit message contains a summary, maybe a few headers, and a 
ChangeLog entry, it's fair to describe what a "ChangeLog entry" should 
contain.

> Random hits (almost every instance related to "ChangeLog" seems wrong to me):
>
>    If committing changes written by someone else, make the ChangeLog
>    entry in their name, not yours.

Right, there's no separate name line in the ChangeLog entries inside 
commit messages. Updated.

>    [...]
>    It is tempting to relax this rule for commit messages, since they
>    are somewhat transient.

This one actually seemed outdated. Removed.

>    [...]
>    In ChangeLog entries, there is no standard or recommended way to
>    identify revisions.

This still applies. Even though it could say "in commit messages", this 
also emphasized the fact that the same non-sandardized references will 
appear in the ChangeLog file.

>    [...]
>    There is no need to make separate ChangeLog entries for files such
>    as NEWS, MAINTAINERS...

Still true, and I'm not sure how to rephrase this to refer to commit 
messages.





  reply	other threads:[~2015-04-14 23:26 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-14  6:25 bug#20328: outdated CONTRIBUTE info re ChangeLogs Glenn Morris
2015-04-14 23:26 ` Dmitry Gutov [this message]
2015-04-15 16:52   ` Glenn Morris
2015-04-16 14:54     ` Dmitry Gutov

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=552DA224.6020801@yandex.ru \
    --to=dgutov@yandex.ru \
    --cc=20328@debbugs.gnu.org \
    --cc=rgm@gnu.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.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.