Add comment about SIGPIPE.

diff --git a/ChangeLog b/ChangeLog
index a4204715c20b0f32c7460368d0c6aeae6ed1e351..c301503c62bdc5534532529ba9b52950c6fe2e13 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-09-28  Bruno Haible  <bruno@clisp.org>
+
+       * lib/pipe.h (create_pipe_out, create_pipe_bidi): Add comment about
+       SIGPIPE.
+
 2008-09-28  Bruno Haible  <bruno@clisp.org>
 
        * tests/test-sigaction.c (handler, main): Disable the check whether

diff --git a/lib/pipe.h b/lib/pipe.h
index b484775fe7456609e029cce83e14845e701e3013..d76e874f3be3959f984e2899f6b2a8b0c92224a7 100644 (file)
--- a/lib/pipe.h
+++ b/lib/pipe.h
@@ -1,5 +1,5 @@
 /* Creation of subprocesses, communicating via pipes.
-   Copyright (C) 2001-2003, 2006 Free Software Foundation, Inc.
+   Copyright (C) 2001-2003, 2006, 2008 Free Software Foundation, Inc.
    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
 
    This program is free software: you can redistribute it and/or modify
@@ -78,6 +78,8 @@ extern "C" {
  *           write       system                read
  *    parent  ->   fd[0]   ->   STDIN_FILENO    ->   child
  *
+ * Note: When writing to a child process, it is useful to ignore the SIGPIPE
+ * signal and the EPIPE error code.
  */
 extern pid_t create_pipe_out (const char *progname,
                              const char *prog_path, char **prog_argv,
@@ -105,6 +107,8 @@ extern pid_t create_pipe_in (const char *progname,
  *    parent  <-   fd[0]   <-   STDOUT_FILENO   <-   child
  *           read        system                write
  *
+ * Note: When writing to a child process, it is useful to ignore the SIGPIPE
+ * signal and the EPIPE error code.
  */
 extern pid_t create_pipe_bidi (const char *progname,
                               const char *prog_path, char **prog_argv,