diff options
| author | Pavel Janík | 2001-10-20 20:56:10 +0000 |
|---|---|---|
| committer | Pavel Janík | 2001-10-20 20:56:10 +0000 |
| commit | fdb82f93376a6b495c573a6c788b807acffdbfa9 (patch) | |
| tree | 107b731b733908446a3902f6ce0e4f2d23dcd8f9 /src/callproc.c | |
| parent | c0a53abba1d89bb487e3a38a0e7336bdce46fd1d (diff) | |
| download | emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.tar.gz emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.zip | |
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src/callproc.c')
| -rw-r--r-- | src/callproc.c | 138 |
1 files changed, 69 insertions, 69 deletions
diff --git a/src/callproc.c b/src/callproc.c index 2c98933afba..f8709ee42d0 100644 --- a/src/callproc.c +++ b/src/callproc.c | |||
| @@ -189,25 +189,25 @@ call_process_cleanup (fdpid) | |||
| 189 | } | 189 | } |
| 190 | 190 | ||
| 191 | DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0, | 191 | DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0, |
| 192 | "Call PROGRAM synchronously in separate process.\n\ | 192 | doc: /* Call PROGRAM synchronously in separate process. |
| 193 | The remaining arguments are optional.\n\ | 193 | The remaining arguments are optional. |
| 194 | The program's input comes from file INFILE (nil means `/dev/null').\n\ | 194 | The program's input comes from file INFILE (nil means `/dev/null'). |
| 195 | Insert output in BUFFER before point; t means current buffer;\n\ | 195 | Insert output in BUFFER before point; t means current buffer; |
| 196 | nil for BUFFER means discard it; 0 means discard and don't wait.\n\ | 196 | nil for BUFFER means discard it; 0 means discard and don't wait. |
| 197 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,\n\ | 197 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, |
| 198 | REAL-BUFFER says what to do with standard output, as above,\n\ | 198 | REAL-BUFFER says what to do with standard output, as above, |
| 199 | while STDERR-FILE says what to do with standard error in the child.\n\ | 199 | while STDERR-FILE says what to do with standard error in the child. |
| 200 | STDERR-FILE may be nil (discard standard error output),\n\ | 200 | STDERR-FILE may be nil (discard standard error output), |
| 201 | t (mix it with ordinary output), or a file name string.\n\ | 201 | t (mix it with ordinary output), or a file name string. |
| 202 | \n\ | 202 | |
| 203 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\ | 203 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. |
| 204 | Remaining arguments are strings passed as command arguments to PROGRAM.\n\ | 204 | Remaining arguments are strings passed as command arguments to PROGRAM. |
| 205 | \n\ | 205 | |
| 206 | If BUFFER is 0, `call-process' returns immediately with value nil.\n\ | 206 | If BUFFER is 0, `call-process' returns immediately with value nil. |
| 207 | Otherwise it waits for PROGRAM to terminate\n\ | 207 | Otherwise it waits for PROGRAM to terminate |
| 208 | and returns a numeric exit status or a signal description string.\n\ | 208 | and returns a numeric exit status or a signal description string. |
| 209 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.") | 209 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again. */) |
| 210 | (nargs, args) | 210 | (nargs, args) |
| 211 | int nargs; | 211 | int nargs; |
| 212 | register Lisp_Object *args; | 212 | register Lisp_Object *args; |
| 213 | { | 213 | { |
| @@ -971,27 +971,27 @@ delete_temp_file (name) | |||
| 971 | } | 971 | } |
| 972 | 972 | ||
| 973 | DEFUN ("call-process-region", Fcall_process_region, Scall_process_region, | 973 | DEFUN ("call-process-region", Fcall_process_region, Scall_process_region, |
| 974 | 3, MANY, 0, | 974 | 3, MANY, 0, |
| 975 | "Send text from START to END to a synchronous process running PROGRAM.\n\ | 975 | doc: /* Send text from START to END to a synchronous process running PROGRAM. |
| 976 | The remaining arguments are optional.\n\ | 976 | The remaining arguments are optional. |
| 977 | Delete the text if fourth arg DELETE is non-nil.\n\ | 977 | Delete the text if fourth arg DELETE is non-nil. |
| 978 | \n\ | 978 | |
| 979 | Insert output in BUFFER before point; t means current buffer;\n\ | 979 | Insert output in BUFFER before point; t means current buffer; |
| 980 | nil for BUFFER means discard it; 0 means discard and don't wait.\n\ | 980 | nil for BUFFER means discard it; 0 means discard and don't wait. |
| 981 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,\n\ | 981 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, |
| 982 | REAL-BUFFER says what to do with standard output, as above,\n\ | 982 | REAL-BUFFER says what to do with standard output, as above, |
| 983 | while STDERR-FILE says what to do with standard error in the child.\n\ | 983 | while STDERR-FILE says what to do with standard error in the child. |
| 984 | STDERR-FILE may be nil (discard standard error output),\n\ | 984 | STDERR-FILE may be nil (discard standard error output), |
| 985 | t (mix it with ordinary output), or a file name string.\n\ | 985 | t (mix it with ordinary output), or a file name string. |
| 986 | \n\ | 986 | |
| 987 | Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.\n\ | 987 | Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted. |
| 988 | Remaining args are passed to PROGRAM at startup as command args.\n\ | 988 | Remaining args are passed to PROGRAM at startup as command args. |
| 989 | \n\ | 989 | |
| 990 | If BUFFER is nil, `call-process-region' returns immediately with value nil.\n\ | 990 | If BUFFER is nil, `call-process-region' returns immediately with value nil. |
| 991 | Otherwise it waits for PROGRAM to terminate\n\ | 991 | Otherwise it waits for PROGRAM to terminate |
| 992 | and returns a numeric exit status or a signal description string.\n\ | 992 | and returns a numeric exit status or a signal description string. |
| 993 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.") | 993 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again. */) |
| 994 | (nargs, args) | 994 | (nargs, args) |
| 995 | int nargs; | 995 | int nargs; |
| 996 | register Lisp_Object *args; | 996 | register Lisp_Object *args; |
| 997 | { | 997 | { |
| @@ -1406,10 +1406,10 @@ getenv_internal (var, varlen, value, valuelen) | |||
| 1406 | } | 1406 | } |
| 1407 | 1407 | ||
| 1408 | DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 1, 0, | 1408 | DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 1, 0, |
| 1409 | "Return the value of environment variable VAR, as a string.\n\ | 1409 | doc: /* Return the value of environment variable VAR, as a string. |
| 1410 | VAR should be a string. Value is nil if VAR is undefined in the environment.\n\ | 1410 | VAR should be a string. Value is nil if VAR is undefined in the environment. |
| 1411 | This function consults the variable ``process-environment'' for its value.") | 1411 | This function consults the variable ``process-environment'' for its value. */) |
| 1412 | (var) | 1412 | (var) |
| 1413 | Lisp_Object var; | 1413 | Lisp_Object var; |
| 1414 | { | 1414 | { |
| 1415 | char *value; | 1415 | char *value; |
| @@ -1579,50 +1579,50 @@ syms_of_callproc () | |||
| 1579 | #endif /* DOS_NT */ | 1579 | #endif /* DOS_NT */ |
| 1580 | 1580 | ||
| 1581 | DEFVAR_LISP ("shell-file-name", &Vshell_file_name, | 1581 | DEFVAR_LISP ("shell-file-name", &Vshell_file_name, |
| 1582 | "*File name to load inferior shells from.\n\ | 1582 | doc: /* *File name to load inferior shells from. |
| 1583 | Initialized from the SHELL environment variable."); | 1583 | Initialized from the SHELL environment variable. */); |
| 1584 | 1584 | ||
| 1585 | DEFVAR_LISP ("exec-path", &Vexec_path, | 1585 | DEFVAR_LISP ("exec-path", &Vexec_path, |
| 1586 | "*List of directories to search programs to run in subprocesses.\n\ | 1586 | doc: /* *List of directories to search programs to run in subprocesses. |
| 1587 | Each element is a string (directory name) or nil (try default directory)."); | 1587 | Each element is a string (directory name) or nil (try default directory). */); |
| 1588 | 1588 | ||
| 1589 | DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes, | 1589 | DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes, |
| 1590 | "*List of suffixes to try to find executable file names.\n\ | 1590 | doc: /* *List of suffixes to try to find executable file names. |
| 1591 | Each element is a string"); | 1591 | Each element is a string. */); |
| 1592 | Vexec_suffixes = Qnil; | 1592 | Vexec_suffixes = Qnil; |
| 1593 | 1593 | ||
| 1594 | DEFVAR_LISP ("exec-directory", &Vexec_directory, | 1594 | DEFVAR_LISP ("exec-directory", &Vexec_directory, |
| 1595 | "Directory for executables for Emacs to invoke.\n\ | 1595 | doc: /* Directory for executables for Emacs to invoke. |
| 1596 | More generally, this includes any architecture-dependent files\n\ | 1596 | More generally, this includes any architecture-dependent files |
| 1597 | that are built and installed from the Emacs distribution."); | 1597 | that are built and installed from the Emacs distribution. */); |
| 1598 | 1598 | ||
| 1599 | DEFVAR_LISP ("data-directory", &Vdata_directory, | 1599 | DEFVAR_LISP ("data-directory", &Vdata_directory, |
| 1600 | "Directory of machine-independent files that come with GNU Emacs.\n\ | 1600 | doc: /* Directory of machine-independent files that come with GNU Emacs. |
| 1601 | These are files intended for Emacs to use while it runs."); | 1601 | These are files intended for Emacs to use while it runs. */); |
| 1602 | 1602 | ||
| 1603 | DEFVAR_LISP ("doc-directory", &Vdoc_directory, | 1603 | DEFVAR_LISP ("doc-directory", &Vdoc_directory, |
| 1604 | "Directory containing the DOC file that comes with GNU Emacs.\n\ | 1604 | doc: /* Directory containing the DOC file that comes with GNU Emacs. |
| 1605 | This is usually the same as data-directory."); | 1605 | This is usually the same as data-directory. */); |
| 1606 | 1606 | ||
| 1607 | DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory, | 1607 | DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory, |
| 1608 | "For internal use by the build procedure only.\n\ | 1608 | doc: /* For internal use by the build procedure only. |
| 1609 | This is the name of the directory in which the build procedure installed\n\ | 1609 | This is the name of the directory in which the build procedure installed |
| 1610 | Emacs's info files; the default value for Info-default-directory-list\n\ | 1610 | Emacs's info files; the default value for Info-default-directory-list |
| 1611 | includes this."); | 1611 | includes this. */); |
| 1612 | Vconfigure_info_directory = build_string (PATH_INFO); | 1612 | Vconfigure_info_directory = build_string (PATH_INFO); |
| 1613 | 1613 | ||
| 1614 | DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern, | 1614 | DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern, |
| 1615 | "Pattern for making names for temporary files.\n\ | 1615 | doc: /* Pattern for making names for temporary files. |
| 1616 | This is used by `call-process-region'."); | 1616 | This is used by `call-process-region'. */); |
| 1617 | /* This variable is initialized in init_callproc. */ | 1617 | /* This variable is initialized in init_callproc. */ |
| 1618 | 1618 | ||
| 1619 | DEFVAR_LISP ("process-environment", &Vprocess_environment, | 1619 | DEFVAR_LISP ("process-environment", &Vprocess_environment, |
| 1620 | "List of environment variables for subprocesses to inherit.\n\ | 1620 | doc: /* List of environment variables for subprocesses to inherit. |
| 1621 | Each element should be a string of the form ENVVARNAME=VALUE.\n\ | 1621 | Each element should be a string of the form ENVVARNAME=VALUE. |
| 1622 | If multiple entries define the same variable, the first one always\n\ | 1622 | If multiple entries define the same variable, the first one always |
| 1623 | takes precedence.\n\ | 1623 | takes precedence. |
| 1624 | The environment which Emacs inherits is placed in this variable\n\ | 1624 | The environment which Emacs inherits is placed in this variable |
| 1625 | when Emacs starts."); | 1625 | when Emacs starts. */); |
| 1626 | 1626 | ||
| 1627 | #ifndef VMS | 1627 | #ifndef VMS |
| 1628 | defsubr (&Scall_process); | 1628 | defsubr (&Scall_process); |