From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.bugs Subject: Re: convert-standard-filename documentation is insufficient Date: Mon, 08 Nov 2004 19:29:52 GMT Message-ID: References: NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1099942104 8316 80.91.229.6 (8 Nov 2004 19:28:24 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Mon, 8 Nov 2004 19:28:24 +0000 (UTC) Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Nov 08 20:28:04 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 1CRFBL-0004qt-00 for ; Mon, 08 Nov 2004 20:28:03 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CRFJh-0003vX-Qf for geb-bug-gnu-emacs@m.gmane.org; Mon, 08 Nov 2004 14:36:41 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CRFJg-0003vS-Q5 for bug-gnu-emacs@gnu.org; Mon, 08 Nov 2004 14:36:40 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CRFJg-0003vG-Bk for bug-gnu-emacs@gnu.org; Mon, 08 Nov 2004 14:36:40 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CRFJg-0003vD-8x for bug-gnu-emacs@gnu.org; Mon, 08 Nov 2004 14:36:40 -0500 Original-Received: from [132.239.1.62] (helo=mailbox10.ucsd.edu) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.34) id 1CRFB9-00048s-9C for bug-gnu-emacs@gnu.org; Mon, 08 Nov 2004 14:27:53 -0500 Original-Received: from mailboy.risq.qc.ca (mailboy.risq.ca [192.26.210.45]) by mailbox10.ucsd.edu (8.13.1/8.13.1) with ESMTP id iA8JReYC017898 for ; Mon, 8 Nov 2004 11:27:41 -0800 (PST) Original-Received: from charlie.risq.qc.ca (unknown [192.26.210.24]) by mailboy.risq.qc.ca (Postfix) with ESMTP id 70C83923 for ; Mon, 8 Nov 2004 14:27:24 -0500 (EST) Original-Received: from charlie.risq.qc.ca (localhost [127.0.0.1]) by charlie.risq.qc.ca (8.12.10+Sun/8.12.9) with ESMTP id iA8JTtJh027723 for ; Mon, 8 Nov 2004 14:29:55 -0500 (EST) Original-Received: by charlie.risq.qc.ca (8.12.10+Sun/8.12.9/Submit) id iA8JTrsP027722; Mon, 8 Nov 2004 14:29:53 -0500 (EST) Original-To: gnu-emacs-bug@moderators.isc.org Original-Path: 53ab2750!not-for-mail Original-Newsgroups: gnu.emacs.bug User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/21.3.50 (gnu/linux) Cancel-Lock: sha1:omQvzVV5wNHXaJj3fuJn87QkSFw= Original-Lines: 27 Original-NNTP-Posting-Host: 132.204.24.84 Original-X-Complaints-To: abuse@umontreal.ca Original-X-Trace: charlie.risq.qc.ca 1099942192 132.204.24.84 (Mon, 08 Nov 2004 14:29:52 EST) Original-NNTP-Posting-Date: Mon, 08 Nov 2004 14:29:52 EST X-Spamscanner: mailbox10.ucsd.edu (v1.5 Aug 25 2004 09:28:35, 0.0/5.0 3.0.0) X-MailScanner: PASSED (v1.2.8 93818 iA8JReYC017898 mailbox10.ucsd.edu) 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:9630 X-Report-Spam: http://spam.gmane.org/gmane.emacs.bugs:9630 > (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 is to be used for packages which use hardcoded file names. E.g. it is used for ~/.emacs, ~/.gnus and things like that, where the author has to choose a name and wants to make sure that it still works on systems where this name might not be valid. I'm not sure how to best express it. Do you have a concrete suggestion for a new docstring? (please don't just say "yes, your above four lines would be fine") Stefan PS: Now that I think about it, why on earth does it try to handle cygwin filenames? Or more specifically, under what circumstance would this function receive a cygwin file name?