X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=devel%2FSTYLE;h=24bd5482a4899b185f923302bb4801177dc6b3ea;hb=cb494f72f398bb0898030a1225f9ef6da557e959;hp=0792ba129e240eb1818b1cc2d98f1b16746964f0;hpb=ae459a3f4ca0e24cb2012bc4af7af3aea4731fec;p=notmuch

diff --git a/devel/STYLE b/devel/STYLE
index 0792ba12..24bd5482 100644
--- a/devel/STYLE
+++ b/devel/STYLE
@@ -45,8 +45,9 @@ function (param_type param, param_type param)
    - likewise, there is a space following keywords such as if and while
    - every binary operator should have space on either side.
 
-* No trailing whitespace. Please enable the standard pre-commit hook
-  in git (or an equivalent hook).
+* No trailing whitespace. Please enable the standard pre-commit hook in git
+  (or an equivalent hook). The standard pre-commit hook is enabled by simply
+  renaming file '.git/hooks/pre-commit.sample' to '.git/hooks/pre-commit' .
 
 * The name in a function prototype should start at the beginning of a line.
 
@@ -92,3 +93,13 @@ libnotmuch conventions
 
 * Code which needs to be accessed from both the CLI and from
   libnotmuch should be factored out into libutil (under util/).
+
+* Deprecated functions should be marked with the NOTMUCH_DEPRECATED
+  macro which generates run time warnings with gcc and clang. In order
+  not to confuse doxygen this should go at the beginning of the
+  declaration like:
+
+  NOTMUCH_DEPRECATED(major,minor) notmuch_status_t notmuch_dwim(void *arg);
+
+  The @deprecated doxygen command can be used to generate markup in
+  the API docs.