GNU bug report logs - #52339
26.3; Doc of functions that accept file-name args: say whether absolute

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#52339: closed (26.3; Doc of functions that accept file-name
 args: say whether absolute)
Date: Tue, 07 Dec 2021 13:02:01 +0000

[Message part 1 (text/plain, inline)]

Your message dated Tue, 07 Dec 2021 15:01:26 +0200
with message-id <83o85szhzt.fsf <at> gnu.org>
and subject line Re: bug#52339: 26.3; Doc of functions that accept file-name args: say whether absolute
has caused the debbugs.gnu.org bug report #52339,
regarding 26.3; Doc of functions that accept file-name args: say whether absolute
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
52339: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=52339
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Drew Adams <drew.adams <at> oracle.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: 26.3; Doc of functions that accept file-name args: say whether
 absolute
Date: Mon, 6 Dec 2021 22:26:46 +0000

This report is about the doc strings and the doc in the Elisp manual for
functions that accept file-name args.

Please say, somewhere (preferably in each relevant node, since someone
might not start reading in node `Information about Files'), about the
file-name arg for a function documented in the node, whether the name
must be absolute or relative (e.g. to `default-directory') or can be
either.  Similarly, for the doc strings of such functions.

E.g. function `file-exists-p' itself expands its arg relative to
`default-directory', if the arg isn't an absolute name.  This isn't
obvious.

In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.19042
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

[Message part 3 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 52339-done <at> debbugs.gnu.org
Subject: Re: bug#52339: 26.3;
 Doc of functions that accept file-name args: say whether absolute
Date: Tue, 07 Dec 2021 15:01:26 +0200

> From: Drew Adams <drew.adams <at> oracle.com>
> Date: Mon, 6 Dec 2021 22:26:46 +0000
> 
> This report is about the doc strings and the doc in the Elisp manual for
> functions that accept file-name args.
> 
> Please say, somewhere (preferably in each relevant node, since someone
> might not start reading in node `Information about Files'), about the
> file-name arg for a function documented in the node, whether the name
> must be absolute or relative (e.g. to `default-directory') or can be
> either.  Similarly, for the doc strings of such functions.
> 
> E.g. function `file-exists-p' itself expands its arg relative to
> `default-directory', if the arg isn't an absolute name.  This isn't
> obvious.

It should be obvious, because anything else would be a terrible bug,
as should be clear if you consider the alternatives.  Which is why
Emacs does that in _all_ APIs that accept file names.

Closing.

Previous Next

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