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 B9204C433EF for ; Wed, 15 Jun 2022 14:55:49 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 38FEF6B0074; Wed, 15 Jun 2022 10:55:49 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 33FE36B007B; Wed, 15 Jun 2022 10:55:49 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 207876B007D; Wed, 15 Jun 2022 10:55:49 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 0DC646B0074 for ; Wed, 15 Jun 2022 10:55:49 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay13.hostedemail.com (Postfix) with ESMTP id DAB9060128 for ; Wed, 15 Jun 2022 14:55:48 +0000 (UTC) X-FDA: 79580769576.10.3DB143A Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by imf24.hostedemail.com (Postfix) with ESMTP id E9D6418007A for ; Wed, 15 Jun 2022 14:55:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655304947; x=1686840947; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=AyHEYASdAXzKDT8EuTX1y0edC0hgS/AoJlSZAmp9yEk=; b=YeKZNsM0whTH78WWIdxfOP9oKJ+w2ByRIum2WzvXgrFUS/iWB5h9+mvr 3Gl3M81EckrUKuwryg73Woz2YhyBwGeECguAO2SyZ2WKnKFpSwp4/N8PW 3Yb99C1XovhlStL5P/l+EYfwJmCPOOmo/QUKKOLvT2v5jyg/TX2xwgLGj +5/vtW1gUStQkP4m6zja23SZCGzRu6v34KIrYDNiu/OA4J3CNiqPHO2dc hs75sktSCRkcCMe8hUzia7pkCCCZhtXyppki8L7fLMYLdTk9V+XM4wNCG 4ScR656kB6vKu9ELmZT8A4IT0QF5IVzEPjxiLSjlz9fZvWShuQRNaFM3S A==; X-IronPort-AV: E=McAfee;i="6400,9594,10378"; a="277780894" X-IronPort-AV: E=Sophos;i="5.91,302,1647327600"; d="scan'208";a="277780894" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Jun 2022 07:54:03 -0700 X-IronPort-AV: E=Sophos;i="5.91,302,1647327600"; d="scan'208";a="583242956" Received: from iweiny-server.sc.intel.com (HELO localhost) ([172.25.222.75]) by orsmga007-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Jun 2022 07:54:02 -0700 Date: Wed, 15 Jun 2022 07:54:02 -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: ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655304947; a=rsa-sha256; cv=none; b=QUTKEsTk4Va5dYqxaaDceRpjoKf8NmkXug48mFdJwy7YK5zfjNPhh79bmZ7qoV6kA8a1a8 C9l9dyxKrI973uNrv2Wm6RtrI8Djqq2uVHhpU6im4VZa32hTX7u067TPHoqwPyw29MuU8s cn8oM97xxTlmGc2wFgXz5vgXzXWTCl0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655304947; 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=NuSXoOhvPwygRQlgEukZRLW3ERRJCu55W1o1LfU2eoY=; b=d/Ocjl0qjMNLM+YI/M2c0nduqEPnhj40S5LqZVnmangJaFgLTImXhMLdjZX3awqP6oyc8c KOeVbEeKZK+Scc65vFGXiiotZgFsFpCyJomY+jf/iJFLvNtHZFByrLgwGHrK9t2coeKDBm dTyCRQ3mymxFtjbckRsS0mQ3JJQXutI= ARC-Authentication-Results: i=1; imf24.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b=YeKZNsM0; dmarc=pass (policy=none) header.from=intel.com; spf=none (imf24.hostedemail.com: domain of ira.weiny@intel.com has no SPF policy when checking 192.55.52.120) smtp.mailfrom=ira.weiny@intel.com Authentication-Results: imf24.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b=YeKZNsM0; dmarc=pass (policy=none) header.from=intel.com; spf=none (imf24.hostedemail.com: domain of ira.weiny@intel.com has no SPF policy when checking 192.55.52.120) smtp.mailfrom=ira.weiny@intel.com X-Rspam-User: X-Rspamd-Server: rspam09 X-Rspamd-Queue-Id: E9D6418007A X-Stat-Signature: f7xkdw9uykb6cbkjqihmdbyb45us5aoe X-HE-Tag: 1655304946-144329 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 07:52:23AM -0700, Ira wrote: > 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 My bad... > 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) As Willy pointed out you did not do this. I was mistaken to believe this statement. Ira > > - 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 > > >