Minor fixes to kernel-doc.rst
authorMatthew Wilcox <mawilcox@microsoft.com>
Tue, 13 Feb 2018 21:15:34 +0000 (13:15 -0800)
committerJonathan Corbet <corbet@lwn.net>
Tue, 13 Feb 2018 21:21:48 +0000 (14:21 -0700)
The author clearly meant to use the word 'which' here.  Also replace
some tabs with spaces which fixes the syntax highlighting in my editor.

Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/doc-guide/kernel-doc.rst

index 315b0ecc7a11ca5b844c864cf6dcffc9a319e52b..64ca081d075ee6c61a9472f7d787376541a5b42c 100644 (file)
@@ -277,7 +277,7 @@ named ``Return``.
 
   #) If the descriptive text you provide has lines that begin with
      some phrase followed by a colon, each of those phrases will be taken
-     as a new section heading, with probably won't produce the desired
+     as a new section heading, which probably won't produce the desired
      effect.
 
 Structure, union, and enumeration documentation
@@ -324,22 +324,22 @@ It is possible to document nested structs unions, like::
           struct {
             int arg1;
             int arg2;
-         }
+        }
           struct {
             void *arg3;
             int arg4;
-         }
-       }
-       union {
+          }
+        }
+        union {
           struct {
             int arg1;
             int arg2;
-         } st1;
+          } st1;
           struct {
             void *arg1;
             int arg2;
-         } st2;
-       } bar;
+          } st2;
+        } bar;
       };
 
 .. note::