2c3e2050ff776ba94c746ebf007d17db7edd1998 markd Thu Apr 6 09:45:12 2023 -0700 updated pipelineOpen function documentation to clear describe otherEndFile argument diff --git src/inc/pipeline.h src/inc/pipeline.h index 441148e..9ed2e94 100644 --- src/inc/pipeline.h +++ src/inc/pipeline.h @@ -85,33 +85,35 @@ unsigned int timeout); /* Create a pipeline from an array of commands. Each command is an array of * arguments. Shell expansion is not done on the arguments. If pipelineRead * is specified, the output of the pipeline is readable from the pipeline * object. If pipelineWrite is specified, the input of the pipeline is * writable from the pipeline object. If timeout is > 0, pipeline is killed * after timeout seconds. */ struct pipeline *pipelineOpen(char ***cmds, unsigned opts, char *otherEndFile, char *stderrFile, unsigned int timeout); /* Create a pipeline from an array of commands. Each command is an array of * arguments. Shell expansion is not done on the arguments. If pipelineRead * is specified, the output of the pipeline is readable from the pipeline * object. If pipelineWrite is specified, the input of the pipeline is - * writable from the pipeline object. If stderrFile is NULL, stderr is inherited, - * otherwise it is redirected to this file. If timeout is > 0, pipeline is killed - * after timeout seconds. + * writable from the pipeline object. Specify otherEndFile as "/dev/null" for + * no input or no output (or to discard output). If otherEndFile is NULL, + * then either stdin or stdout are inherited from the current process. If + * stderrFile is NULL, stderr is inherited, otherwise it is redirected to this + * file. If timeout is > 0, pipeline is killed after timeout seconds. */ void pipelineDumpCmds(char ***cmds); /* Dump out pipeline-formatted commands to stdout for debugging. */ struct pipeline *pipelineOpenMem(char ***cmds, unsigned opts, void *otherEndBuf, size_t otherEndBufSize, int stderrFd, unsigned int timeout); /* Create a pipeline from an array of commands, with the pipeline input/output * in a memory buffer. See pipeline.h for full documentation. Currently only * input to a read pipeline is supported If timeout is > 0, pipeline is killed * after timeout seconds. */ struct pipeline *pipelineOpenFd1(char **cmd, unsigned opts, int otherEndFd, int stderrFd,