Bill Wohler
2016-01-03 01:46:42 UTC
Just noticed that ChangeLogs are now generated automatically from the
Git log (finally!). We still have to largely follow the old ChangeLog
format though. Please see '** Commit messages' in emacs/CONTRIBUTE for
the new conventions.
I've deleted the ChangeLogs from the MH-E development repository and
edited the Makefiles accordingly. If desired, I can add machinery to
generate a ChangeLog for a release.
If you touch a ChangeLog file in the top mh-e directory, you can use 'C-x
4 a' to create a ChangeLog entry that has the full path to the file
(such as * doc/Makefile:). If you use VC to check in the file, then the
log-edit-hook will pick it up. I've added ChangeLog to .gitignore so it
shouldn't get checked in.
The Emacs folks have adopted the Git convention of ensuring the first
line is a short summary separated by a blank line.
However, they have added the convention that it doesn't have a period.
This is a misguided convention that breaks the prime rule that comments
are complete sentences. It looks bad in the output of git log and will
likely cause inconsistency when comments are extracted (or add lots of
code to work around it). The rule is not uniformly followed, even by
core Emacs developers, and I'd recommend that we not follow it either. I
use complete sentences in my commit messages for all of my other Git
repositories.
I haven't pushed yet. I'll do so when I'm done converting the Makefiles
from bzr to git. After that, I'll go through the devguide and push out
8.6.
Git log (finally!). We still have to largely follow the old ChangeLog
format though. Please see '** Commit messages' in emacs/CONTRIBUTE for
the new conventions.
I've deleted the ChangeLogs from the MH-E development repository and
edited the Makefiles accordingly. If desired, I can add machinery to
generate a ChangeLog for a release.
If you touch a ChangeLog file in the top mh-e directory, you can use 'C-x
4 a' to create a ChangeLog entry that has the full path to the file
(such as * doc/Makefile:). If you use VC to check in the file, then the
log-edit-hook will pick it up. I've added ChangeLog to .gitignore so it
shouldn't get checked in.
The Emacs folks have adopted the Git convention of ensuring the first
line is a short summary separated by a blank line.
However, they have added the convention that it doesn't have a period.
This is a misguided convention that breaks the prime rule that comments
are complete sentences. It looks bad in the output of git log and will
likely cause inconsistency when comments are extracted (or add lots of
code to work around it). The rule is not uniformly followed, even by
core Emacs developers, and I'd recommend that we not follow it either. I
use complete sentences in my commit messages for all of my other Git
repositories.
I haven't pushed yet. I'll do so when I'm done converting the Makefiles
from bzr to git. After that, I'll go through the devguide and push out
8.6.
--
Bill Wohler <***@newt.com> aka <***@nasa.gov>
http://www.newt.com/wohler/
GnuPG ID:610BD9AD
------------------------------------------------------------------------------
Bill Wohler <***@newt.com> aka <***@nasa.gov>
http://www.newt.com/wohler/
GnuPG ID:610BD9AD
------------------------------------------------------------------------------