cli: crypto: S/MIME verification support

[notmuch] / devel / STYLE

diff --git a/devel/STYLE b/devel/STYLE
index 094f71d1908f75b48f3d1ae77a4fbae9d260acb2..24bd5482a4899b185f923302bb4801177dc6b3ea 100644 (file)
--- 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.
 
@@ -73,6 +74,12 @@ Naming
   struct has a tag, it should be the same as the typedef name, minus
   the trailing _t.
 
+CLI conventions
+---------------
+
+* Any changes to the JSON output format of search or show need an
+  accompanying change to devel/schemata.
+
 libnotmuch conventions
 ----------------------------------
 
@@ -86,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.