From: "Drew Adams" <drew.adams@oracle.com>
To: "'Michael Albinus'" <michael.albinus@gmx.de>
Cc: 10319@debbugs.gnu.org
Subject: bug#10319: 24.0.92; doc string of `file-remote-p'
Date: Mon, 19 Dec 2011 11:44:16 -0800 [thread overview]
Message-ID: <C8FDFC3F0F164743BD95600B52E1816D@us.oracle.com> (raw)
In-Reply-To: <87ehw0e7u0.fsf@gmx.de>
> > That might be worth pointing out in the doc string. It might be
> > useful to users of the function. Perhaps you could just add
> > text like this:
> > "The return value can differ depending on whether there
> > is an existing connection."
>
> We shall mention that the return value is still a string. And the
> difference happens only for localname parts.
Good.
> > Do we want to say more than that? Is there some rule about this?
> > E.g., if no existing connection is the return value _always_ ""? If
> > no rule, then just adding that sentence (or similar) should
> > be enough.
>
> I wouldn't give a rule. There are other cases, like (file-remote-p
> "/ssh::" 'localname), which returns "~" when there is no
> connection, and "/home/albinus" otherwise.
>
> Combining your proposals, the docstring could be
>
> "Test whether FILE specifies a location on a remote system. Returns
> nil or a string
Returns -> Return. I think that's the convention, but I'm no expert.
> identifying the remote connection (ideally a prefix
> of FILE). For example, the remote identification for filename
> "/user@host:/foo" could be "/user@host:".
> A file is considered "remote" if accessing it is likely to
> be slower or less reliable than accessing local files.
I'd suggest moving that just after the first sentence ("Test...").
> Furthermore, relative file names do not work across remote
> connections.
Why "Furthermore"? This seems unrelated to anything preceding it. If I'm
right, I'd suggest just dropping "Furthermore". But in fact I don't know what
this sentence means. What do you mean here by "do not work"?
> IDENTIFICATION specifies which part of the identification shall be
> returned as string.
shall be returned as string -> to return
> IDENTIFICATION can be the symbol `method',
> `user', `host' or `localname'; any other value is handled like nil
> and means to return the complete identification string.
No need for "string" here.
> The string
> returned for IDENTIFICATION `localname' can differ depending on
> whether there is an existing connection."
Good.
> If CONNECTED is non-nil, the function returns an
the function returns -> return
> identification only if FILE is located on a remote system,
No comma here.
> and a connection is established to that remote system.
> `file-remote-p' never opens a new remote connection. It can only
> reuse a connection that is already open."
I'd suggest putting that last part just after "A file is considered remote
if..."
Something like this (but see my question about relative file names not working):
Test whether FILE specifies a location on a remote system.
A file is considered remote if accessing it is likely to
be slower or less reliable than accessing local files.
`file-remote-p' never opens a new remote connection. It can
only reuse a connection that is already open. Relative file
names do not work across remote connections (????).
Return nil or a string identifying the remote connection
(ideally a prefix of FILE). For example, the remote
identification for filename "/user@host:/foo" could be
"/user@host:".
IDENTIFICATION specifies which part of the identification to
return. IDENTIFICATION can be the symbol `method',
`user', `host', or `localname'. Any other value is handled
like nil and means to return the complete identification.
The string returned for IDENTIFICATION `localname' can differ
depending on whether there is an existing connection."
If CONNECTED is non-nil, return an identification only
if FILE is located on a remote system and a connection is
established to that remote system.
We should also perhaps say what "the complete identification" is/means. IOW,
when IDENTIFICATION is nil, what can we say about the return value?
HTH - Drew
next prev parent reply other threads:[~2011-12-19 19:44 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-18 2:17 bug#10319: 24.0.92; doc string of `file-remote-p' Drew Adams
2011-12-18 8:33 ` Michael Albinus
2011-12-18 15:02 ` Drew Adams
2011-12-19 8:40 ` Michael Albinus
2011-12-19 16:10 ` Drew Adams
2011-12-19 18:26 ` Michael Albinus
2011-12-19 19:44 ` Drew Adams [this message]
2011-12-19 21:18 ` Michael Albinus
2011-12-19 21:29 ` Drew Adams
2011-12-20 9:15 ` Michael Albinus
2011-12-20 15:53 ` Drew Adams
2011-12-20 17:02 ` Michael Albinus
2011-12-20 17:08 ` Drew Adams
2011-12-20 17:14 ` Michael Albinus
2011-12-20 17:33 ` Drew Adams
2011-12-21 18:34 ` Michael Albinus
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=C8FDFC3F0F164743BD95600B52E1816D@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=10319@debbugs.gnu.org \
--cc=michael.albinus@gmx.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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).