Re: [PATCH v2 2/3] Documentation: Remove :manpage: from non-existing man pages

[Petr Vorel <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``.

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.

> (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