diff options
| author | Jonathan Tan <jonathantanmy@google.com> | 2017-07-26 18:17:28 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-07-26 19:56:40 (GMT) |
| commit | 7e2e1bbb24a5a0868fc83f1eddf804574f9e4b54 (patch) | |
| tree | e3b2fd937f6b834e198441e4f1747ce0e530ac22 /Documentation/technical/api-sub-process.txt | |
| parent | 487fe1ffcd3b3a38477b7e564f235bb7d1b89ecc (diff) | |
| download | git-7e2e1bbb24a5a0868fc83f1eddf804574f9e4b54.zip git-7e2e1bbb24a5a0868fc83f1eddf804574f9e4b54.tar.gz git-7e2e1bbb24a5a0868fc83f1eddf804574f9e4b54.tar.bz2 | |
Documentation: migrate sub-process docs to header
Move the documentation for the sub-process API from a separate txt file
to its header file.
Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-sub-process.txt')
| -rw-r--r-- | Documentation/technical/api-sub-process.txt | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/Documentation/technical/api-sub-process.txt b/Documentation/technical/api-sub-process.txt deleted file mode 100644 index 793508c..0000000 --- a/Documentation/technical/api-sub-process.txt +++ /dev/null @@ -1,59 +0,0 @@ -sub-process API -=============== - -The sub-process API makes it possible to run background sub-processes -for the entire lifetime of a Git invocation. If Git needs to communicate -with an external process multiple times, then this can reduces the process -invocation overhead. Git and the sub-process communicate through stdin and -stdout. - -The sub-processes are kept in a hashmap by command name and looked up -via the subprocess_find_entry function. If an existing instance can not -be found then a new process should be created and started. When the -parent git command terminates, all sub-processes are also terminated. - -This API is based on the run-command API. - -Data structures ---------------- - -* `struct subprocess_entry` - -The sub-process structure. Members should not be accessed directly. - -Types ------ - -'int(*subprocess_start_fn)(struct subprocess_entry *entry)':: - - User-supplied function to initialize the sub-process. This is - typically used to negotiate the interface version and capabilities. - - -Functions ---------- - -`cmd2process_cmp`:: - - Function to test two subprocess hashmap entries for equality. - -`subprocess_start`:: - - Start a subprocess and add it to the subprocess hashmap. - -`subprocess_stop`:: - - Kill a subprocess and remove it from the subprocess hashmap. - -`subprocess_find_entry`:: - - Find a subprocess in the subprocess hashmap. - -`subprocess_get_child_process`:: - - Get the underlying `struct child_process` from a subprocess. - -`subprocess_read_status`:: - - Helper function to read packets looking for the last "status=<foo>" - key/value pair. |