From: Eli Zaretskii <eliz@gnu.org>
To: "Clément Pit--Claudel" <clement.pitclaudel@live.com>
Cc: 27798@debbugs.gnu.org
Subject: bug#27798: Documentation of locate-dominating-file is wrong
Date: Sun, 23 Jul 2017 17:31:51 +0300 [thread overview]
Message-ID: <83k22z8bs8.fsf@gnu.org> (raw)
In-Reply-To: <4e10c630-ed42-8204-815a-384b911bb645@live.com> (message from Clément Pit--Claudel on Sun, 23 Jul 2017 11:49:36 +0200)
> From: Clément Pit--Claudel <clement.pitclaudel@live.com>
> Date: Sun, 23 Jul 2017 11:49:36 +0200
>
> (locate-dominating-file FILE NAME)
>
> Look up the directory hierarchy from FILE for a directory containing NAME.
> Stop at the first parent directory containing a file NAME,
> and return the directory. Return nil if not found.
> Instead of a string, NAME can also be a predicate taking one argument
> (a directory) and returning a non-nil value if that directory is the one for
> which we’re looking.
>
> This part is wrong, because locate-dominating-file also accepts directories:
>
> Look up the directory hierarchy from FILE
Actually, FILE _must_ be a directory, because the function does this:
(setq try (if (stringp name)
(file-exists-p (expand-file-name name file))
^^^^^^^^^^^^^^^^^^^^^^^^^^
It's possible that "directory hierarchy from FILE" doesn't convey that
clearly enough, in which case we could add
FILE should be a directory.
> This part is wrong, because the predicate is called with the initial file name, too:
>
> NAME can also be a predicate taking one argument (a directory)
Why you say that this is wrong? The doc string never said anything to
the contrary.
If we change the first sentence to say this:
Starting from FILE, look up directory hierarchy for directory containing NAME.
will that address the second issue?
Thanks.
next prev parent reply other threads:[~2017-07-23 14:31 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-23 9:49 bug#27798: Documentation of locate-dominating-file is wrong Clément Pit--Claudel
2017-07-23 14:31 ` Eli Zaretskii [this message]
2017-07-23 14:52 ` Clément Pit--Claudel
2017-07-23 15:20 ` Eli Zaretskii
2017-07-23 16:08 ` Clément Pit--Claudel
2017-07-28 9:39 ` Eli Zaretskii
2017-07-28 9:59 ` Clément Pit--Claudel
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=83k22z8bs8.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=27798@debbugs.gnu.org \
--cc=clement.pitclaudel@live.com \
/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.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
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.