public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Petr Vorel <pvorel@suse.cz>
To: Alejandro Colomar <alx@kernel.org>
Cc: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Michael Kerrisk <mtk@man7.org>,
	man-pages@man7.org
Subject: Re: [PATCH 1/1] Documentation: Link man pages to https://man7.org/
Date: Mon, 12 Jan 2026 00:29:15 +0100	[thread overview]
Message-ID: <20260111232915.GC170559@pevik> (raw)
In-Reply-To: <aWQwVdF3ea1hmgjG@devuan>

> Hi Petr,

> On Mon, Jan 12, 2026 at 12:06:39AM +0100, Petr Vorel wrote:
> > > I wonder if this could be implemented in a way that wouldn't need
> > > changing any lines of documentation.

> > Good point. Yes, there is sphinx way to do it as one liner (no need for any
> > python scripting):
> > https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url

> > But the problem is that it creates links also for non-existing man pages
> > (xyzzy(2), xyzzyat(2), fxyzzy(3)) in adding-syscalls.rst. I'll convert them not
> > being man pages.

> Maybe we could solve that.  Do you have a list of undocumented syscalls?
> We could quickly add small manual pages for all of them, documenting
> only the SYNOPSIS.

> The rest of the documentation could come later, but some documentation
> would be better than no documentation.

> What do you think?

IMHO these xyzzy(2), xyzzyat(2), fxyzzy(3) are examples for new syscalls
(like "foo" and "bar" or example.org). I don't think it'd be good to create a
real man page for them. Instead I just remove :manpage: from them.

Kind regards,
Petr


> Have a lovely night!
> Alex


> > Kind regards,
> > Petr

  reply	other threads:[~2026-01-11 23:29 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-09 18:30 [PATCH 1/1] Documentation: Link man pages to https://man7.org/ Petr Vorel
2026-01-09 20:52 ` Alejandro Colomar
2026-01-11 23:06   ` Petr Vorel
2026-01-11 23:24     ` Alejandro Colomar
2026-01-11 23:29       ` Petr Vorel [this message]
2026-01-11 23:53         ` Alejandro Colomar
2026-01-14 19:53   ` Askar Safin
2026-01-14 20:03     ` Alejandro Colomar
2026-01-15  6:40       ` Petr Vorel
2026-01-15  9:15         ` Michael Kerrisk (man7.org)
2026-01-15 15:10         ` Jonathan Corbet

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