Update draft release notes to 1.7.0
[git/jnareb-git/bp-gitweb.git] / Documentation / technical / api-run-command.txt
blobb26c28133c143b23acf28fc1a3a06d16c10c65f8
1 run-command API
2 ===============
4 The run-command API offers a versatile tool to run sub-processes with
5 redirected input and output as well as with a modified environment
6 and an alternate current directory.
8 A similar API offers the capability to run a function asynchronously,
9 which is primarily used to capture the output that the function
10 produces in the caller in order to process it.
13 Functions
14 ---------
16 `start_command`::
18         Start a sub-process. Takes a pointer to a `struct child_process`
19         that specifies the details and returns pipe FDs (if requested).
20         See below for details.
22 `finish_command`::
24         Wait for the completion of a sub-process that was started with
25         start_command().
27 `run_command`::
29         A convenience function that encapsulates a sequence of
30         start_command() followed by finish_command(). Takes a pointer
31         to a `struct child_process` that specifies the details.
33 `run_command_v_opt`, `run_command_v_opt_cd_env`::
35         Convenience functions that encapsulate a sequence of
36         start_command() followed by finish_command(). The argument argv
37         specifies the program and its arguments. The argument opt is zero
38         or more of the flags `RUN_COMMAND_NO_STDIN`, `RUN_GIT_CMD`,
39         `RUN_COMMAND_STDOUT_TO_STDERR`, or `RUN_SILENT_EXEC_FAILURE`
40         that correspond to the members .no_stdin, .git_cmd,
41         .stdout_to_stderr, .silent_exec_failure of `struct child_process`.
42         The argument dir corresponds the member .dir. The argument env
43         corresponds to the member .env.
45 The functions above do the following:
47 . If a system call failed, errno is set and -1 is returned. A diagnostic
48   is printed.
50 . If the program was not found, then -1 is returned and errno is set to
51   ENOENT; a diagnostic is printed only if .silent_exec_failure is 0.
53 . Otherwise, the program is run. If it terminates regularly, its exit
54   code is returned. No diagnistic is printed, even if the exit code is
55   non-zero.
57 . If the program terminated due to a signal, then the return value is the
58   signal number - 128, ie. it is negative and so indicates an unusual
59   condition; a diagnostic is printed. This return value can be passed to
60   exit(2), which will report the same code to the parent process that a
61   POSIX shell's $? would report for a program that died from the signal.
64 `start_async`::
66         Run a function asynchronously. Takes a pointer to a `struct
67         async` that specifies the details and returns a pipe FD
68         from which the caller reads. See below for details.
70 `finish_async`::
72         Wait for the completion of an asynchronous function that was
73         started with start_async().
75 `run_hook`::
77         Run a hook.
78         The first argument is a pathname to an index file, or NULL
79         if the hook uses the default index file or no index is needed.
80         The second argument is the name of the hook.
81         The further arguments correspond to the hook arguments.
82         The last argument has to be NULL to terminate the arguments list.
83         If the hook does not exist or is not executable, the return
84         value will be zero.
85         If it is executable, the hook will be executed and the exit
86         status of the hook is returned.
87         On execution, .stdout_to_stderr and .no_stdin will be set.
88         (See below.)
91 Data structures
92 ---------------
94 * `struct child_process`
96 This describes the arguments, redirections, and environment of a
97 command to run in a sub-process.
99 The caller:
101 1. allocates and clears (memset(&chld, 0, sizeof(chld));) a
102    struct child_process variable;
103 2. initializes the members;
104 3. calls start_command();
105 4. processes the data;
106 5. closes file descriptors (if necessary; see below);
107 6. calls finish_command().
109 The .argv member is set up as an array of string pointers (NULL
110 terminated), of which .argv[0] is the program name to run (usually
111 without a path). If the command to run is a git command, set argv[0] to
112 the command name without the 'git-' prefix and set .git_cmd = 1.
114 The members .in, .out, .err are used to redirect stdin, stdout,
115 stderr as follows:
117 . Specify 0 to request no special redirection. No new file descriptor
118   is allocated. The child process simply inherits the channel from the
119   parent.
121 . Specify -1 to have a pipe allocated; start_command() replaces -1
122   by the pipe FD in the following way:
124         .in: Returns the writable pipe end into which the caller writes;
125                 the readable end of the pipe becomes the child's stdin.
127         .out, .err: Returns the readable pipe end from which the caller
128                 reads; the writable end of the pipe end becomes child's
129                 stdout/stderr.
131   The caller of start_command() must close the so returned FDs
132   after it has completed reading from/writing to it!
134 . Specify a file descriptor > 0 to be used by the child:
136         .in: The FD must be readable; it becomes child's stdin.
137         .out: The FD must be writable; it becomes child's stdout.
138         .err > 0 is not supported.
140   The specified FD is closed by start_command(), even if it fails to
141   run the sub-process!
143 . Special forms of redirection are available by setting these members
144   to 1:
146         .no_stdin, .no_stdout, .no_stderr: The respective channel is
147                 redirected to /dev/null.
149         .stdout_to_stderr: stdout of the child is redirected to its
150                 stderr. This happens after stderr is itself redirected.
151                 So stdout will follow stderr to wherever it is
152                 redirected.
154 To modify the environment of the sub-process, specify an array of
155 string pointers (NULL terminated) in .env:
157 . If the string is of the form "VAR=value", i.e. it contains '='
158   the variable is added to the child process's environment.
160 . If the string does not contain '=', it names an environment
161   variable that will be removed from the child process's environment.
163 To specify a new initial working directory for the sub-process,
164 specify it in the .dir member.
166 If the program cannot be found, the functions return -1 and set
167 errno to ENOENT. Normally, an error message is printed, but if
168 .silent_exec_failure is set to 1, no message is printed for this
169 special error condition.
172 * `struct async`
174 This describes a function to run asynchronously, whose purpose is
175 to produce output that the caller reads.
177 The caller:
179 1. allocates and clears (memset(&asy, 0, sizeof(asy));) a
180    struct async variable;
181 2. initializes .proc and .data;
182 3. calls start_async();
183 4. processes the data by reading from the fd in .out;
184 5. closes .out;
185 6. calls finish_async().
187 The function pointer in .proc has the following signature:
189         int proc(int fd, void *data);
191 . fd specifies a writable file descriptor to which the function must
192   write the data that it produces. The function *must* close this
193   descriptor before it returns.
195 . data is the value that the caller has specified in the .data member
196   of struct async.
198 . The return value of the function is 0 on success and non-zero
199   on failure. If the function indicates failure, finish_async() will
200   report failure as well.
203 There are serious restrictions on what the asynchronous function can do
204 because this facility is implemented by a pipe to a forked process on
205 UNIX, but by a thread in the same address space on Windows:
207 . It cannot change the program's state (global variables, environment,
208   etc.) in a way that the caller notices; in other words, .out is the
209   only communication channel to the caller.
211 . It must not change the program's state that the caller of the
212   facility also uses.