summaryrefslogtreecommitdiff
path: root/lisp/dos-fns.el
diff options
context:
space:
mode:
authorJuanma Barranquero <lekktu@gmail.com>2004-05-30 21:21:42 +0000
committerJuanma Barranquero <lekktu@gmail.com>2004-05-30 21:21:42 +0000
commit915b0bf0ab6ed6d9ae587954cd144290ece4c089 (patch)
tree3ff5945545759d8978afffe74b512ffc80d2f069 /lisp/dos-fns.el
parent2fcaee47a419d668b304d75f7511f2090c6736be (diff)
downloademacs-915b0bf0ab6ed6d9ae587954cd144290ece4c089.tar.gz
Rework docstring (wording by Eli Zaretskii and Kai Grossjohann).
Diffstat (limited to 'lisp/dos-fns.el')
-rw-r--r--lisp/dos-fns.el10
1 files changed, 7 insertions, 3 deletions
diff --git a/lisp/dos-fns.el b/lisp/dos-fns.el
index 65b6c0063c0..1253b7b5811 100644
--- a/lisp/dos-fns.el
+++ b/lisp/dos-fns.el
@@ -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.