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: Mon, 08 Nov 2004 00:42:29 +0200 Message-ID: <01c4c51b$Blat.v2.2.2$3527b4c0@zahav.net.il> References: <200411072200.iA7M02V02132@raven.dms.auburn.edu> 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 1099867725 20088 80.91.229.6 (7 Nov 2004 22:48:45 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sun, 7 Nov 2004 22:48:45 +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 23:48:37 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 1CQvpt-0005w7-00 for ; Sun, 07 Nov 2004 23:48:37 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CQvyC-0002wY-Uy for geb-bug-gnu-emacs@m.gmane.org; Sun, 07 Nov 2004 17:57:13 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CQvy7-0002uF-L1 for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:57:07 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CQvy6-0002tV-AQ for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:57:06 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CQvy5-0002sn-JV for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:57:05 -0500 Original-Received: from [192.114.186.24] (helo=legolas.inter.net.il) by monty-python.gnu.org with esmtp (Exim 4.34) id 1CQvpW-000060-E8 for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:48:14 -0500 Original-Received: from zaretski (pns03-197-96.inter.net.il [80.230.197.96]) by legolas.inter.net.il (MOS 3.5.3-GR) with ESMTP id DAX82196 (AUTH halo1); Mon, 8 Nov 2004 00:48:01 +0200 (IST) Original-To: Luc Teirlinck X-Mailer: emacs 21.3.50 (via feedmail 8 I) and Blat ver 2.2.2 In-reply-to: <200411072200.iA7M02V02132@raven.dms.auburn.edu> (message from Luc Teirlinck on Sun, 7 Nov 2004 16:00:02 -0600 (CST)) 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:9621 X-Report-Spam: http://spam.gmane.org/gmane.emacs.bugs:9621 > Date: Sun, 7 Nov 2004 16:00:02 -0600 (CST) > From: Luc Teirlinck > CC: bug-gnu-emacs@gnu.org, bug-gnu-emacs@gnu.org > > Eli Zaretskii wrote: > > Given the above, I personally don't see any convincing reasons to add > the usage information to the doc string. > > Actually, the docstring appears to have already been expanded in > current CVS: > > "Convert a standard file's name to something suitable for the current OS. > This means to guarantee valid names and perhaps to canonicalize > certain patterns. > > This function's standard definition is trivial; it just returns > the argument. However, on Windows and DOS, replace invalid > characters. On DOS, make sure to obey the 8.3 limitations. On > Windows, turn Cygwin names into native names, and also turn > slashes into backslashes if the shell requires it (see > `w32-shell-dos-semantics')." This still doesn't say what the OP wanted: what is the intended use of this function. It just says what the function does, but not in what circumstances it should be used. > Convert a standard file's name to one suitable for the current OS. > > If there are no objections, I will install this change in CVS. FWIW, I find the current wording more clear.