Commit 915b0bf0 authored by Juanma Barranquero's avatar Juanma Barranquero

Rework docstring (wording by Eli Zaretskii and Kai Grossjohann).

parent 2fcaee47
......@@ -31,9 +31,13 @@
;; This overrides a trivial definition in files.el.
(defun 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 means to guarantee valid names and perhaps to canonicalize
certain patterns.
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')."
(if (or (not (stringp filename))
;; This catches the case where FILENAME is "x:" or "x:/" or
;; "/", thus preventing infinite recursion.
......
......@@ -481,10 +481,15 @@ Runs the usual ange-ftp hook, but only for completion operations."
(defun 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 to canonicalize certain
patterns and to guarantee valid names."
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')."
filename)
(defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
......
......@@ -230,9 +230,13 @@ You should set this to t when using a non-system shell.\n\n"))))
(defun 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 means to guarantee valid names and perhaps to canonicalize
certain patterns.
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')."
(let ((name
(save-match-data
(if (string-match "\\`/cygdrive/\\([a-zA-Z]\\)/" filename)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment