summaryrefslogtreecommitdiff
path: root/lisp/files.el
diff options
context:
space:
mode:
authorStefan Monnier <monnier@iro.umontreal.ca>2005-05-31 13:26:21 +0000
committerStefan Monnier <monnier@iro.umontreal.ca>2005-05-31 13:26:21 +0000
commitf2430a0de4a9df92c161a7166ba50b48c381fa59 (patch)
treeffd41cf91005785578570214a6fd64e4982b6a28 /lisp/files.el
parentb6061a8869e83588848b17d3f3fdaa265fe3a97b (diff)
downloademacs-f2430a0de4a9df92c161a7166ba50b48c381fa59.tar.gz
(convert-standard-filename): Docstring fix.
Diffstat (limited to 'lisp/files.el')
-rw-r--r--lisp/files.el4
1 files changed, 4 insertions, 0 deletions
diff --git a/lisp/files.el b/lisp/files.el
index 4602b4e1efa..a75b6b2fc89 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -514,6 +514,10 @@ Runs the usual ange-ftp hook, but only for completion operations."
This means to guarantee valid names and perhaps to canonicalize
certain patterns.
+FILENAME should be an absolute file name since the conversion rules
+sometimes vary depending on the position in the file name. E.g. c:/foo
+is a valid DOS file name, but c:/bar/c:/foo is not.
+
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