Changes between Version 4 and Version 5 of DeveloperDocumentationNew

Timestamp:

02/07/17 10:46:39 (7 years ago)

Author:

Samuli Seppänen

Comment:

--

DeveloperDocumentationNew

@@ -26 +26 @@
 = Patch quality =
 
-== Formatting ==
-
-Existing codebase uses the following formatting conventions:
+== Code style ==
+
+OpenVPN 2.3 and earlier use mostly the following conventions:
 
  * Indentation is 2 spaces (no tabs)
@@ -37 +37 @@
    * indent-with-tabs nil
 
-== Conventions ==
-
-All ''patches'', regardless of their type need to be created following a few rules:
-
- * Must be sent as unified diff (diff -u) or preferably generated by ''git format-patch''
- * Patches must have a short but descriptive one-line summary of the change, followed by a more descriptive text explaining in plain English why and how the patch is written.  This description should ''not'' be too technical, as the patch itself will reveal technical details.  More on [http://who-t.blogspot.com/2009/12/on-commit-messages.html writing good commit messages here]
- * Patches should contain a 'Signed-off-by:' line at the end (git commit --signoff).  If missing, it will be added with the sender of the patch as the signed-off person.
+OpenVPN 2.4 uses the Allman style:
+
+ * Indentation is 4 spaces, no tabs ever.
+ * Opening and closing brackets get their own line, and must match indentation.
+ * Line length is 80 characters.
+ * C99 is allowed. E.g. for (int i = 0; i < max; i++).
+ * Only use /* */-style comments
+
+Full documentation of the 2.4 style is on the [wiki:CodeStyle CodeStyle] page.
+
+== Commit message ==
+
+Patches must have a short but descriptive one-line summary of the change, followed by a more descriptive text explaining in plain English why and how the patch is written.  This description should ''not'' be too technical, as the patch itself will reveal the technical details. The patch should also conform to these rules (adapted from [http://chris.beams.io/posts/git-commit/#seven-rules here]):
+
+ * Separate subject from body with a blank line
+ * Limit the subject line to 50 characters
+  * '''NOTE:''' this limit is under discussion
+ * Capitalize the subject line
+ * Do not end the subject line with a period
+ * Use the imperative mood in the subject line
+ * Wrap the body at 72 characters
+  * '''NOTE:''' this limit is under discussion
+ * Use the body to explain "what" and "why"
+
+In addition
+
+ * Patches should contain a 'Signed-off-by:' line at the end (git commit --signoff).
  * Patches must apply cleanly, without merge conflicts.  Please state which code base the patch is written against.  If based on the git tree, please state which branch it is to be applied to.
- * Everyone who has contributed to this patch should be mentioned out of courtesy and respect to all contributors and helpers on the way.   If suitable valid e-mail address should be used, preferably in addition with full name.
+ * Everyone who has contributed to this patch should be mentioned out of courtesy and respect to all contributors and helpers on the way. If suitable valid e-mail address should be used, preferably in addition with full name.
+
+== Sending the patch ==
+
+We strongly encourage using [https://git-scm.com/docs/git-send-email git send-email] for sending the patches, so that your email client does not mess up the patch. 
+
 
 == Code contributions ==