aboutsummaryrefslogtreecommitdiffstats
path: root/src/fileio.c
diff options
context:
space:
mode:
authorPaul Eggert2015-09-16 16:23:55 -0700
committerPaul Eggert2015-09-16 16:26:07 -0700
commit032ce1c7d1afb23e6b1265d91c5a97e45de071ce (patch)
treedab9ca1e540c23aeb15ee9ef8fdc6b78e1929b6d /src/fileio.c
parent309d39b832ccd72f99cc726090ff03f7e146948d (diff)
downloademacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.tar.gz
emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.zip
Omit unnecessary \ before paren in C docstrings
Although \( is needed in docstrings in Elisp code, it is not needed in docstrings in C code, since C function definitiions do not start with a parenthesis. The backslashes made the docstrings a bit harder to read and to format in columns. Also, some C docstrings had ( in column 1 and this did not appear to be causing any problems. So, simplify C docstrings by replacing \( with ( and \) with ).
Diffstat (limited to 'src/fileio.c')
-rw-r--r--src/fileio.c18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/fileio.c b/src/fileio.c
index 69933ccd40b..e4b255a53ac 100644
--- a/src/fileio.c
+++ b/src/fileio.c
@@ -451,7 +451,7 @@ DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
451A `directly usable' directory name is one that may be used without the 451A `directly usable' directory name is one that may be used without the
452intervention of any file handler. 452intervention of any file handler.
453If FILENAME is a directly usable file itself, return 453If FILENAME is a directly usable file itself, return
454\(file-name-directory FILENAME). 454(file-name-directory FILENAME).
455If FILENAME refers to a file which is not accessible from a local process, 455If FILENAME refers to a file which is not accessible from a local process,
456then this should return nil. 456then this should return nil.
457The `call-process' and `start-process' functions use this function to 457The `call-process' and `start-process' functions use this function to
@@ -742,7 +742,7 @@ DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
742 doc: /* Generate temporary file name (string) starting with PREFIX (a string). 742 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
743The Emacs process number forms part of the result, so there is no 743The Emacs process number forms part of the result, so there is no
744danger of generating a name being used by another Emacs process 744danger of generating a name being used by another Emacs process
745\(so long as only a single host can access the containing directory...). 745(so long as only a single host can access the containing directory...).
746 746
747This function tries to choose a name that has no existing file. 747This function tries to choose a name that has no existing file.
748For this to work, PREFIX should be an absolute file name. 748For this to work, PREFIX should be an absolute file name.
@@ -758,7 +758,7 @@ normally use `make-temp-file' instead. */)
758DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, 758DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
759 doc: /* Convert filename NAME to absolute, and canonicalize it. 759 doc: /* Convert filename NAME to absolute, and canonicalize it.
760Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative 760Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
761\(does not start with slash or tilde); both the directory name and 761(does not start with slash or tilde); both the directory name and
762a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or 762a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
763missing, the current buffer's value of `default-directory' is used. 763missing, the current buffer's value of `default-directory' is used.
764NAME should be a string that is a valid file name for the underlying 764NAME should be a string that is a valid file name for the underlying
@@ -776,8 +776,8 @@ See also the function `substitute-in-file-name'.
776 776
777For technical reasons, this function can return correct but 777For technical reasons, this function can return correct but
778non-intuitive results for the root directory; for instance, 778non-intuitive results for the root directory; for instance,
779\(expand-file-name ".." "/") returns "/..". For this reason, use 779(expand-file-name ".." "/") returns "/..". For this reason, use
780\(directory-file-name (file-name-directory dirname)) to traverse a 780(directory-file-name (file-name-directory dirname)) to traverse a
781filesystem tree, not (expand-file-name ".." dirname). */) 781filesystem tree, not (expand-file-name ".." dirname). */)
782 (Lisp_Object name, Lisp_Object default_directory) 782 (Lisp_Object name, Lisp_Object default_directory)
783{ 783{
@@ -1460,7 +1460,7 @@ filesystem tree, not (expand-file-name ".." dirname). */)
1460DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, 1460DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1461 "Convert FILENAME to absolute, and canonicalize it.\n\ 1461 "Convert FILENAME to absolute, and canonicalize it.\n\
1462Second arg DEFAULT is directory to start with if FILENAME is relative\n\ 1462Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1463\(does not start with slash); if DEFAULT is nil or missing,\n\ 1463(does not start with slash); if DEFAULT is nil or missing,\n\
1464the current buffer's value of default-directory is used.\n\ 1464the current buffer's value of default-directory is used.\n\
1465Filenames containing `.' or `..' as components are simplified;\n\ 1465Filenames containing `.' or `..' as components are simplified;\n\
1466initial `~/' expands to your home directory.\n\ 1466initial `~/' expands to your home directory.\n\
@@ -2469,7 +2469,7 @@ Use `file-symlink-p' to test for such links. */)
2469DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0, 2469DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2470 doc: /* Return t if FILENAME can be executed by you. 2470 doc: /* Return t if FILENAME can be executed by you.
2471For a directory, this means you can access files in that directory. 2471For a directory, this means you can access files in that directory.
2472\(It is generally better to use `file-accessible-directory-p' for that 2472(It is generally better to use `file-accessible-directory-p' for that
2473purpose, though.) */) 2473purpose, though.) */)
2474 (Lisp_Object filename) 2474 (Lisp_Object filename)
2475{ 2475{
@@ -5306,8 +5306,8 @@ DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5306Useful if the buffer was not read from the file normally 5306Useful if the buffer was not read from the file normally
5307or if the file itself has been changed for some known benign reason. 5307or if the file itself has been changed for some known benign reason.
5308An argument specifies the modification time value to use 5308An argument specifies the modification time value to use
5309\(instead of that of the visited file), in the form of a list 5309(instead of that of the visited file), in the form of a list
5310\(HIGH LOW USEC PSEC) or an integer flag as returned by 5310(HIGH LOW USEC PSEC) or an integer flag as returned by
5311`visited-file-modtime'. */) 5311`visited-file-modtime'. */)
5312 (Lisp_Object time_flag) 5312 (Lisp_Object time_flag)
5313{ 5313{