From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@kernel.org>
X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on
	aws-us-west-2-korg-lkml-1.web.codeaurora.org
X-Spam-Level: 
X-Spam-Status: No, score=-5.8 required=3.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0
Received: from mail.kernel.org (mail.kernel.org [198.145.29.99])
	by smtp.lore.kernel.org (Postfix) with ESMTP id 22030C433E4
	for <linux-kernel@archiver.kernel.org>; Wed, 24 Mar 2021 17:13:29 +0000 (UTC)
Received: from vger.kernel.org (vger.kernel.org [23.128.96.18])
	by mail.kernel.org (Postfix) with ESMTP id F1EB361A22
	for <linux-kernel@archiver.kernel.org>; Wed, 24 Mar 2021 17:13:28 +0000 (UTC)
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S237181AbhCXRM5 (ORCPT <rfc822;linux-kernel@archiver.kernel.org>);
        Wed, 24 Mar 2021 13:12:57 -0400
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57366 "EHLO
        lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
        with ESMTP id S237143AbhCXRMj (ORCPT
        <rfc822;linux-kernel@vger.kernel.org>);
        Wed, 24 Mar 2021 13:12:39 -0400
Received: from ms.lwn.net (ms.lwn.net [IPv6:2600:3c01:e000:3a1::42])
        by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0EEE9C061763;
        Wed, 24 Mar 2021 10:12:38 -0700 (PDT)
Received: from localhost (unknown [IPv6:2601:281:8300:104d::5f6])
        (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
        (No client certificate requested)
        by ms.lwn.net (Postfix) with ESMTPSA id 4156A380;
        Wed, 24 Mar 2021 17:12:38 +0000 (UTC)
DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 4156A380
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203;
        t=1616605958; bh=BlmsETjY3d55KM0BBCtU0LhNFCRLCNUIeVyS6+Soa88=;
        h=From:To:Cc:Subject:In-Reply-To:References:Date:From;
        b=VeiE2kfViAVhaef6m1712dyj5J7l5sbH2WPyqgc+Z04ilYKfeL/tUXhqtx4IE3KN3
         TcU1gsha0XOc7QparWNJNtX/6z2TBzyWJJxwgZhWzB0tFJI/YgYPR72mtw7jJDqmfp
         kNRM38dr4NuBy/q3LcBh0J6aS3wUqiQ2e3ACgNMxAUCJHyLB0ey2e7l7dVtZt/acxt
         rofNYG5pXW7FKD0BzTUiy1u2ifjapG1Fc8bLPDRGF4qevL92gZfnD+lydeXcOmOXtQ
         3wiC7bBPNkZT/94Jkgf9K2BeQ6vwTcnGF16PA7lfn7e2b0dFCl0YvU5+HKcey6Rgsr
         cKn7D4vH2xrrA==
From:   Jonathan Corbet <corbet@lwn.net>
To:     Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Cezary Rojewski <cezary.rojewski@intel.com>,
        Finn Behrens <me@kloenk.de>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Suzuki K Poulose <suzuki.poulose@arm.com>,
        linux-kernel@vger.kernel.org,
        Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH] script: get_abi.pl: escape "<" and ">" characters
In-Reply-To: <e02449ee86d89cd45313627b52500a6892ea37ae.1616605512.git.mchehab+huawei@kernel.org>
References: <20210317142238.228fb1e8@coco.lan>
 <e02449ee86d89cd45313627b52500a6892ea37ae.1616605512.git.mchehab+huawei@kernel.org>
Date:   Wed, 24 Mar 2021 11:12:37 -0600
Message-ID: <87sg4kcw6y.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> After merging the akpm-current tree, today's linux-next build (htmldocs)
> produced this warning:
>
> 	Documentation/ABI/testing/sysfs-kernel-mm-cma:2: WARNING: Inline interpreted text or phrase reference start-string without end-string.
>
> Introduced by commit 439d477342a3 ("mm: cma: support sysfs")
>
> As pointed by Jonathan, the problem is this text in
> sysfs-kernel-mm-cma:
>
> 	Each CMA heap subdirectory (that is, each
> 	/sys/kernel/mm/cma/<cma-heap-name> directory) contains the
> 	following items:
>
> Is not parsed well, becase the major/minor signs need to be
> escaped, when converted into cross-references.

Sorry, I kind of dropped the ball on this, and everything else really; a
bit of a challenging time here.

This makes the warning go away, but I have to wonder if it's the right
fix - wouldn't it be better to avoid trying to create a cross-reference
entirely in cases where it clearly won't work?  Or am I missing
something here?

Thanks,

jon