From: Richard Riley <rileyrg@gmail.com>
To: help-gnu-emacs@gnu.org
Subject: Re: Changelogs, really useful?
Date: Fri, 06 Aug 2010 20:28:33 +0200 [thread overview]
Message-ID: <i3hk8l$s3p$1@dough.gmane.org> (raw)
In-Reply-To: AANLkTi=QMROddVvDuZPJBkL+dFg6bE5J+xqcSLYJ37OB@mail.gmail.com
Deniz Dogan <deniz.a.m.dogan@gmail.com> writes:
> 2010/8/6 Richard Riley <rileyrg@gmail.com>:
>> Deniz Dogan <deniz.a.m.dogan@gmail.com> writes:
>>
>>> 2010/8/6 Andrea Crotti <andrea.crotti.0@gmail.com>:
>>>> It's not really a question about emacs maybe (even if we can automate
>>>> things) but more general about programming...
>>>>
>>>> I was wondering if it's still so useful to write detailed Changelogs.
>>>> I mean all the software is under revision control, and doing small
>>>> commits often I write a commit message for only one function, which
>>>> would be exactly what I add in the changelog.
>>>>
>>>> I don't like to write things twice, and also history in the control
>>>> revision system is much more detailed, does it really make sense to add
>>>> changelogs?
>>>>
>>>> I think that only the changes that involve the architecture or how to
>>>> use the software should be really important, but the default style on
>>>> emacs is quite detailed.
>>>>
>>>> How do you manage?
>>>> Write twice? Write only in the changelog/scm? Other?
>>>>
>>>> Thanks
>>>>
>>>
>>> I suspect it's nice to have a changelog as a file just to be able to
>>> put it online or wherever people would find it useful. Not everyone
>>> enjoys or knows how to see the bzr log.
>>>
>>> Also, consider that the changelog file was introduced before bzr,
>>> which meant that without it people would have to look in a CVS log.
>>> (Those poor people!)
>>
>> Generate the changelog from the VCS in use when you Make the program.
>>
>
> Sometimes the changelog isn't the same as the commit message. The
> changelog can be more vague in its description of what was changed
> whereas the commit message may include many details.
Sure. I was just throwing it out there as a possibility in the
discussion. It's quite common in git circles to do just that and people
commit msg accordingly.
next prev parent reply other threads:[~2010-08-06 18:28 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-06 16:47 Changelogs, really useful? Andrea Crotti
2010-08-06 17:37 ` Deniz Dogan
2010-08-06 17:45 ` Richard Riley
2010-08-06 18:15 ` Andrea Crotti
2010-08-09 8:52 ` Thien-Thi Nguyen
2010-08-06 18:17 ` Deniz Dogan
2010-08-06 18:28 ` Richard Riley [this message]
2010-08-06 18:09 ` Andrea Crotti
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='i3hk8l$s3p$1@dough.gmane.org' \
--to=rileyrg@gmail.com \
--cc=help-gnu-emacs@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.