From: Jonathan Corbet <corbet@lwn.net>
To: "Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Nícolas F. R. A. Prado" <n@nfraprado.net>
Cc: linux-doc@vger.kernel.org, "Matthew Wilcox" <willy@infradead.org>,
linux-kernel@vger.kernel.org,
"André Almeida" <andrealmeid@collabora.com>,
~lkcamp/patches@lists.sr.ht
Subject: Re: [RFC PATCH 1/2] docs: automarkup.py: Add literal markup of known constants
Date: Sun, 13 Jun 2021 17:13:45 -0600 [thread overview]
Message-ID: <874ke1bbo6.fsf@meer.lwn.net> (raw)
In-Reply-To: <20210609101102.2a97b2dd@coco.lan>
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
next prev parent reply other threads:[~2021-06-13 23:13 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-09 1:43 [RFC PATCH 0/2] " Nícolas F. R. A. Prado
2021-06-09 1:43 ` [RFC PATCH 1/2] " Nícolas F. R. A. Prado
2021-06-09 8:11 ` Mauro Carvalho Chehab
2021-06-13 23:13 ` Jonathan Corbet [this message]
2021-06-14 7:27 ` Mauro Carvalho Chehab
2021-06-09 1:43 ` [RFC PATCH 2/2] XArray: Remove literal markup from " Nícolas F. R. A. Prado
2021-06-09 7:50 ` Mauro Carvalho Chehab
2021-06-09 7:45 ` [RFC PATCH 0/2] docs: automarkup.py: Add literal markup of " Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=874ke1bbo6.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=andrealmeid@collabora.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=n@nfraprado.net \
--cc=willy@infradead.org \
--cc=~lkcamp/patches@lists.sr.ht \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®