From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3927CC433EF for ; Tue, 14 Jun 2022 13:08:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229933AbiFNNIk (ORCPT ); Tue, 14 Jun 2022 09:08:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54264 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S245344AbiFNNIa (ORCPT ); Tue, 14 Jun 2022 09:08:30 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2C1E362F6; Tue, 14 Jun 2022 06:08:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=In-Reply-To:Content-Type:MIME-Version: References:Message-ID:Subject:Cc:To:From:Date:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description; bh=hjgW1iVXZwSWULLtmSFms/AqBauzk37V6ns/4dxDDjI=; b=jmJfBvabs8zrDcqXgR47H6WTLC hbp6ErmGcui9GKIjs6TWZL9BwwV9y/0ipBgSSE0z2MHMe+m2pFgK2x+rxLDzmpArZw8LjgO1iHOIO r4gQCEUIVnsdGe7NYtOkc0PXrebPwqtr4mgwgHRS6REjbnfE20htIu7igG6u7UWJQq32AaqzXF5pP 7zKlwhqpLaqhED4i5QjPGfjHvsN2O29JdSZ09Wcs7+NlKx+jnltsw99fFpUxpNnGBbNNJf2y3AQvu QA5dqvGwJqfIy6t1Os6biKIqd6AH9N8FoyCAZHjco13X0Ru+qwSKJEpxCi36BDRvyKfOwER3fg/Sr svMzhP/g==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1o16HM-000BCG-8E; Tue, 14 Jun 2022 13:08:20 +0000 Date: Tue, 14 Jun 2022 14:08:20 +0100 From: Matthew Wilcox To: Bagas Sanjaya Cc: linux-doc@vger.kernel.org, Andrew Morton , Ira Weiny , "Fabio M. De Francesco" , Sebastian Andrzej Siewior , linux-mm@kvack.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] Documentation: highmem: Use literal block for *kmap_local_folio() example Message-ID: References: <20220614123115.522131-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220614123115.522131-1-bagasdotme@gmail.com> Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Tue, Jun 14, 2022 at 07:31:16PM +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_local_folio() are enclosed by double dash (--) instead of prefixed > with comment symbol (#). That's clearly the code example for kmap_atomic(), not kmap_local_folio(). > Fix these warnings by indenting the code example with literal block > indentation and prefixing comments inside the example with #. > > Fixes: 85a85e7601263f ("Documentation/vm: move "Using kmap-atomic" to highmem.h") > Cc: Andrew Morton > Cc: Ira Weiny > Cc: "Matthew Wilcox (Oracle)" > Cc: "Fabio M. De Francesco" > Cc: Sebastian Andrzej Siewior > Cc: linux-mm@kvack.org > Cc: linux-kernel@vger.kernel.org > Signed-off-by: Bagas Sanjaya > --- > 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..a244e0345c87ca 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: b13baccc3850ca8b8cccbf8ed9912dbaa0fdf7f3 > -- > An old man doll... just what I always wanted! - Clara >