diff options
author | Matthew Wilcox <mawilcox@microsoft.com> | 2018-02-13 13:15:34 -0800 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2018-02-13 14:21:48 -0700 |
commit | dcb50d979ecc80e1f2d90acb7734d7bcd0e44672 (patch) | |
tree | a6b23adfd4ef469dfa8547bb1d61514a99677dca /Documentation/doc-guide/kernel-doc.rst | |
parent | da70b8c47515ea408e3ab7fd97307ef16d3b9ff1 (diff) | |
download | linux-stable-dcb50d979ecc80e1f2d90acb7734d7bcd0e44672.tar.gz linux-stable-dcb50d979ecc80e1f2d90acb7734d7bcd0e44672.tar.bz2 linux-stable-dcb50d979ecc80e1f2d90acb7734d7bcd0e44672.zip |
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/kernel-doc.rst')
-rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 16 |
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:: |