aboutsummaryrefslogtreecommitdiffstats
path: root/doc/HACKING
diff options
context:
space:
mode:
authorWerner Koch <[email protected]>2015-08-26 07:28:32 +0000
committerWerner Koch <[email protected]>2015-08-26 08:06:00 +0000
commit107bff70edb611309f627058dd4777a5da084b1a (patch)
treebfa7485739eb79853cbaeec4213ac648fcaed28c /doc/HACKING
parentMake use of GPGRT macros is available. (diff)
downloadgpgme-107bff70edb611309f627058dd4777a5da084b1a.tar.gz
gpgme-107bff70edb611309f627058dd4777a5da084b1a.zip
Release 1.6.0gpgme-1.6.0
* configure.ac: Set LT version to C25/A14/R0. Signed-off-by: Werner Koch <[email protected]>
Diffstat (limited to 'doc/HACKING')
-rw-r--r--doc/HACKING48
1 files changed, 47 insertions, 1 deletions
diff --git a/doc/HACKING b/doc/HACKING
index aedcf094..83c0f517 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -23,11 +23,34 @@
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.
+ leading TAB, will not exceed 80 columns. If you want to add text
+ which shall not be copied to the ChangeLog, separate it by a line
+ consisting of two dashes at the begin of a line.
Note that ./autogen.sh installs a git hook to do some basic syntax
checking on the commit log message.
+ Typo fixes and documentation updates don't need a ChangeLog entry;
+ thus you would use a commit message like
+
+ #+begin_example
+ Fix typo in a comment
+
+ --
+ #+end_example
+
+ The marker line here is important; without it the first line would
+ appear in the ChangeLog.
+
+ If you exceptionally need to have longer lines in a commit log you may
+ do this after this scissor line:
+ #+begin_example
+ # ------------------------ >8 ------------------------
+ #+end_example
+ (hash, blank, 24 dashes, blank, scissor, blank, 24 dashes).
+ Note that such a comment will be removed if the git commit option
+ =--cleanup-scissor= is used.
+
** License policy
GPGME is currently licensed under the LGPLv2.1+ with tools and the
@@ -73,6 +96,29 @@
need. If you really need to do it, use a separate commit for such a
change.
+ - C99 syntax should not be used; stick to C90.
+ - Please do not use C++ =//= style comments.
+ - Try to fit lines into 80 columns.
+ - Ignore signed/unsigned pointer mismatches
+ - No arithmetic on void pointers; cast to char* first.
+
+** Commit log keywords
+
+ - GnuPG-bug-id :: Values are comma or space delimited bug numbers
+ from bug.gnupg.org pertaining to this commit.
+ - Debian-bug-id :: Same as above but from the Debian bug tracker.
+ - CVE-id :: CVE id number pertaining to this commit.
+ - Regression-due-to :: Commit id of the regression fixed by this commit.
+ - Fixes-commit :: Commit id this commit fixes.
+ - Reported-by :: Value is a name or mail address of a bug reporte.
+ - Suggested-by :: Value is a name or mail address of someone how
+ suggested this change.
+ - Co-authored-by :: Name or mail address of a co-author
+ - Some-comments-by :: Name or mail address of the author of
+ additional comments (commit log or code).
+ - Proofread-by :: Sometimes used by translation commits.
+ - Signed-off-by :: Name or mail address of the developer
+
* Debug hints
- Use gpgme-tool for manual tests.