From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Michael Albinus Newsgroups: gmane.emacs.bugs Subject: bug#23865: 24.5; doc string of `tramp-remote-path' Date: Wed, 29 Jun 2016 16:58:12 +0200 Message-ID: <87eg7gdou3.fsf@gmx.de> References: <4d920499-85a0-49bc-930c-ca7337fe2554@default> <87oa6ke91x.fsf@gmx.de> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1467212375 14389 80.91.229.3 (29 Jun 2016 14:59:35 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 29 Jun 2016 14:59:35 +0000 (UTC) Cc: 23865@debbugs.gnu.org, Jonathan Kotta To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jun 29 16:59:20 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1bIGxR-00085X-UZ for geb-bug-gnu-emacs@m.gmane.org; Wed, 29 Jun 2016 16:59:18 +0200 Original-Received: from localhost ([::1]:44263 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bIGxR-0001My-1B for geb-bug-gnu-emacs@m.gmane.org; Wed, 29 Jun 2016 10:59:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:46306) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bIGxG-0001K9-6a for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 10:59:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bIGxC-0006xE-9J for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 10:59:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:47877) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bIGxC-0006xA-6d for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 10:59:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1bIGxB-0005YN-RH for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 10:59:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Michael Albinus Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 29 Jun 2016 14:59:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 23865 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 23865-submit@debbugs.gnu.org id=B23865.146721230821148 (code B ref 23865); Wed, 29 Jun 2016 14:59:01 +0000 Original-Received: (at 23865) by debbugs.gnu.org; 29 Jun 2016 14:58:28 +0000 Original-Received: from localhost ([127.0.0.1]:60214 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bIGwe-0005V0-9S for submit@debbugs.gnu.org; Wed, 29 Jun 2016 10:58:28 -0400 Original-Received: from mout.gmx.net ([212.227.17.20]:55825) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bIGwb-0005TA-G1 for 23865@debbugs.gnu.org; Wed, 29 Jun 2016 10:58:27 -0400 Original-Received: from detlef.gmx.de ([79.195.10.96]) by mail.gmx.com (mrgmx102) with ESMTPSA (Nemesis) id 0MOCSm-1bEzgo3Gzc-005Vss; Wed, 29 Jun 2016 16:58:15 +0200 In-Reply-To: (Drew Adams's message of "Wed, 29 Jun 2016 06:53:35 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) X-Provags-ID: V03:K0:0uY+XOj18OMZq7SJy33NbbFhVC0eTasVcaYnfxjWMylIQ+Yis1r VGIkU0VPw8ZJMQ/NCpSqZsu66OCWWoGC9EZijCFrLUB6V7MFCSQ4kOXwdKjmW4VQSJeoZV1 lhvVbvUmqiC3BAYaGvbjaJUYzejdBlz2KmcMI3Cr456Y6/YmZC/lWtDJeVAbwdMA3YlalYs qYZ2hlAnDrL3tfNmQkefA== X-UI-Out-Filterresults: notjunk:1;V01:K0:mFTsU8f0jPk=:NFZ05YZibxOaTBksx0eKgS TJEFL3DOgWqH/zhZBuSFJqGwDO9XPX0xpcoWmjW997802MAH4S5dCvC+1BFjzS2xq4iSX6QnF Qxz38WWHPDQBMu62f6Yf8cFmOyWtKqWAhag1FKRKGQ0E/uTLmUfiemPxM+oaDyUKivcxVdRzx k+lJL9ogmmRDACYi5q9ErE0MO10hHBvXR29qC7k9oKESg0TAH7b2MYUmNEy0AzXMz5JdG0Iej EMg2aDuGLXZYkGqGnvLo55SQh+ZqQqTZt9Bw9Ig0O1T8+ymwrMWn0uH4mN/JHsljGBurSHYKc j9YY0wJSvt75exxCpw5HiVgFmyaPo7ghkTRzAkYXJ0teszoU/UVRH5TLweFM6GqejS3sCx78t jys4NJK18gy4xalli4Xv61jr0gJYWO59ln1D6Bu9Eaqr7mMok54BFVw5S6MRdv5Wzk8jkhOYG BMf2sanVvg650p7ISeIhUMv8jTUcjPFW8xX1rhoL/rPt0ZUgVdDDJ2H9j3ER/6tlNkeSWaAPC wmbUTsZm2L3N/uHFhq80t692f05bIAV3kjwi82I9DdKf5bqftq/tmD8sYH1XDItohiHAcZTVt DnYK8bZoNQvgYstC3h3dXYe+N9YJEgB1jV8VhBk9JX4QCoY74sfH/qbmSgDtTBGtPy7rR6zRM GMYG8qUf3hnx3M+wq9x0VyQ5bhxhRLGf+3Kr6DWEwNTN0/qsTMmZNLu1ibniSAmwr80v8rUN8 CpC2z4D1ksi//485U4KyWq3psU7tmTNrFgxeTwXlzI47qIN6VNPX3k1TCySy2iiFWNfb5zDR X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:120206 Archived-At: Drew Adams writes: > Right. That's the (doc) bug. It is fine to be "oriented" to > interactive use of Customize. It is a failing to incorrectly > describe the variable value. That hurts, rather than helps > users. The doc string can do both: describe things in terms > of the UI and also correctly describe the possible values. > > What it should not do is what it does now: give the impression > that the list values are all strings (and not say anything > about those two symbols that have special meaning for the > variable value). I was aware of this problem when writing the docstring. Unfortunately, there's no possibility to let it look different in `describe-variable' and the custom UI. Would the following patch fit the bill? --8<---------------cut here---------------start------------->8--- *** /home/albinus/src/emacs/lisp/net/tramp-sh.el.~cfb3c61f1ffec9a6322407fdd228d5cc31c31ed0~ 2016-06-29 16:55:53.466570072 +0200 --- /home/albinus/src/emacs/lisp/net/tramp-sh.el 2016-06-29 16:55:36.918161072 +0200 *************** *** 527,541 **** You can use `~' in this list, but when searching for a shell which groks tilde expansion, all directory names starting with `~' will be ignored. ! `Default Directories' represent the list of directories given by ! the command \"getconf PATH\". It is recommended to use this ! entry on top of this list, because these are the default directories for POSIX compatible commands. On remote hosts which do not offer the getconf command (like cygwin), the value \"/bin:/usr/bin\" is used instead of. ! `Private Directories' are the settings of the $PATH environment, ! as given in your `~/.profile'." :group 'tramp :type '(repeat (choice (const :tag "Default Directories" tramp-default-remote-path) --- 527,543 ---- You can use `~' in this list, but when searching for a shell which groks tilde expansion, all directory names starting with `~' will be ignored. ! `Default Directories', indicated internally by ! `tramp-default-remote-path', represent the list of directories ! given by the command \"getconf PATH\". It is recommended to use ! this entry on top of this list, because these are the default directories for POSIX compatible commands. On remote hosts which do not offer the getconf command (like cygwin), the value \"/bin:/usr/bin\" is used instead of. ! `Private Directories', indicated internally by ! `tramp-own-remote-path', are the settings of the $PATH ! environment, as given in your `~/.profile'." :group 'tramp :type '(repeat (choice (const :tag "Default Directories" tramp-default-remote-path) --8<---------------cut here---------------end--------------->8--- Best regards, Michael.