From: Alejandro Colomar <alx.manpages@gmail.com>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>,
Ingo Schwarze <schwarze@usta.de>,
Colin Watson <cjwatson@debian.org>
Cc: linux-man@vger.kernel.org,
"Mario Blättermann" <mario.blaettermann@gmail.com>,
"Marcos Fouces" <marcos@debian.org>,
"Dr. Tobias Quathamer" <toddy@debian.org>,
"Helge Kreutzmann" <debian@helgefjell.de>
Subject: Re: Conflicting alias for some man pages
Date: Fri, 9 Dec 2022 19:53:44 +0100 [thread overview]
Message-ID: <4aaf7fb4-8d4b-e050-b376-9120d8c328ac@gmail.com> (raw)
In-Reply-To: <1ac0914d-72f8-654b-c6b0-6be68f26a598@gmail.com>
[-- Attachment #1.1: Type: text/plain, Size: 4152 bytes --]
Hi Branden, Ingo, and Colin,
On 12/3/22 17:36, Alejandro Colomar wrote:
> Hi Helge!
>
> On 12/3/22 15:01, Helge Kreutzmann wrote:
>> Hello Alejandro,
>> hello Michael,
>> short description:
>> Please remove duplicates in the alias (alternative) names of man
>> pages. (List of known examples at the end).
>>
>> Long description:
>>
>> I support Mario in maintaining the translation of manpages
>> (manpages-l10n) and I'm also the Debian maintainer of manpages-l10n.
>>
>> Some man pages describe multiple, related commands, functions,
>> interfaces, …. In the english case, man automatically figures this
>> out, so that you can call the man page under each name without any
>> further manual configuration (at least in Debian, where I tried it).
>>
>> Up to recently, manpages-l10n shipped the translated main man page,
>> e.g. if
>> command1.1
>> contains
>>
>> NAME
>> commmand1, command2 - Description
>>
>> manpages-l10n shipped e.g. de/man1/command1.1
>>
>> Under Debian then the following happend:
>> If I ran
>> man command1
>> I saw the German version, however, with
>> man command2
>> I got the english version, if it exists, otherwise the German version.
>>
>> The maintainer of man requested that I provide explicit symlinks for
>> these man pages[1], which I implemented for the last upload of
>> manpages-l10n to Debian.
>>
>> While doing this, I noticed that some alternative names (aliases)
>> where used multiple times. This caused link creation to fail (for the
>> second and further occurences) and should also cause "random"
>> behaviour for the english pages (as man could select from several
>> pages).
>>
>> Could you remove these duplicates in your next upload?
>>
>> I found the following duplicates, I did not do an extensive search:
>> ===================================================================
>> rindex - Both in index.3 and in string.3
>> strncasecmp - Both in strcasecmp.3 and in string.3
>> strncat - Both in strcat.3 and in string.3
>> strncmp - Both in strcmp.3 and in string.3
>> strncpy - Both in strcpy.3 and in string.3
>> __fpurge - Both in fpurge.3 and in stdio_ext.3
>> strcspn - Both in strspn.3 and in string.3
>> strrchr - Both in strchr.3 and in string.3
>> pselect - Both in select.2 and in select_tut.2
Could you please confirm if this is a bug in the Linux man-pages, or is it
something desirable? I find it a bit weird that we need to specify a NAME only
once. Then whatis(1) will not find the other pages that also talk about an
interface (of course, ideally, only a page would describe an interface, but we
know that's not reality).
Cheers,
Alex
>>
>> Thanks!
>>
>> Greetings
>>
>> Helge
>>
>> [1] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1020742
>
> So, if I understand correctly, specifying the same name in the .SH NAME section
> in more than one page is problematic, right? It makes sense to me. I'm a bit
> surprised that this bug hasn't been reported though, but otherwise I'm fine
> fixing it.
>
> I CCed a few people that have a lot more experience than I do, and will probably
> be able to tell if I understood the problem correctly.
>
> So, since we're still on time for the Debian freeze, if you confirm that this is
> the issue and the following fix is correct, I'll implement it and release
> man-pages-6.02 later this month; the solstice seems a proper day for a release,
> celebrating the new Sun. Thanks for the report!
>
> So, I'll try to find a complete list of duplicate NAMEs, and keep only one of them.
>
>
> Cheers,
>
> Alex
>
>
> P.S.: The biggest implication of fixing this before the freeze is that I'll
> release VLA syntax for function parameters, something which I wasn't expecting
> to do so soon. It seems that Moltke was right[1]. I'm still convinced that
> it's a good change, so let's see how these radical changes are received. ;)
>
>
> [1]: <https://lore.kernel.org/linux-man/20221110094033.ptpfsqpvvx2yd5xs@illithid/>
>
--
<http://www.alejandro-colomar.es/>
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2022-12-09 18:53 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-03 14:01 Conflicting alias for some man pages Helge Kreutzmann
2022-12-03 16:36 ` Alejandro Colomar
2022-12-03 16:51 ` Helge Kreutzmann
2022-12-03 17:03 ` Alejandro Colomar
2022-12-03 17:21 ` Helge Kreutzmann
2022-12-09 18:53 ` Alejandro Colomar [this message]
2022-12-09 20:37 ` G. Branden Robinson
2022-12-09 20:43 ` str{n,}casecmp(3) and <strings.h> (was: Conflicting alias for some man pages) Alejandro Colomar
2022-12-09 20:44 ` Alejandro Colomar
2022-12-09 20:48 ` man-db bugs? " Alejandro Colomar
2022-12-10 7:56 ` Helge Kreutzmann
2022-12-10 7:53 ` Conflicting alias for some man pages Helge Kreutzmann
2022-12-11 13:52 ` Alejandro Colomar
2022-12-11 14:20 ` Helge Kreutzmann
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=4aaf7fb4-8d4b-e050-b376-9120d8c328ac@gmail.com \
--to=alx.manpages@gmail.com \
--cc=cjwatson@debian.org \
--cc=debian@helgefjell.de \
--cc=g.branden.robinson@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=marcos@debian.org \
--cc=mario.blaettermann@gmail.com \
--cc=schwarze@usta.de \
--cc=toddy@debian.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.