public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Petr Vorel <pvorel@suse.cz>, linux-doc@vger.kernel.org
Cc: Petr Vorel <pvorel@suse.cz>, Michael Kerrisk <mtk@man7.org>,
	Alejandro Colomar <alx@kernel.org>,
	man-pages@man7.org
Subject: Re: [PATCH v2 2/3] Documentation: Remove :manpage: from non-existing man pages
Date: Mon, 12 Jan 2026 09:41:11 -0700	[thread overview]
Message-ID: <877btm2388.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20260111233534.183272-3-pvorel@suse.cz>

Petr Vorel <pvorel@suse.cz> writes:

> Removing :manpage: from non-existing man pages (xyzzy(2), xyzzyat(2),
> fxyzzy(3) in adding-syscalls.rst, including translations) prevent
> adding link to nonexisting man pages when using manpages_url in next
> commit.
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> New in v2.
>
>  Documentation/process/adding-syscalls.rst          | 14 +++++++-------
>  .../translations/it_IT/process/adding-syscalls.rst | 14 +++++++-------
>  .../translations/sp_SP/process/adding-syscalls.rst | 14 +++++++-------
>  3 files changed, 21 insertions(+), 21 deletions(-)
>
> diff --git a/Documentation/process/adding-syscalls.rst b/Documentation/process/adding-syscalls.rst
> index fc0b0bbcd34df..1f61d0b114120 100644
> --- a/Documentation/process/adding-syscalls.rst
> +++ b/Documentation/process/adding-syscalls.rst
> @@ -111,7 +111,7 @@ should use a file descriptor as the handle for that object -- don't invent a
>  new type of userspace object handle when the kernel already has mechanisms and
>  well-defined semantics for using file descriptors.
>  
> -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``.

(If you simply remove the backticks, you might run into conflict with
automarkup, though I *think* that the section number will evade its
regexp).

Thanks,

jon

  parent reply	other threads:[~2026-01-12 16:41 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 [this message]
2026-01-13 11:00     ` Petr Vorel
2026-01-13 11:49       ` Alejandro Colomar
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=877btm2388.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=alx@kernel.org \
    --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