procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adapt file-remote-p doc

Browse source 
* doc/lispref/files.texi (Magic File Names): Adapt file-remote-p.

* lisp/files.el (file-remote-p): Adapt docstring.
This commit is contained in:
Michael Albinus 2024-07-19 18:29:49 +02:00
parent 34c1094e60
commit 0218fb2143
2 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/lispref/files.texi
View file

@ -3624,10 +3624,18 @@ ensure this principle is valid.
@var{identification} specifies which part of the identifier shall be
returned as string. @var{identification} can be the symbol
@code{method}, @code{user} or @code{host}; any other value is handled
like @code{nil} and means to return the complete identifier string.
In the example above, the remote @code{user} identifier string would
be @code{root}.
@code{method}, @code{user}, @code{host} or @code{localname}; any other
value is handled like @code{nil} and means to return the complete
identifier string. In the example above, the remote @code{user}
identifier string would be @code{root}.
If the remote @var{file} does not contain a method, a user name, or a
host name, the respective default value is returned. The string
returned for @var{identification} @code{localname} can differ depending
on whether there is an existing connection. File name handler specific
implementations could support further @var{identification} symbols;
@xref{Top, Tramp, Tramp, tramp}, for example, knows also the @code{hop}
symbol.
If @var{connected} is non-@code{nil}, this function returns @code{nil}
even if @var{filename} is remote, if Emacs has no network connection

11
lisp/files.el
View file

@ -1298,9 +1298,14 @@ any that are missing.
IDENTIFICATION can specify 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.
means to return the complete identification.
If the remote FILE does not contain a method, a user name, or a host
name, the respective default value is returned. The string returned for
IDENTIFICATION `localname' can differ depending on whether there is an
existing connection. File name handler specific implementations could
support further IDENTIFICATION symbols; Tramp, for example, knows also
the `hop' symbol.
If CONNECTED is non-nil, return an identification only if FILE is
located on a remote system and a connection is established to