Re: reviving an old suggestion about YP docs markup


Ross Burton
 

On Tue, 11 Feb 2020 at 11:13, rpjday@crashcourse.ca
<rpjday@crashcourse.ca> wrote:
first, yes, if something is a filename, then <filename> is the
obvious markup.

on the other hand, variables should properly be marked up as
<variable>, which they currently aren't. a good example is in the
reference manual, the variables, where glossary definitions all use
the <filename> markup for variables. again, it may make no difference
in the ultimate rendering to something as trivial as HTML but, some
day, it will be useful to be able to render things differently
depending on the choice of output.
I'd say fine, patches welcome. Maybe Scott chose a subset of Docbook
to ease the formatting? Either way, I can't see a good argument
*against* using a broader set of tags. At some point you could have
some lint tooling to verify that every <variable> is in the variable
index, for example.

Ross

Join yocto@lists.yoctoproject.org to automatically receive all group messages.