Merge branch 'jc/checkout-local-track-report'
[gitweb.git] / Documentation / technical / api-run-command.txt
index 842b8389eb867b6db654cf7fe29e8f10b92b259e..a9fdb45b93e514962716401cb22d9d079b107e40 100644 (file)
@@ -13,7 +13,7 @@ produces in the caller in order to process it.
 Functions
 ---------
 
-`child_process_init`
+`child_process_init`::
 
        Initialize a struct child_process variable.
 
@@ -169,6 +169,11 @@ string pointers (NULL terminated) in .env:
 . If the string does not contain '=', it names an environment
   variable that will be removed from the child process's environment.
 
+If the .env member is NULL, `start_command` will point it at the
+.env_array `argv_array` (so you may use one or the other, but not both).
+The memory in .env_array will be cleaned up automatically during
+`finish_command` (or during `start_command` when it is unsuccessful).
+
 To specify a new initial working directory for the sub-process,
 specify it in the .dir member.