device: renew dhcp leases on awake for software devices

[NetworkManager.git] / CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 11cf6ec..d3ea0ce 100644 (file)
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -1,17 +1,38 @@
 Guidelines for Contributing:
 
-1) Platform-specific functionality (for example, location of binaries that NetworkManager calls) should be done in a platform-independent manner.  If code currently in NetworkManager does not accomodate that, then the code in NetworkManager needs to be changed to provide that.  For example, if another platform does not use "dhclient" to get DHCP information, a separate function should be created to return a command-line string to call rather than inserting huge if/#ifdef blocks into the current function.
-
-2) Coding standards are more-or-less GNOME coding standards, with these exceptions:
-       a) 5 space tabs  (no 8-space tabs allowed)
-       b) REAL tabs
-       c) Braces are moved to the next line, like:
-               if (foobar)
-               {
-                       ...
-               }
-         rather than:
-               if (foobar) {
+1) Platform-specific functionality (for example, location of binaries that
+NetworkManager calls, or functionality used only on some platforms or
+distribution, like resolvconf) should be configurable at build time, with the
+normal autoconf mechanisms for putting a #define in config.h (AC_DEFINE), then
+with #ifdef MY_DEFINE / #endif in the code.
+
+2) Coding standards are generally GNOME coding standards, with these exceptions:
+       a) 4 space tabs  (_not_ 8-space tabs)
+       b) REAL tabs (_not_ a mix of tabs and spaces in the initial indent)
+       c) spaces used to align continuation lines past the indent point of the
+          first statement line, like so:
+
+               if (some_really_really_long_variable_name &&
+                   another_really_really_long_variable_name) {
                        ...
                }
-       d) Limiting line width to 80 characters is frowned upon
+
+* Keep a space between the function name and the opening '('.
+    GOOD: g_strdup (x)
+    BAD:  g_strdup(x)
+
+* C-style comments
+    GOOD: f(x);  /* comment */
+    BAD:  f(x);  // comment
+
+* Keep assignments in the variable declaration area pretty short.
+    GOOD: MyObject *object;
+    BAD: MyObject *object = complex_and_long_init_function(arg1, arg2, arg3);
+
+* 80-cols is a guideline, don't make the code uncomfortable in order to fit in
+  less than 80 cols.
+
+* Constants are CAPS_WITH_UNDERSCORES and use the preprocessor.
+    GOOD: #define MY_CONSTANT 42
+    BAD:  static const unsigned myConstant = 42;
+