Thread: vs for command line tools in the docs

vs for command line tools in the docs

From
ilmari@ilmari.org (Dagfinn Ilmari Mannsåker)
Date:
Hi Hackers,

While I was looking at linkifying SQL commands in the system catalog
docs, I noticed that catalog.sgml uses the <command> tag to refer to
initdb, while I'd expected it to use <application>.

Looking for patterns, I grepped for the two tags with contents
consisting only of lower-case letters, numbers, hyphens and underscores,
to restrict it to things that look like shell command names, not SQL
commands or full command lines.  When referring to binaries shipped with
postgres itself, <application> is by far the most common, except for
initdb, postgres, ecpg, pg_ctl, pg_resetwal, and pg_config.  For
external programs it's more of a mix, but overall there are more than
twice as many instances of <application> of this form than of <command>.

I'm not proposing going throuhgh all 1500+ instances in one fell swoop,
but some consistency (and a policy going forward) would be nice.

- ilmari
-- 
"A disappointingly low fraction of the human race is,
 at any given time, on fire." - Stig Sandbeck Mathisen



Re: vs for command line tools in the docs

From
Tom Lane
Date:
ilmari@ilmari.org (Dagfinn Ilmari =?utf-8?Q?Manns=C3=A5ker?=) writes:
> While I was looking at linkifying SQL commands in the system catalog
> docs, I noticed that catalog.sgml uses the <command> tag to refer to
> initdb, while I'd expected it to use <application>.

I agree that the latter is what we generally use.

            regards, tom lane



Re: vs for command line tools in the docs

From
Chapman Flack
Date:
On 06/21/20 11:16, Tom Lane wrote:
> ilmari@ilmari.org (Dagfinn Ilmari =?utf-8?Q?Manns=C3=A5ker?=) writes:
>> docs, I noticed that catalog.sgml uses the <command> tag to refer to
>> initdb, while I'd expected it to use <application>.
> 
> I agree that the latter is what we generally use.

'The latter' is <command> in the Subject:, <application> in the body....

Regards,
-Chap