Commit f42a4472 authored by Colin Watson's avatar Colin Watson
Browse files

pipeline_start: Document that standard FDs must be open

Fixes Ubuntu bug #992271.

* lib/pipeline.h (pipeline_start): Document that FDs 0, 1, and 2 must be
open before calling this function.
* man/libpipeline.3 (pipeline_start): Likewise.
parent eceb4fc9
......@@ -384,8 +384,12 @@ typedef void pipeline_post_fork_fn (void);
*/
void pipeline_install_post_fork (pipeline_post_fork_fn *fn);
/* Start the processes in a pipeline. Installs this library's SIGCHLD
* handler if not already installed. Calls error(FATAL) on error. */
/* Start the processes in a pipeline. Installs this library's SIGCHLD
* handler if not already installed. Calls error(FATAL) on error.
*
* The standard file descriptors (0, 1, and 2) must be open before calling
* this function.
*/
void pipeline_start (pipeline *p);
/* Wait for a pipeline to complete. Set *statuses to a newly-allocated
......
......@@ -547,6 +547,9 @@ Calls
.Li error (FATAL)
on error.
.Pp
The standard file descriptors (0, 1, and 2) must be open before calling this
function.
.Pp
.It Xo
.Ft int Fn pipeline_wait_all "pipeline *p" "int **statuses" "int *n_statuses"
.Xc
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment