From: "Eli Zaretskii" <eliz@gnu.org>
Cc: bug-gnu-emacs@gnu.org
Subject: Re: convert-standard-filename documentation is insufficient
Date: Mon, 08 Nov 2004 00:42:29 +0200 [thread overview]
Message-ID: <01c4c51b$Blat.v2.2.2$3527b4c0@zahav.net.il> (raw)
In-Reply-To: <200411072200.iA7M02V02132@raven.dms.auburn.edu> (message from Luc Teirlinck on Sun, 7 Nov 2004 16:00:02 -0600 (CST))
> Date: Sun, 7 Nov 2004 16:00:02 -0600 (CST)
> From: Luc Teirlinck <teirllm@dms.auburn.edu>
> 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.
next prev parent reply other threads:[~2004-11-07 22:42 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-11-07 22:00 convert-standard-filename documentation is insufficient Luc Teirlinck
2004-11-07 22:42 ` Eli Zaretskii [this message]
-- strict thread matches above, loose matches on Subject: below --
2004-11-08 22:02 Luc Teirlinck
2004-11-11 23:03 ` Jeff Dwork
2004-11-12 5:24 ` Werner LEMBERG
2004-11-12 13:34 ` Luc Teirlinck
2004-11-12 13:54 ` Luc Teirlinck
2004-11-08 21:58 Luc Teirlinck
[not found] <mailman.1099.1099774836.8225.bug-gnu-emacs@gnu.org>
2004-11-08 19:29 ` Stefan Monnier
2004-11-06 18:07 Jari Aalto
2004-11-07 4:41 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='01c4c51b$Blat.v2.2.2$3527b4c0@zahav.net.il' \
--to=eliz@gnu.org \
--cc=bug-gnu-emacs@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).