[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <YqnyJ/5/ZLiNI+5v@iweiny-server>
Date: Wed, 15 Jun 2022 07:52:23 -0700
From: Ira Weiny <ira.weiny@...el.com>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: linux-doc@...r.kernel.org,
Andrew Morton <akpm@...ux-foundation.org>,
"Matthew Wilcox (Oracle)" <willy@...radead.org>,
"Fabio M. De Francesco" <fmdefrancesco@...il.com>,
Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
linux-mm@...ck.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] Documentation: highmem: Use literal block for
*kmap_local_folio() example
On Wed, Jun 15, 2022 at 05:15:10PM +0700, Bagas Sanjaya wrote:
> When building htmldocs on Linus' tree, there are inline emphasis warnings
> on include/linux/highmem.h:
>
> Documentation/vm/highmem:166: ./include/linux/highmem.h:154: WARNING: Inline emphasis start-string without end-string.
> Documentation/vm/highmem:166: ./include/linux/highmem.h:157: WARNING: Inline emphasis start-string without end-string.
>
> These warnings above are due to comments in code example of
> kmap_atomic() inside kernel-doc comment of *kmap_local_folio() are enclosed
> by double dash (--) instead of prefixed with C comment symbol (//).
>
> Fix these warnings by indenting the code example with literal block
> indentation and prefixing comments inside the example with C comment
> symbol.
>
> Fixes: 85a85e7601263f ("Documentation/vm: move "Using kmap-atomic" to highmem.h")
> Cc: Andrew Morton <akpm@...ux-foundation.org>
> Cc: Ira Weiny <ira.weiny@...el.com>
Reviewed-by: Ira Weiny <ira.weiny@...el.com>
Tested-by: Ira Weiny <ira.weiny@...el.com>
> Cc: "Matthew Wilcox (Oracle)" <willy@...radead.org>
> Cc: "Fabio M. De Francesco" <fmdefrancesco@...il.com>
> Cc: Sebastian Andrzej Siewior <bigeasy@...utronix.de>
> Cc: linux-mm@...ck.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
> Changes since v1 [1]:
> - Point that the code example is for kmap_atomic() (suggested by
> Matthew Wilcox)
> - Use C comments instead of Unix shell comments prefix (suggested by
> Ira Weiny)
>
> [1]: https://lore.kernel.org/linux-doc/20220614123115.522131-1-bagasdotme@gmail.com/
>
> include/linux/highmem.h | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/include/linux/highmem.h b/include/linux/highmem.h
> index 3af34de54330cb..56d6a019653489 100644
> --- a/include/linux/highmem.h
> +++ b/include/linux/highmem.h
> @@ -149,19 +149,19 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset);
> * It is used in atomic context when code wants to access the contents of a
> * page that might be allocated from high memory (see __GFP_HIGHMEM), for
> * example a page in the pagecache. The API has two functions, and they
> - * can be used in a manner similar to the following:
> + * can be used in a manner similar to the following::
> *
> - * -- Find the page of interest. --
> - * struct page *page = find_get_page(mapping, offset);
> + * // Find the page of interest.
> + * struct page *page = find_get_page(mapping, offset);
> *
> - * -- Gain access to the contents of that page. --
> - * void *vaddr = kmap_atomic(page);
> + * // Gain access to the contents of that page.
> + * void *vaddr = kmap_atomic(page);
> *
> - * -- Do something to the contents of that page. --
> - * memset(vaddr, 0, PAGE_SIZE);
> + * // Do something to the contents of that page.
> + * memset(vaddr, 0, PAGE_SIZE);
> *
> - * -- Unmap that page. --
> - * kunmap_atomic(vaddr);
> + * // Unmap that page.
> + * kunmap_atomic(vaddr);
> *
> * Note that the kunmap_atomic() call takes the result of the kmap_atomic()
> * call, not the argument.
>
> base-commit: 018ab4fabddd94f1c96f3b59e180691b9e88d5d8
> --
> An old man doll... just what I always wanted! - Clara
>
Powered by blists - more mailing lists