From: Matthew Wilcox Date: Tue, 13 Feb 2018 21:15:34 +0000 (-0800) Subject: Minor fixes to kernel-doc.rst X-Git-Tag: v4.17-rc1~149^2~70 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dcb50d979ecc80e1f2d90acb7734d7bcd0e44672;p=thirdparty%2Flinux.git 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 Signed-off-by: Jonathan Corbet --- diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 315b0ecc7a11c..64ca081d075ee 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::