Messages in this thread | | | Date | Thu, 26 Mar 2020 12:54:20 -0700 | From | Matthew Wilcox <> | Subject | Re: [PATCH v3 1/1] A compact idiom to add code examples in kerneldoc comments. |
| |
On Thu, Mar 26, 2020 at 07:51:56PM +0000, peter@bikeshed.quignogs.org.uk wrote: > From: Peter Lister <peter@bikeshed.quignogs.org.uk> > > scripts/kernel-doc - When a double colon follows a section heading > (e.g. Example::), write a double colon line to the ReST output to make > the following text (e.g. a code snippet) into a literal block. > > drivers/base/platform.c - Changed Example: headings to Example:: to > literalise code snippets as above. > > This patch also removes two kerneldoc build warnings: > ./drivers/base/platform.c:134: WARNING: Unexpected indentation. > ./drivers/base/platform.c:213: WARNING: Unexpected indentation. > > Signed-off-by: Peter Lister <peter@bikeshed.quignogs.org.uk>
Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>
(just to be clear, I'm no python programmer; I like the idea and it looks clear enough to me)
| |