a4c4ee1aae
* build-aux/gitlog-to-changelog: New script. Taken from gnulib. * build-aux/git-log-fix: New file. * build-aux/git-log-footer: New file. * build-aux/git-hook/commit-msg: New script. * doc/HACKING: New file. * ChangeLog: New file. * Makefile.am (EXTRA_DIST): Add new files. (gen-ChangeLog): New. (dist-hook): Run gen-ChangeLog. * autogen.sh: Install commit-msg hook for git. Rename all ChangeLog files to ChangeLog-2011.
29 lines
1.2 KiB
Org Mode
29 lines
1.2 KiB
Org Mode
# HACKING -*- org -*-
|
|
#+TITLE: Hacking notes for GPGME
|
|
#+STARTUP: showall
|
|
|
|
* No more ChangeLog files
|
|
|
|
Do not modify any of the ChangeLog files in GPGME. Starting
|
|
on December 1st, 2011 we put change information only in the GIT
|
|
commit log, and generate a top-level ChangeLog file from logs at
|
|
"make dist" time. As such, there are strict requirements on the
|
|
form of the commit log messages. The old ChangeLog files have all
|
|
be renamed to ChangeLog-2011
|
|
|
|
|
|
* Commit log requirements
|
|
|
|
Your commit log should always start with a one-line summary, the
|
|
second line should be blank, and the remaining lines are usually
|
|
ChangeLog-style entries for all affected files. However, it's fine
|
|
-- even recommended -- to write a few lines of prose describing the
|
|
change, when the summary and ChangeLog entries don't give enough of
|
|
the big picture. Omit the leading TABs that you're used to seeing
|
|
in a "real" ChangeLog file, but keep the maximum line length at 72
|
|
or smaller, so that the generated ChangeLog lines, each with its
|
|
leading TAB, will not exceed 80 columns.
|
|
|
|
Note that ./autogen.sh installs a git hook to do some basic syntax
|
|
checking on the commit log message.
|