GNU bug report logs - #30904
26.0.91; tramp.el: Outdated docstring of tramp-dissect-file-name

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 30904 in the body.
You can then email your comments to 30904 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: Pierre Neidhardt <ambrevar <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.0.91; tramp.el: Outdated docstring of tramp-dissect-file-name
Date: Thu, 22 Mar 2018 11:51:28 +0530

On the one hand, tramp-make-tramp-file-name documents the new DOMAIN and
PORT arguments:

> tramp-make-tramp-file-name is a compiled Lisp function in ‘tramp.el’.
> 
> (tramp-make-tramp-file-name METHOD USER DOMAIN HOST PORT LOCALNAME &optional
> HOP)
> 
> Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
> When not nil, optional DOMAIN, PORT and HOP are used.

On the other hand, tramp-dissect-file-name fails to reference them:

> tramp-dissect-file-name is a compiled Lisp function in ‘tramp.el’.
> 
> (tramp-dissect-file-name NAME &optional NODEFAULT)
> 
> Return a ‘tramp-file-name’ structure.
> The structure consists of remote method, remote user, remote host,
> localname (file name on remote host) and hop.  If NODEFAULT is
> non-nil, the file name parts are not expanded to their default
> values.

I think we should mention DOMAIN and PORT in the dissect function docstring.
The code actually handles them.

In GNU Emacs 26.0.91 (build 3, x86_64-pc-linux-gnu, GTK+ Version 3.22.26)
 of 2018-03-03 built on mimimi
Repository revision: 752fba992b793a74d202c9cfc3e1a92fd458e748
Windowing system distributor 'The X.Org Foundation', version 11.0.11906000
System Description:	Void Linux

Message #10 received at 30904-done <at> debbugs.gnu.org (full text, mbox):

From: Michael Albinus <michael.albinus <at> gmx.de>
To: Pierre Neidhardt <ambrevar <at> gmail.com>
Cc: 30904-done <at> debbugs.gnu.org
Subject: Re: bug#30904: 26.0.91;
 tramp.el: Outdated docstring of tramp-dissect-file-name
Date: Thu, 22 Mar 2018 10:06:36 +0100

Version: 27.1

Pierre Neidhardt <ambrevar <at> gmail.com> writes:

Hi Pierre,

> I think we should mention DOMAIN and PORT in the dissect function docstring.
> The code actually handles them.

Thanks for the report. I've fixed this in both Emacs and Tramp
repositories, master branch.

I do not want to commit this to the emacs-26 branch just now, short
before the Emacs 26.1 release. It is not critical.

I have fixed this also in the Tramp repository, branch-2-3-stable. This
will be merged into the Emacs repository, emacs-26 branch, after Emacs
26.1 is out. So it will appear also in a later Emacs 26.2.

Closing the bug.

Best regards, Michael.

Previous Next

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