From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#23865: 24.5; doc string of `tramp-remote-path' Date: Wed, 29 Jun 2016 06:53:35 -0700 (PDT) Message-ID: 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; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1467208471 12986 80.91.229.3 (29 Jun 2016 13:54:31 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 29 Jun 2016 13:54:31 +0000 (UTC) Cc: 23865@debbugs.gnu.org, Jonathan Kotta To: Michael Albinus Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jun 29 15:54:17 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 1bIFwS-0004FV-QU for geb-bug-gnu-emacs@m.gmane.org; Wed, 29 Jun 2016 15:54:13 +0200 Original-Received: from localhost ([::1]:43966 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bIFwR-0001uY-SE for geb-bug-gnu-emacs@m.gmane.org; Wed, 29 Jun 2016 09:54:11 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52750) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bIFwM-0001t1-A5 for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 09:54:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bIFwI-0003sT-Lq for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 09:54:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:47414) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bIFwI-0003s2-IU for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 09:54:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1bIFwI-0003ob-5G for bug-gnu-emacs@gnu.org; Wed, 29 Jun 2016 09:54:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 29 Jun 2016 13:54:02 +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.146720842714644 (code B ref 23865); Wed, 29 Jun 2016 13:54:02 +0000 Original-Received: (at 23865) by debbugs.gnu.org; 29 Jun 2016 13:53:47 +0000 Original-Received: from localhost ([127.0.0.1]:59751 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bIFw2-0003o8-SV for submit@debbugs.gnu.org; Wed, 29 Jun 2016 09:53:47 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:40453) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bIFw0-0003nt-T7 for 23865@debbugs.gnu.org; Wed, 29 Jun 2016 09:53:45 -0400 Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u5TDrcWC026465 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Wed, 29 Jun 2016 13:53:38 GMT Original-Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by userv0021.oracle.com (8.13.8/8.13.8) with ESMTP id u5TDrbp2000435 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Wed, 29 Jun 2016 13:53:38 GMT Original-Received: from abhmp0006.oracle.com (abhmp0006.oracle.com [141.146.116.12]) by aserv0122.oracle.com (8.13.8/8.13.8) with ESMTP id u5TDrZNB030327; Wed, 29 Jun 2016 13:53:36 GMT In-Reply-To: <87oa6ke91x.fsf@gmx.de> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6744.5000 (x86)] X-Source-IP: userv0021.oracle.com [156.151.31.71] 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:120201 Archived-At: > The docstring of `tramp-remote-path' is oriented to the custom > interface. In custom, `tramp-default-remote-path' and > `tramp-own-remote-path' are not offered under their symbol name, but as > "Default Directories" and "Private Directories". These entries are > documented. 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).