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 97796C433EF for ; Tue, 14 Jun 2022 23:33:29 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 93BBE6B0071; Tue, 14 Jun 2022 19:33:28 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 8EC7D6B0072; Tue, 14 Jun 2022 19:33:28 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 717486B0073; Tue, 14 Jun 2022 19:33:28 -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 5C5DC6B0071 for ; Tue, 14 Jun 2022 19:33:28 -0400 (EDT) Received: from smtpin08.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 32FE934A96 for ; Tue, 14 Jun 2022 23:33:28 +0000 (UTC) X-FDA: 79578445296.08.B7C794F Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by imf20.hostedemail.com (Postfix) with ESMTP id 554FE1C0093 for ; Tue, 14 Jun 2022 23:33:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655249605; x=1686785605; h=date:from:to:cc:subject:message-id:references: in-reply-to:mime-version; bh=y4FKZHKqsJqrgo0rZLbjPy41hyqjua5mA514+7rOyLI=; b=DBL46F6CNKMki5cyjYSTXc7zX9QH4A0KcWLK9kObd9lrHbRjr31En3HN esg62AAOleMKG3bv1qyh9iek/Zi5a9FPmEaonzkfZ5lPJUALQdDpGQq7S UOzi5llbjaXkb4phIpB6BlFU0CTpAejdrAmrbmTMkdt1BgMeNTVMw3JAz +5h3saRezluUojCmdScR4wTU4FB0b4GIaZ5v7gCZA5N5OgCe0qI0zHTZc /WO2rpFpIrSOirGGN+Kv9hc1a9KcKrjV4irFYFOKBnkcz0eeunSXjiXVn NLlRR1RPRk0SJ2aQqNeseeCrbrlfPPqdSzYmk/foI+jD9fDOMznvFA607 g==; X-IronPort-AV: E=McAfee;i="6400,9594,10378"; a="277562974" X-IronPort-AV: E=Sophos;i="5.91,300,1647327600"; d="scan'208";a="277562974" Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 14 Jun 2022 16:33:22 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.91,300,1647327600"; d="scan'208";a="588756170" Received: from orsmsx605.amr.corp.intel.com ([10.22.229.18]) by fmsmga007.fm.intel.com with ESMTP; 14 Jun 2022 16:33:22 -0700 Received: from orsmsx609.amr.corp.intel.com (10.22.229.22) by ORSMSX605.amr.corp.intel.com (10.22.229.18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.27; Tue, 14 Jun 2022 16:33:22 -0700 Received: from ORSEDG601.ED.cps.intel.com (10.7.248.6) by orsmsx609.amr.corp.intel.com (10.22.229.22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.27 via Frontend Transport; Tue, 14 Jun 2022 16:33:22 -0700 Received: from NAM10-MW2-obe.outbound.protection.outlook.com (104.47.55.100) by edgegateway.intel.com (134.134.137.102) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2308.27; Tue, 14 Jun 2022 16:33:21 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=GzNzM3hHflnpB3965V0Qv1IfKzNTrVqCjWqizlaWQP4T/UX+BXDElIY4ATeyJNL0DGkfhZRaWrSe7kDxGFc1cAyt9gz3BgPLAXMwijBY56u3Yahn05e/A8Foo60ffL4lzskb85slwrv/KrOuGRftG6JfYqT7D5EgUKy7bpSziECdtQq5PQ4sR0ovux5S2xB0MYTc738HvalcSary2MzmO3hrYQK3DDPChskWJz0uKPf7In0va4HqBaMQP50AzbRVJFuxP0enzAA0KEcFnn85zudgbHr0XqhcREnJOGTXJnvPoaQ6Lq1YxrI3ZzZCvfqGGDbCl3fzk3o3Sq+nFJ/WeA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=drPS0ipK1HZNNpO+Kbjh78AkmkgYASBTMue/ZVHcvTg=; b=JWEUyefLHaYf/fofK1nK2izu5c7uHYTAZ5a6tChnpVsIN1yzx0DtraCh40zsw00A83KBbhueVHvuCmpvLLL4byS41aayOZwQ4/kxhFPAxRt5u0PTtFg+7D6tVkzVqLNkxGH0KzxvthU+s8YbHvDs1H/Go1udISGCmPq/iI3ZmUl+8lIjxMlPu3hZlLOKB/6hk8lDnNpnyEjjSKn+eho3pe1JmI6WqionndRHVNa8X/Aq2zdFsTlVDy2LpE4BvpSdgqC6h1RKKI/jPMWsje2TKmh41gcikdvXTvdDKGTTnzq7Fc8rUSBx1ruTpk8UWGduUHl57AVyQojkO+ElhaCJiA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Received: from DM4PR11MB6311.namprd11.prod.outlook.com (2603:10b6:8:a6::21) by SJ0PR11MB5166.namprd11.prod.outlook.com (2603:10b6:a03:2d8::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5332.13; Tue, 14 Jun 2022 23:33:20 +0000 Received: from DM4PR11MB6311.namprd11.prod.outlook.com ([fe80::d4e9:9ae1:29b2:90c]) by DM4PR11MB6311.namprd11.prod.outlook.com ([fe80::d4e9:9ae1:29b2:90c%5]) with mapi id 15.20.5332.020; Tue, 14 Jun 2022 23:33:20 +0000 Date: Tue, 14 Jun 2022 16:33:15 -0700 From: Ira Weiny To: Bagas Sanjaya CC: , Andrew Morton , "Matthew Wilcox (Oracle)" , "Fabio M. De Francesco" , Sebastian Andrzej Siewior , , Subject: Re: [PATCH] Documentation: highmem: Use literal block for *kmap_local_folio() example Message-ID: References: <20220614123115.522131-1-bagasdotme@gmail.com> Content-Type: text/plain; charset="us-ascii" Content-Disposition: inline In-Reply-To: <20220614123115.522131-1-bagasdotme@gmail.com> X-ClientProxiedBy: MW4PR03CA0356.namprd03.prod.outlook.com (2603:10b6:303:dc::31) To DM4PR11MB6311.namprd11.prod.outlook.com (2603:10b6:8:a6::21) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: cb77bea0-ad77-4efe-7357-08da4e5e4429 X-MS-TrafficTypeDiagnostic: SJ0PR11MB5166:EE_ X-Microsoft-Antispam-PRVS: X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: HhmPjoYXA6fsJqpIkhUFtmqUHA9XPQGbKwlCxlnCIv08RsQjHOHo8fv2HTyyT8q/upmLeZgXbG/CoxTuOkWlQ4h87yHjLe5iC6t0rIpG7BTwDm5tuzkZXB7BaxmKzBygqOA4dIUBfcQNtzWwIDRpJCHPZ8lcYJ2T695YetC0MrtjyeruVNkkwewfY4bpg+Z//9vq4E+Q3WpMRZ1l2hYHze4hoE2FO/43TxTkuyEVbcgp3878SrAUdNoab9Nyjm3XxYErxRIZTr3XEPQe87vOM+pQ508Seh/dH/RNQjnOgAU70C1BaS/TRVuMm+fEFTeDpJ0zdf0C2wabjTyJOQ6nDzBOUpAhEkTyKywI/yap5WQhYH26WuOPYYdZCixLlqPsqRrw01pDex/LYsgEGhTLPHUcO3/H8u6eL6Ii9UsdvZja8F8Y5w2Kg7ihOGiPURkt1QYxFZho5Kx8KuRkJuLP3QyvjwxuBIkVZKOU0z/7rUFHCvxuo6RdyzoBsXwJqvJlc6/m3fuBArtWrZfIY2AmLinFKYXYQHU/Iwy0HXHOSJ0G21gH1xvhZfc55Fg/hgFHmUFvFOcrFBohkJvPySGicw2ppNfi6a9yMznlN6RZGquSJslaCW2LexL25D0Ae2TTJz0CEzN+SqSBWsIO8ot2Qw== X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:DM4PR11MB6311.namprd11.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230016)(7916004)(366004)(26005)(316002)(186003)(9686003)(6512007)(83380400001)(44832011)(54906003)(66476007)(66556008)(66946007)(6506007)(6916009)(6666004)(4326008)(8676002)(2906002)(6486002)(5660300002)(38100700002)(86362001)(8936002)(508600001)(82960400001)(33716001);DIR:OUT;SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?NcnqLExjxuOEx5nMdT1FcvMlZNegdp058ELwZCttVEly7PdtjBbVT9cIVnCk?= =?us-ascii?Q?2yDAoywM6Np119WfZu+aUlK3vzZd1aTtgfbxS/MsMF5LodZqczG1NZ+mp61M?= =?us-ascii?Q?PS2h31CWNyRM0iW5mqZBEqciTEgHgkrjHGByyYdtWZXpOtOBQeMO1q1U5X3f?= =?us-ascii?Q?0r+lgTXgS8DQjr7wWkoasxZFpKxXGcXCnguW5N9zE12fZVMIH7GQaeDsJJIo?= =?us-ascii?Q?suiHEpL91Hqx7AXDME5vPrxeYy37WEmqoVC6yG7OJtgSk7J2AQeVgimMqHy+?= =?us-ascii?Q?uFZM3Lllkxs+vAugGDE7sPCGpL9HSfT/uu2SyN1ySi8Kg4og/GMoZ+g9rPnX?= =?us-ascii?Q?N8eHWW/doF0r2xXbQemdbmswSdOMYu3rXqjJkX3sT9WmLbdrAVtf0ST+HFlb?= =?us-ascii?Q?QwMnbdhCJ6p/flI/2Ql48pF0VCrHmK7gkMKrOlz1V5bzZjf4iGJU3a7YVMNb?= =?us-ascii?Q?OpvpWtrgiGRm0HU89B8DJX7E0uPMxYxz+I6/+mnJuWgJmSzzpxCwZbkc8R1m?= =?us-ascii?Q?DadAJmp8JocSiQc6a5cnYkhHdBRW4wFBGEpeyuJdtnWVN0TrhH3D/U3hdEdc?= =?us-ascii?Q?T31lC1fuS3aP8zGit8HbfkfBp96Wu+D5pBqde/9MfAYKt5wcwAoiaXJeIHCV?= =?us-ascii?Q?LRUVHD/+VoLFpQH6VuVA+H5W1kbNlTtNGMgA/U/tXPhIZsl/tvqvQbzI2ifd?= =?us-ascii?Q?U5URoBSx4HOPC2gcEIqoOFUq2yyouXpHNZ1TePDuHXZu0zdLIEwrbVa3oar0?= =?us-ascii?Q?A/l0TkWxPLsO0Ise8EtxYvH5dU4QKIL977jV5f0x0XSEQKMv0kqDIiTFxmLC?= =?us-ascii?Q?dJ5hmGCvXCm1OSG8SgsMMHIXZbilDIORZ8FUrTGabqPYZDvt6M0fnfJ/zErh?= =?us-ascii?Q?LIgnF2/kOoXrQovRwRcpbZACjfo7ZoIoEzlKkDYZeYZldsNmwnuF08G+Qg8h?= =?us-ascii?Q?Jue41lt2fk7PJxsa3kPsWJiADLy+B8LyAoMuuJqw46Xaekd3vVcOy7lHvVjd?= =?us-ascii?Q?WAd2BG2DM//j5p8g5MN2+1ZEYNQBoB3LhxGz3PKqHstbclGDG9WLIwsd5CUS?= =?us-ascii?Q?g8QjVPMP0QBRdPy+v8OjKSp73/yu4bVv0OMX2Njvf3q9z3jTeN9BLx9aEr5E?= =?us-ascii?Q?uDfxXkRwHB6orh5oNKtNlETsSopaSa6LPN8gZ3Q7cfp5ou5YTdG2loIPkhNC?= =?us-ascii?Q?WAE6QoOQ8yWNSAV+cpjWmVeBo9070b5CJN/QFpUcwqBNcLMY3DGF6NBRUFBt?= =?us-ascii?Q?/J5N9vNyR92ji0IXPGLuR2HtEiH4+gS5lmXVfWZTLQ9EqWlqUcPQpnl3WpWF?= =?us-ascii?Q?m4l+8GXUk0a0hQ9JaLzgVzf27eSQQgFRzENvOAPHOfNCLNGKWUP1KBSOtV91?= =?us-ascii?Q?AsXlu8IqRZhIy3RO50qIVFNjzMVuYYbA+OsPoaHDa5oq4FXGmfFIZNAimL53?= =?us-ascii?Q?IUYAoyBw7w3y/xfTchZA6DyQglqwLLnGYw5FhiwzYbp7joCmz3sysZ/qBIWr?= =?us-ascii?Q?Bzc5GhERUkQ5vu9kqxTqgHo/D+BLxLB/l599/O909QSOaxUsqea3VZ3dT7cF?= =?us-ascii?Q?z5Z3QMH34v/EI+GGsX9g5Yl1qJq2nFXd7hBp0AqMepAyTNVIQRn9V52a5Fp2?= =?us-ascii?Q?keKMkIx2V/YjoPmHQbSuT30vxXldo6hT8QFykCpFBsGvKrOwcpwKKeI04bgK?= =?us-ascii?Q?qtkRu4whfPqCxszV1GDybuW+GPSmEtN2nreWq0sx0rqCjcK6sVpu5btnuGTl?= =?us-ascii?Q?TOGyK4XY4Q=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: cb77bea0-ad77-4efe-7357-08da4e5e4429 X-MS-Exchange-CrossTenant-AuthSource: DM4PR11MB6311.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Jun 2022 23:33:20.5055 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: BBXnsWGLpKgijUuR9I4gzNLdN5Y5s1SIPGiV3PqPFZbryb1vGlpugz6daS1eiLgbqJnVeXU+uLs2ufj5fjiCMA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB5166 X-OriginatorOrg: intel.com ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655249607; 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=drPS0ipK1HZNNpO+Kbjh78AkmkgYASBTMue/ZVHcvTg=; b=iwoIgGY4QaMtkp0Twqy3RWOwL13bO+4VmrV9zWiSExtnEHp4XdgJJGM57Gu3wwHi0d5kLO NR0+TWzjy2x8gKOSGcn00Gitq2abld7/zWu28envjt+Oh9/PE7NgKIKkruCAWL7cgvZqRn nfDD3aUlwKJtUBP/O/szOocXTOGsgAQ= ARC-Authentication-Results: i=2; imf20.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b=DBL46F6C; spf=none (imf20.hostedemail.com: domain of ira.weiny@intel.com has no SPF policy when checking 192.55.52.120) smtp.mailfrom=ira.weiny@intel.com; dmarc=pass (policy=none) header.from=intel.com; arc=reject ("signature check failed: fail, {[1] = sig:microsoft.com:reject}") ARC-Seal: i=2; s=arc-20220608; d=hostedemail.com; t=1655249607; a=rsa-sha256; cv=fail; b=XykN3UZDBEBB8b7rTKbEpjBSZzCsu8kXK1rgkVZEduH4q0tlpHY3R5NYjfXxSIhpf8sLj+ h4GQXV6+rH+IGtBAyHHwBb+aOgA5QPq2Lr3h0d7GLuwJSZ/FLzxcQIk5uRfhK2JbvEWj/c ZHf9/jg8Yr0IqEowtGFQmaeJV9YfVUc= X-Stat-Signature: 7ghjnq8oaywaj3kwn3a941uj7ybzia51 X-Rspamd-Queue-Id: 554FE1C0093 X-Rspamd-Server: rspam11 X-Rspam-User: Authentication-Results: imf20.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b=DBL46F6C; spf=none (imf20.hostedemail.com: domain of ira.weiny@intel.com has no SPF policy when checking 192.55.52.120) smtp.mailfrom=ira.weiny@intel.com; dmarc=pass (policy=none) header.from=intel.com; arc=reject ("signature check failed: fail, {[1] = sig:microsoft.com:reject}") X-HE-Tag: 1655249605-342961 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 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. Nice catch. > > These warnings above are due to comments in code example of > *kmap_local_folio() are enclosed by double dash (--) instead of prefixed As Willy said these are for kmap_atomic() > with comment symbol (#). I'd rather see '//' used since this is C code and it makes the output consistent with C syntax rather than mixing shell and C. Thanks for the fixup! Ira diff --git a/include/linux/highmem.h b/include/linux/highmem.h index a244e0345c87..56d6a0196534 100644 --- a/include/linux/highmem.h +++ b/include/linux/highmem.h @@ -151,16 +151,16 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset); * example a page in the pagecache. The API has two functions, and they * can be used in a manner similar to the following:: * - * # Find the page of interest. + * // Find the page of interest. * struct page *page = find_get_page(mapping, offset); * - * # Gain access to the contents of that page. + * // Gain access to the contents of that page. * void *vaddr = kmap_atomic(page); * - * # Do something to the contents of that page. + * // Do something to the contents of that page. * memset(vaddr, 0, PAGE_SIZE); * - * # Unmap that page. + * // Unmap that page. * kunmap_atomic(vaddr); * * Note that the kunmap_atomic() call takes the result of the kmap_atomic() > > 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 >