linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Jonny Grant <jg@jguk.org>
Cc: linux-man <linux-man@vger.kernel.org>
Subject: Re: cfree
Date: Thu, 25 Jun 2020 09:12:04 +0200	[thread overview]
Message-ID: <CAKgNAkjNz-Jk4qXjob2Sbwh8f=H=1nh6bzBdm49tuNJO8N_=aQ@mail.gmail.com> (raw)
In-Reply-To: <3e87db0e-f7e2-d47f-2a91-e110ffaf343e@jguk.org>

On Wed, 24 Jun 2020 at 16:46, Jonny Grant <jg@jguk.org> wrote:
>
>
>
> On 24/06/2020 09:09, Michael Kerrisk (man-pages) wrote:
> > On Tue, 23 Jun 2020 at 17:10, Jonny Grant <jg@jguk.org> wrote:
> >>
> >> Hello
> >> Is it time to remove this old man page? it's two years since it was removed from glibc
> >>
> >> 2017-08-02: glibc 2.26 released
> >>
> >> https://man7.org/linux/man-pages/man3/cfree.3.html
> >
> > The general philosophy is to maintain historical info in man-pages,
> > since new manual pages may be installed on an old system. Also, people
> > may need to look at old code, and understand what it does.
>
> Fair enough.
>
> Although I would imagine anyone trying to use a function called cfree() would already understand they should use free()
>
> Could the key point that cfree() is deprecated and removed be highlighted at the top of the man page?
>
> I'd be temped to just have :-
>
>
> DEPRECATED
>        This function should not be used, it was non-standard and removed in glibc version 2.26 2017-08-02.
>
> NAME
>        cfree - free allocated memory

I think the existing first sentence of DESCRIPTION suffices.

Thanks,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

      reply	other threads:[~2020-06-25  7:12 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-23 15:10 cfree Jonny Grant
2020-06-23 15:26 ` cfree Ponnuvel Palaniyappan
2020-06-24  8:09 ` cfree Michael Kerrisk (man-pages)
2020-06-24 14:46   ` cfree Jonny Grant
2020-06-25  7:12     ` Michael Kerrisk (man-pages) [this message]

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='CAKgNAkjNz-Jk4qXjob2Sbwh8f=H=1nh6bzBdm49tuNJO8N_=aQ@mail.gmail.com' \
    --to=mtk.manpages@gmail.com \
    --cc=jg@jguk.org \
    --cc=linux-man@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).