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 82019C433EF for ; Wed, 15 Jun 2022 14:52:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239864AbiFOOwf (ORCPT ); Wed, 15 Jun 2022 10:52:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38328 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S241061AbiFOOwb (ORCPT ); Wed, 15 Jun 2022 10:52:31 -0400 Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 20873C02; Wed, 15 Jun 2022 07:52:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655304749; x=1686840749; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=53ty0IP5L1GW4FlGJtIGHTOP2azV+ByICEd+t5+IJuw=; b=iR97OI2yw37N1HbwF5RpGSGsQcIXHUot7YeLwBTrbmOB63pAE3l0wxZ2 S/FcnYpFkpm5OUt/PO1evZChpt00Wf3FSfJRvYZntizzaNYa2JaFijdMy sJ4p0wYkXJWAhd4oqhU3Mx8X1nDocKvBCqDxQXspEB2QgTefbZnWGBZK1 7esNfpUOstnbszr3ggxJRY/MtVuuuNwBy8sE+thYZkISuFXGL2qqTLj7s ron9ZiahYAomTuH8wt/5J2fjfRHWKYARBZ+ExixJZi91T+6t5x1w9s87T ZP+c+HMt94vQcSpw1LD7PLUW6++0FiDFH+Tn42d2eKI3dh7zptaepGcUb g==; X-IronPort-AV: E=McAfee;i="6400,9594,10378"; a="267675574" X-IronPort-AV: E=Sophos;i="5.91,302,1647327600"; d="scan'208";a="267675574" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Jun 2022 07:52:24 -0700 X-IronPort-AV: E=Sophos;i="5.91,302,1647327600"; d="scan'208";a="559157818" Received: from iweiny-server.sc.intel.com (HELO localhost) ([172.25.222.75]) by orsmga006-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Jun 2022 07:52:23 -0700 Date: Wed, 15 Jun 2022 07:52:23 -0700 From: Ira Weiny To: Bagas Sanjaya Cc: linux-doc@vger.kernel.org, Andrew Morton , "Matthew Wilcox (Oracle)" , "Fabio M. De Francesco" , Sebastian Andrzej Siewior , linux-mm@kvack.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v2] Documentation: highmem: Use literal block for *kmap_local_folio() example Message-ID: References: <20220615101509.516520-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220615101509.516520-1-bagasdotme@gmail.com> Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 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 > Cc: Ira Weiny Reviewed-by: Ira Weiny Tested-by: 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 > --- > 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 >