summaryrefslogtreecommitdiff
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorMatthew Wilcox <mawilcox@microsoft.com>2018-02-14 00:15:34 +0300
committerJonathan Corbet <corbet@lwn.net>2018-02-14 00:21:48 +0300
commitdcb50d979ecc80e1f2d90acb7734d7bcd0e44672 (patch)
treea6b23adfd4ef469dfa8547bb1d61514a99677dca /Documentation/doc-guide
parentda70b8c47515ea408e3ab7fd97307ef16d3b9ff1 (diff)
downloadlinux-dcb50d979ecc80e1f2d90acb7734d7bcd0e44672.tar.xz
Minor fixes to kernel-doc.rst
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>
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r--Documentation/doc-guide/kernel-doc.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 315b0ecc7a11..64ca081d075e 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -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::