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:   Mon, 20 Jun 2022 14:44:04 -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 v3] Documentation: highmem: Use literal block for code
 example in highmem.h comment
Message-ID: <YrDqJB0J1PT8VlwA@iweiny-desk3>
References: <20220620083649.18172-1-bagasdotme@gmail.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20220620083649.18172-1-bagasdotme@gmail.com>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?TYWY6HjydsHKssYwSn1MtYlz39v0UvYksFuZHv+lJI+i2DPGfwOHCrp7bfPU?=
 =?us-ascii?Q?iO3RntFzC5KH8j1MDjkrx2yiQKdtO/e7EMI3XSKmzxtXo8mVX9z9MiCW6HaE?=
 =?us-ascii?Q?QkIbl3zYjMPP8R7Prg9Zdz79ATbYG7QQrSo4Be1HOhEqQC6T4eeB9iNUz6lw?=
 =?us-ascii?Q?XQgmnivZe/VEEcvHBewWO2r+O9P2EWFe1EV2FawgfNyQZFOQ9dxGih3kEPPj?=
 =?us-ascii?Q?c7Gar/45LduL+P11aN1GTRFL9alV38ZMyXbug6XRiTI0AwLGxTZ1Cv5OnOsO?=
 =?us-ascii?Q?9AHzysjMwm133eQsk7xxibQ7cGMBtFWFwZLjUDAfrxpZR2Gp5LQL1IYTP8Wo?=
 =?us-ascii?Q?g+A+Crb2tj+mCYEUOwMu6peR0LkDatw4r101ceQnxP6z5H8AnhGZCzcUh9Xs?=
 =?us-ascii?Q?W08X0hleOH5/OPWXyT3nZ5cn539BO5Oa2ZpdTiUDFa2KQ/Bv5qfOzqemVDA9?=
 =?us-ascii?Q?NwOio9BLCBBeXCSSQC3g8HP/KQgNZIDZSr4XJrgVXUKQEjpIOhZ5H3TIuPVs?=
 =?us-ascii?Q?0Hq+Qz7vwfGmY1OUfmzswmhbDSuXY+Hs3DFIP04CMqvmRVRZWljN6Me8CUFh?=
 =?us-ascii?Q?uyaUKzdrAhx9KmDApd+SNHQVynDeXIO2Ltsg+130bVqBw8c9exYQTaDwMR7S?=
 =?us-ascii?Q?AFdvGBdv+MsUTRnmCOMlQ5PVqEe20y+bZCrmBf3N1fjgwUK9aoSBCerkjo/7?=
 =?us-ascii?Q?UD2ycxNMx8WvmYGTmCjZbqoBbbuthD2hDGvvrqWIp/fwbp/UNe0ClU81CXTv?=
 =?us-ascii?Q?vZzwmL+J0ZR7l2wDpSPLvGhd5/UQFpz/2wfa6FYzY9zAMNo6r3eIUbHcwp1t?=
 =?us-ascii?Q?xPxkEmNPc2RV2pylinJ1A6Fev5k5B+ObWqcChaPN8fVWrL18C7oMSLyJRcPy?=
 =?us-ascii?Q?/aE/Wpgi9eXjQPsbCvahaZ9wC7udU+lb4S97CvHHlNrJQWqTfFHsx8Sn4um/?=
 =?us-ascii?Q?O66yU9NVEFQ47Eh4xCWtIKeGEVb6oV3Dh4Wa60hkEA3BwZA7kk++9f0lSfJX?=
 =?us-ascii?Q?a1pniY5sIvAnSo2nkMlz/soShr0zniMUPBoGocYjVJFeXJM8oCTzgU4z7mWF?=
 =?us-ascii?Q?hfYlU9Wm21XjurtxulTDFF2UAii0vd9wug2ubZc0f81DHI0hoxs/S5+B8j/T?=
 =?us-ascii?Q?CYEa+gcb2WO7r/YJRDKRvLpRhI1mHSQikIsvZcSlOVOP8G0K8LOwRgdQ+dcF?=
 =?us-ascii?Q?jZS4Kx0ZtDQyqE+4L7zxxgAkN7DYbYkMdRZBaaJLkV/296XkbvKZQTIyeMzc?=
 =?us-ascii?Q?TnryWltPumtHb8ExfSrsKybgobXJpCTAN/L0eSJoW32lO62C7djylXBcp3Be?=
 =?us-ascii?Q?p3xK2mMbmxjaKVOmy/9kmzK+RU7oOyyhW5LyjJCgPc5S1u6bIUlvKlVsyNfl?=
 =?us-ascii?Q?hZI9qmyyt0rEnoq5uqNUWOujPHitn3FFVVNYBbzh+sNxOcZXgpfA1UT2JgLJ?=
 =?us-ascii?Q?Hh83GxfKp5O40K5X5xaItpFUzWH7JmPh95nYAvS926mQv5lI5U06vo6+CDZP?=
 =?us-ascii?Q?0BePx6aQiaevwtjyrTCyLdOHhKVpKXJ7ivQ46NtK1u9nLdgD/rxZm1KDCPQI?=
 =?us-ascii?Q?8EQKqGDXRRry3ir+u4MAM1EERWR8L+p4QEtvRzZ8NT02j5B5NkrJ0AWXpt+S?=
 =?us-ascii?Q?M6x6OWfkZCT3/ReCUlvJ0wfQfQv/Id/Mrx6hMRVt1ALozGHCgl5hLTxgXgsz?=
 =?us-ascii?Q?VPAswh146Yc9SVovXIyjJAQtBsM/FNC+QAIjyf1x0LnSfATs4wF18Zw+PQbC?=
 =?us-ascii?Q?dVlyl/kTUA=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 03c2abe6-c29e-4ad8-2750-08da5306010e
X-MS-Exchange-CrossTenant-AuthSource: DM4PR11MB6311.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Jun 2022 21:44:08.0991
 (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: Q5R1yDyag70sdeRQRhWtkgw8SsrZmTkp3TF6YDzOems91w/FnVEMODqrqgbgtndNaJdw9kFg57e/Cgj+3AOSpA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR11MB1355
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-7.7 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI,
        RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,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 Mon, Jun 20, 2022 at 03:36:49PM +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 at the
> mentioned lines above are enclosed by double dash (--), which confuses
> Sphinx as inline markup delimiters instead.
> 
> Fix these warnings by indenting the code example with literal block
> indentation and prefixing comments inside the example with C comment
> symbol (#).

"//"?

Frankly I'd just drop "(#)".

Perhaps:

... indentation and making the comments C comments.

Ira

> 
> 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>
> ---
>  Changes since v2 [1]:
>    - Rebase on v5.19-rc3
>    - Don't mention any functions
> 
>  [1]: https://lore.kernel.org/linux-doc/20220615101509.516520-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: a111daf0c53ae91e71fd2bfe7497862d14132e3e
> -- 
> An old man doll... just what I always wanted! - Clara
> 
>