Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        =?utf-8?Q?N=C3=ADco?= =?utf-8?Q?las_F=2E_R=2E_A=2E_Prado?= 
        <n@nfraprado.net>
Cc:     linux-doc@vger.kernel.org, Matthew Wilcox <willy@infradead.org>,
        linux-kernel@vger.kernel.org,
        =?utf-8?Q?And?= =?utf-8?Q?r=C3=A9?= Almeida 
        <andrealmeid@collabora.com>, ~lkcamp/patches@lists.sr.ht
Subject: Re: [RFC PATCH 1/2] docs: automarkup.py: Add literal markup of
 known constants
In-Reply-To: <20210609101102.2a97b2dd@coco.lan>
References: <20210609014308.234027-1-n@nfraprado.net>
 <20210609014308.234027-2-n@nfraprado.net>
 <20210609101102.2a97b2dd@coco.lan>
Date:   Sun, 13 Jun 2021 17:13:45 -0600
Message-ID: <874ke1bbo6.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

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

> It sounds a nightmare to maintain this by hand, as a list of used
> constants will only grow. IMO, an explicit list should be kept only to
> with the absolute minimum, e.g. for highly-used constants that aren't
> error codes nor FOO_BAR. The only case that occurs to me that fits 
> on this rule is 'NULL'.

This is my concern as well.  It seems to me like we would always have a
situation where some constants are magically marked up and others
aren't, and people will spend a lot of time trying to figure out why.

Might it not be better to just adopt the convention that these constants
don't need to be marked up at all?  NULL is entirely understandable even
when presented in a proportional font.  Seems like maybe the best of
both worlds?

Thanks,

jon