GNU bug report logs - #45437
27.1; make-temp-file parameter change in emacs 26 missing in documentation

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 45437 in the body.
You can then email your comments to 45437 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Hendrik Tews <hendrik <at> askra.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.1; make-temp-file parameter change in emacs 26 missing in
 documentation
Date: Fri, 25 Dec 2020 22:51:22 +0100

Hi,

the function make-temp-file was extended in emacs 26 with the
additional optional TEXT argument. However, describe-function
says "Probably introduced at or before Emacs version 21.1.",
leaving the impression that one can safely use the TEXT argument
if one wants to write backward compatible code.

Please amend the documentation of make-temp-file to mention that
the TEXT argument was added in emacs 26. Without such
information, it is very difficult to write code that works in a
variety of emacs major versions.

Thanks,

Hendrik

Message #8 received at 45437 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Hendrik Tews <hendrik <at> askra.de>
Cc: 45437 <at> debbugs.gnu.org
Subject: Re: bug#45437: 27.1; make-temp-file parameter change in emacs 26
 missing in documentation
Date: Fri, 25 Dec 2020 22:56:21 +0100

Hendrik Tews <hendrik <at> askra.de> writes:

> the function make-temp-file was extended in emacs 26 with the
> additional optional TEXT argument. However, describe-function
> says "Probably introduced at or before Emacs version 21.1.",
> leaving the impression that one can safely use the TEXT argument
> if one wants to write backward compatible code.

The "probably" only talks about the function itself; not about the
parameters.

> Please amend the documentation of make-temp-file to mention that
> the TEXT argument was added in emacs 26. Without such
> information, it is very difficult to write code that works in a
> variety of emacs major versions.

Sorry; we don't keep track of added parameters in a systematic way, so
that would be unfeasible.  You have to read the NEWS file to determine
this stuff (or use the VC functions, of you have a checked-out Emacs).

Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #19 received at 45437 <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Hendrik Tews <hendrik <at> askra.de>, 45437 <at> debbugs.gnu.org
Subject: Re: bug#45437: 27.1; make-temp-file parameter change in emacs 26
 missing in documentation
Date: Fri, 12 Feb 2021 18:14:01 +0000

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Hendrik Tews <hendrik <at> askra.de> writes:
>
>> the function make-temp-file was extended in emacs 26 with the
>> additional optional TEXT argument. However, describe-function
>> says "Probably introduced at or before Emacs version 21.1.",
>> leaving the impression that one can safely use the TEXT argument
>> if one wants to write backward compatible code.
>
> The "probably" only talks about the function itself; not about the
> parameters.

And is an imperfect heuristic based on searching NEWS files, hence
"probably".

>> Please amend the documentation of make-temp-file to mention that
>> the TEXT argument was added in emacs 26. Without such
>> information, it is very difficult to write code that works in a
>> variety of emacs major versions.
>
> Sorry; we don't keep track of added parameters in a systematic way, so
> that would be unfeasible.  You have to read the NEWS file to determine
> this stuff (or use the VC functions, of you have a checked-out Emacs).

See also: https://lists.gnu.org/r/emacs-devel/2020-12/msg00371.html

-- 
Basil

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.