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 C134EC43334 for ; Wed, 15 Jun 2022 14:37:19 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5106F6B0072; Wed, 15 Jun 2022 10:37:19 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 4C0316B0083; Wed, 15 Jun 2022 10:37:19 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3871F6B0085; Wed, 15 Jun 2022 10:37:19 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 28AE16B0072 for ; Wed, 15 Jun 2022 10:37:19 -0400 (EDT) Received: from smtpin29.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id E4B10346F2 for ; Wed, 15 Jun 2022 14:37:18 +0000 (UTC) X-FDA: 79580722956.29.E0D4331 Received: from casper.infradead.org (casper.infradead.org [90.155.50.34]) by imf20.hostedemail.com (Postfix) with ESMTP id 1D9401C008A for ; Wed, 15 Jun 2022 14:37:17 +0000 (UTC) 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=saG5sDrVw9Zr0xvtzKbdVeuNnQ3Z6A05xiDq4AzD6dg=; b=bj1K2vKmeUI35w3WQw2RkLX1ip QCEaDPfkJlTI0mlAWH5qdVUCTCBvOh2OgJPA/Qa2CT7CPAj1Q5XMiFlSSiWVG14WOOF8TBkW9C8DB smp0xoEry+r3xyzto66f5nl3HyiSHbc0k8xZYj5h3FUvwCfsfaTk7bkzWV7D47207xO7HNu5g4FiG R0fNxeFhwAmmLmrKbEPXG5brlpPDUOBQfVgtPTNRYEV2l21il8F42ETOfD+HoC/5qjClPhEbDsQSM 7I8v8lhqeRHkRZEvifGEzh3KJY4kpRdBL11eBdkZnqmC/4L86Lt6dmyhY2QRPhCjV60mCS/pK7EVK pqDqcbCA==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1o1U8j-0017Zi-CF; Wed, 15 Jun 2022 14:37:01 +0000 Date: Wed, 15 Jun 2022 15:37:01 +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 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-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655303838; 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=saG5sDrVw9Zr0xvtzKbdVeuNnQ3Z6A05xiDq4AzD6dg=; b=t0IvH/HDtp0oDdp1XNF2li+joFTNVuFzX1YKLJ50PKYrlU4jqYL6gbjtMo2XCOX1Z84ysU T/N6SSJRWreYQVitZaxUA2bnYPzINTPwZk7vL4034I28rH8Uwkxoto56s0mf6/migjjZxY J2z5Z/eraeaE65+VoUjp/bnialHdAsM= ARC-Authentication-Results: i=1; imf20.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=bj1K2vKm; dmarc=none; spf=none (imf20.hostedemail.com: domain of willy@infradead.org has no SPF policy when checking 90.155.50.34) smtp.mailfrom=willy@infradead.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655303838; a=rsa-sha256; cv=none; b=Uhn4UgtN0m/SRSIzf6A+5749WZzyH49GHrQR1G9Ew/hAKtS4jHk1NpRP035JRiDu64zQ4h OQRPVhQQrx64038gH6c3XvywGn+eB1jbj9yRqQ6f1HkDik1gvaaulzNVNrn2yg5Tll2hLr UQsvkDNl/vf1xq5aFWblD0f+lzeGe04= X-Rspamd-Queue-Id: 1D9401C008A X-Rspam-User: X-Stat-Signature: 88gep8fr85hqytqa4skya9u56h9paiie Authentication-Results: imf20.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=bj1K2vKm; dmarc=none; spf=none (imf20.hostedemail.com: domain of willy@infradead.org has no SPF policy when checking 90.155.50.34) smtp.mailfrom=willy@infradead.org X-Rspamd-Server: rspam04 X-HE-Tag: 1655303837-615344 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: > These warnings above are due to comments in code example of > kmap_atomic() inside kernel-doc comment of *kmap_local_folio() are enclosed You still seem to think this has something to do with kmap_local_folio(). It has nothing to do with kmap_local_folio(). Your next version of this patch should not mention kmap_local_folio() anywhere. > 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 > 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 > >