Manually pull from git "old-dev" branch

[freeradius.git] / doc / DIFFS.rst

diff --git a/doc/DIFFS.rst b/doc/DIFFS.rst
index 07e36c3..1884ca0 100644 (file)
--- a/doc/DIFFS.rst
+++ b/doc/DIFFS.rst
@@ -1,4 +1,5 @@
-       Submitting patches or diff's to the FreeRADIUS project
+Submitting patches or diff's to the FreeRADIUS project
+======================================================
 
 For a person or company wishing to submit a change to the
 FreeRADIUS project, the process can sometimes be daunting if you're
@@ -7,6 +8,7 @@ suggestions which can greatly increase the chances of your change
 being accepted.
 
 SECTION 1 - CREATING AND SENDING YOUR CHANGE 
+--------------------------------------------
 
    1. "diff -u" 
 
@@ -131,6 +133,7 @@ SECTION 1 - CREATING AND SENDING YOUR CHANGE
       When in doubt, re-submit.
 
 SECTION 2 - HINTS, TIPS, AND TRICKS 
+-----------------------------------
 
 This section lists many of the common "rules" associated with code
 submitted to the project. There are always exceptions... but you must
@@ -139,7 +142,7 @@ have a really good reason for doing so.
    1. Read the Documentation and follow the CodingStyle 
 
       The FreeRADIUS server has a common coding style.  Use real tabs
-         to indent.  There is whitespace in variable assignments.
+      to indent.  There is whitespace in variable assignments.
       (i = 1, NOT i=1).
 
       When in doubt, format your code to look the same as code already
@@ -155,7 +158,7 @@ have a really good reason for doing so.
       are used in the code. Let the compiler optimize away the "no-op"
       case.
 
-      Simple example, of poor code: 
+      Simple example, of poor code:: 
 
            #ifdef CONFIG_MY_FUNKINESS 
                  init_my_stuff(foo);
@@ -163,17 +166,15 @@ have a really good reason for doing so.
 
       Cleaned-up example: 
 
-      (in header) 
+      (in header):: 
 
            #ifndef CONFIG_MY_FUNKINESS
            static inline void init_my_stuff(char *foo) {}
            #endif 
 
-      (in the code itself) 
+      (in the code itself):: 
 
-          ...
            init_my_stuff(dev); 
-          ...
 
    3. 'static inline' is better than a macro