Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 14 Jun 2022 16:33:15 -0700
From:   Ira Weiny <ira.weiny@intel.com>
To:     Bagas Sanjaya <bagasdotme@gmail.com>
CC:     <linux-doc@vger.kernel.org>,
        Andrew Morton <akpm@linux-foundation.org>,
        "Matthew Wilcox (Oracle)" <willy@infradead.org>,
        "Fabio M. De Francesco" <fmdefrancesco@gmail.com>,
        Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
        <linux-mm@kvack.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] Documentation: highmem: Use literal block for
 *kmap_local_folio() example
Message-ID: <Yqkauy1EmrBlUz1c@iweiny-desk3>
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>
MIME-Version: 1.0
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
X-Spam-Status: No, score=-8.3 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI,
        SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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 <akpm@linux-foundation.org>
> Cc: Ira Weiny <ira.weiny@intel.com>
> Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>
> Cc: "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
> Cc: linux-mm@kvack.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <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..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
>