From: | ilmari(at)ilmari(dot)org (Dagfinn Ilmari Mannsåker ) |
---|---|
To: | Alvaro Herrera <alvherre(at)2ndquadrant(dot)com> |
Cc: | PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org> |
Subject: | Re: <xref> vs <command> formatting in the docs |
Date: | 2020-06-21 16:57:45 |
Message-ID: | 87lfkgnypi.fsf@wibble.ilmari.org |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-hackers |
Alvaro Herrera <alvherre(at)2ndquadrant(dot)com> writes:
> On 2020-Jun-21, Dagfinn Ilmari Mannsåker wrote:
>
>> While looking at making more <command>SQL</command> into links, I
>> noticed that <xref> loses the monospace formatting of <command>, and
>> can't itself be wrapped in <command>.
>
> Ouch.
>
>> By some trial and error I found that putting <command> inside the
>> <refentrytitle> tag propagates the formatting to the <xref> contents.
>> We already do this with <application> for (most of) the client and
>> server applications. Is this something we want to do consistently for
>> both?
>
> Looking at the ones that use <application>, it looks like manpages are
> not damaged, so +1.
Attached are two patches: the first adds the missing <application> tags,
the second adds <command> to all the SQL commands (specifically anything
with <manvolnum>7</manvolnum>).
I'll add it to the commitfest.
- ilmari
--
- Twitter seems more influential [than blogs] in the 'gets reported in
the mainstream press' sense at least. - Matt McLeod
- That'd be because the content of a tweet is easier to condense down
to a mainstream media article. - Calle Dybedahl
Attachment | Content-Type | Size |
---|---|---|
0001-Add-missing-application-tags-in-application-doc-refe.patch | text/x-diff | 3.7 KB |
0002-Add-command-to-SQL-command-refentrytitle-tags.patch | text/x-diff | 93.4 KB |
From | Date | Subject | |
---|---|---|---|
Next Message | Jonathan S. Katz | 2020-06-21 17:45:36 | Re: SIGSEGV from START_REPLICATION 0/XXXXXXX in XLogSendPhysical () at walsender.c:2762 |
Previous Message | Chapman Flack | 2020-06-21 15:46:28 | Re: <application> vs <command> for command line tools in the docs |