From: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
To: Walter Harms <wharms@bfs.de>
Cc: "linux-man@vger.kernel.org" <linux-man@vger.kernel.org>,
"Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Subject: Re: gamma(3)
Date: Fri, 21 May 2021 16:47:29 +0200 [thread overview]
Message-ID: <509d34ee-4616-81e7-28a6-73a7e024dbeb@gmail.com> (raw)
In-Reply-To: <904f79501b114346a3e7bd84efb13a6a@bfs.de>
On 5/21/21 4:08 PM, Walter Harms wrote:
> (before we misunderstand each other i do not insists on that patch)
No problem about it. You could insist on if you wanted to :p
I'm not sure yet about what we should do.
>
> The function is available and that should be documented.
I tend to agree with that.
> They seem available for some time, but glibc says: These functions
> exist for compatibility reasons.
Exactly. But that means it exists for old code to still work. New code
should not use these. So the manual page should serve 2 purposes:
*) discourage its use
*) help migrating from gamma(3) to lgamma(3)
The first one is already clear. For the second one, I think that the
SYNOPSIS and ATTRIBUTES is enough.
>
> What is about a merger with lgamma() ?
I like it separated (as is). It serves the purpose of redirecting to
either lgamma or tgamma depending on what the reader wants.
>
> adding to the notes section something like that:
> glibc version
> Glibc has a gamma() function (and _r) that is equivalent to
> lgamma(3) and computes the natural logarithm of the Gamma function.
> That function is deprecated and should not be used in newer programs.
>
>
> re,
> wh
I think that to document those, but keep it to a minimum, I'd add the
functions to the sections NAME and SYNOPSIS, and nothing more. The rest
is very generic and mainly says "don't use this". The only thing that
would maybe need an update is the ATTRIBUTES section, but I wouldn't
mind if we left it as is.
What do you think?
Cheers,
Alex
--
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
next prev parent reply other threads:[~2021-05-21 14:47 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <60a57e3a.lbqA81rLGmtH2qoy%Radisson97@gmx.de>
2021-05-21 11:04 ` Alejandro Colomar (man-pages)
2021-05-21 13:11 ` AW: Re: Walter Harms
2021-05-21 13:29 ` Alejandro Colomar (man-pages)
2021-05-21 14:08 ` AW: " Walter Harms
2021-05-21 14:47 ` Alejandro Colomar (man-pages) [this message]
2021-05-21 15:28 ` AW: gamma(3) Walter Harms
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=509d34ee-4616-81e7-28a6-73a7e024dbeb@gmail.com \
--to=alx.manpages@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=wharms@bfs.de \
/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.