From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: "Eli Zaretskii" Newsgroups: gmane.emacs.bugs Subject: Re: convert-standard-filename documentation is insufficient Date: Sun, 07 Nov 2004 06:41:17 +0200 Message-ID: <01c4c484$Blat.v2.2.2$2a742b40@zahav.net.il> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: deer.gmane.org Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7BIT X-Trace: sea.gmane.org 1099802836 30647 80.91.229.6 (7 Nov 2004 04:47:16 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sun, 7 Nov 2004 04:47:16 +0000 (UTC) Cc: bug-gnu-emacs@gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Nov 07 05:47:07 2004 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1CQexH-0002xQ-00 for ; Sun, 07 Nov 2004 05:47:07 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CQf5Z-0001K0-1P for geb-bug-gnu-emacs@m.gmane.org; Sat, 06 Nov 2004 23:55:41 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CQf5W-0001I6-7x for bug-gnu-emacs@gnu.org; Sat, 06 Nov 2004 23:55:38 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CQf5V-0001Hc-7w for bug-gnu-emacs@gnu.org; Sat, 06 Nov 2004 23:55:37 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CQf5V-0001HS-4y for bug-gnu-emacs@gnu.org; Sat, 06 Nov 2004 23:55:37 -0500 Original-Received: from [192.114.186.24] (helo=legolas.inter.net.il) by monty-python.gnu.org with esmtp (Exim 4.34) id 1CQex7-0008Ea-Fy for bug-gnu-emacs@gnu.org; Sat, 06 Nov 2004 23:46:57 -0500 Original-Received: from zaretski (pns03-208-208.inter.net.il [80.230.208.208]) by legolas.inter.net.il (MOS 3.5.3-GR) with ESMTP id DAU48884 (AUTH halo1); Sun, 7 Nov 2004 06:46:48 +0200 (IST) Original-To: Jari Aalto X-Mailer: emacs 21.3.50 (via feedmail 8 I) and Blat ver 2.2.2 In-reply-to: (message from Jari Aalto on Sat, 06 Nov 2004 20:07:07 +0200) X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: main.gmane.org gmane.emacs.bugs:9614 X-Report-Spam: http://spam.gmane.org/gmane.emacs.bugs:9614 > From: Jari Aalto > Date: Sat, 06 Nov 2004 20:07:07 +0200 > > (convert-standard-filename FILENAME) > > Convert a standard file's name to something suitable for the > current OS. This function's standard definition is trivial; it > just returns the argument. However, on some systems, the function > is redefined with a definition that really does change some file > names. > > This leaves completely open where function would be used. > Please provide concrete examples in the documentation string. This function was introduced for Lisp programmers, not for users. The rationale for its existence and its recommended usage are explained in the ELisp manual (which will be part of the standard Emacs distro as of the next release). Given the above, I personally don't see any convincing reasons to add the usage information to the doc string.