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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 80DC3C43334 for ; Wed, 15 Jun 2022 14:52:34 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 05B0A6B0078; Wed, 15 Jun 2022 10:52:34 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id F25E16B007B; Wed, 15 Jun 2022 10:52:33 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D9F516B007D; Wed, 15 Jun 2022 10:52:33 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id C91326B0078 for ; Wed, 15 Jun 2022 10:52:33 -0400 (EDT) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 9F259336F3 for ; Wed, 15 Jun 2022 14:52:33 +0000 (UTC) X-FDA: 79580761386.05.DBFD9DC Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by imf05.hostedemail.com (Postfix) with ESMTP id 93CB5100083 for ; Wed, 15 Jun 2022 14:52:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655304751; x=1686840751; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=53ty0IP5L1GW4FlGJtIGHTOP2azV+ByICEd+t5+IJuw=; b=XBHwxqUVApKANbyOzTdgDWAtIju4RYcdUCikyYQM+3lV2gmesyk63enf 7P1uURmL2TVdag+BCvzy0hSQoa/wdisW53F2mU1d4HVrJ4Hs77xDBr6zX vn7C7iJ4IP9PG+bS1Q8P/yLDKKsvF7rKn5GJc3jFFYANmx3WjHnEhVb8l DIRlUD3XWts1ukPMbLITj4pck4hC2v01EiXa3OZ/0FeKtyC2hBsqDXQmj v523k4eUQLjYOvcblzNn9n8FLfMdENKM2HbHerqnteaqu2jur/gq9qnPr 1zjiMDab+r6OiZ2Ce9Jv4hhEqXKaUoscInnBagtOvvGTZkwHC4Nc2LQSM g==; X-IronPort-AV: E=McAfee;i="6400,9594,10378"; a="276558467" X-IronPort-AV: E=Sophos;i="5.91,302,1647327600"; d="scan'208";a="276558467" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga102.fm.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> ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655304752; a=rsa-sha256; cv=none; b=Xi/3tD0PbGY5cXdaZBOFvc5s5VRcPauVHr5yBwuMWPoIOoApA5oRLR9X39Czx5Vf2RV1Hv J+lvUu04Ct9ns9wK23kmV8fOnDGyOqIDuOaZZ+EfG6s59uXs5s3Zh7jHiWVO1HlDqDOoeu nA288veEPvGbAHRCzheT0aZtGEG3GIQ= ARC-Authentication-Results: i=1; imf05.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b=XBHwxqUV; spf=none (imf05.hostedemail.com: domain of ira.weiny@intel.com has no SPF policy when checking 192.55.52.93) smtp.mailfrom=ira.weiny@intel.com; dmarc=pass (policy=none) header.from=intel.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655304752; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=N/ic/NWQw6MEzANzaB8nI56i8acYUTSzX14kj6/Eo0o=; b=hxObA/RQ3LKhthqKa23ISRMIis74WlAlTFXacSyfOO143d4pVOCy7MidJJwVkTjuwZ9ib9 VOiHtkTu+pAt9B6BydJqh0LDdxZUULNHYCJ1v0ExVpL9TSjAeNqMXMjCSusxO84UYzQWeK YfxZ2wJ1tCKymugG8anDpuTjMjoUDrk= X-Rspam-User: X-Rspamd-Server: rspam01 X-Rspamd-Queue-Id: 93CB5100083 X-Stat-Signature: c7gfyeun3xxmhc7agygrw7w46bgen8d6 Authentication-Results: imf05.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b=XBHwxqUV; spf=none (imf05.hostedemail.com: domain of ira.weiny@intel.com has no SPF policy when checking 192.55.52.93) smtp.mailfrom=ira.weiny@intel.com; dmarc=pass (policy=none) header.from=intel.com X-HE-Tag: 1655304751-9190 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: 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 >