public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: Petr Vorel <pvorel@suse.cz>
Cc: Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org,  Michael Kerrisk <mtk@man7.org>,
	man-pages@man7.org
Subject: Re: [PATCH v2 2/3] Documentation: Remove :manpage: from non-existing man pages
Date: Tue, 13 Jan 2026 12:49:56 +0100	[thread overview]
Message-ID: <aWYwzD82rhg6CZHV@devuan> (raw)
In-Reply-To: <20260113110053.GA306468@pevik>

[-- Attachment #1: Type: text/plain, Size: 1605 bytes --]

Hi Petr,

On Tue, Jan 13, 2026 at 12:00:53PM +0100, Petr Vorel wrote:
[...]
> > > -If your new :manpage:`xyzzy(2)` system call does return a new file descriptor,
> > > +If your new `xyzzy(2)` system call does return a new file descriptor,
> 
> > Here, once again, you're retaining the backticks.  If we need to mark up
> > those references at all, they should be ``literal``.
> 
> I'm sorry to keep the same mistake. BTW I did not notice because both real man
> pages a) without manpages_url:
> 
> <em class="manpage">read(2)</em>
> 
> b) with manpages_url:
> 
> <em class="manpage">
> <a class="manpage reference external" href="https://man7.org/linux/man-pages/man8/auditctl.8.html">auditctl(8)</a>
> </em>
> 
> don't have specified CSS. And because my browser default has font-style: italic
> for <em>, I don't see any difference for :manpage:`read(2)` and `read(2)`.
> 
> BTW I'll add in v3 CSS font-family: ..., monospace for manpages.

FWIW, in the Linux man-pages project, we currently use bold with
proportional font for manual page references, and will soon change to
italics with proportional font.  We don't use monospace (when formatting
in PDF, of course).


Have a lovely day!
Alex

> > (If you simply remove the backticks, you might run into conflict with
> > automarkup, though I *think* that the section number will evade its
> > regexp).
> 
> In my local build plain fxyzzy(3) without backticks works. I slightly prefer to
> not use double ``.
> 
> Kind regards,
> Petr
> 
> > Thanks,
> 
> > jon

-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2026-01-13 11:50 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-11 23:35 [PATCH v2 0/3] Documentation: Link man pages to https://man7.org/ Petr Vorel
2026-01-11 23:35 ` [PATCH v2 1/3] Documentation: sp_SP: Add missing man page section Petr Vorel
2026-01-12  0:00   ` Alejandro Colomar
2026-01-12 16:39   ` Jonathan Corbet
2026-01-11 23:35 ` [PATCH v2 2/3] Documentation: Remove :manpage: from non-existing man pages Petr Vorel
2026-01-12  0:00   ` Alejandro Colomar
2026-01-12 16:41   ` Jonathan Corbet
2026-01-13 11:00     ` Petr Vorel
2026-01-13 11:49       ` Alejandro Colomar [this message]
2026-01-11 23:35 ` [PATCH v2 3/3] Documentation: Link man pages to https://man7.org/ Petr Vorel
2026-01-11 23:58   ` Alejandro Colomar

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=aWYwzD82rhg6CZHV@devuan \
    --to=alx@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=man-pages@man7.org \
    --cc=mtk@man7.org \
    --cc=pvorel@suse.cz \
    /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