X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=lib%2Fclose-stream.c;h=59ab616b1ea43eb3ccef77aed89d13175bec4607;hb=cf7169a2ede9bb08b71de68fe0c8bbecf827abe6;hp=e2c3ac0cc4493dfec9710fe68c8a8cc6eeacf6fb;hpb=138fc7e67e3d9845cd7d81aad0e9c7724784f9b9;p=tar

diff --git a/lib/close-stream.c b/lib/close-stream.c
index e2c3ac0..59ab616 100644
--- a/lib/close-stream.c
+++ b/lib/close-stream.c
@@ -1,6 +1,6 @@
 /* Close a stream, with nicer error checking than fclose's.
 
-   Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2006, 2007 Free
+   Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2006, 2007, 2008 Free
    Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
@@ -33,6 +33,10 @@
    otherwise.  A failure might set errno to 0 if the error number
    cannot be determined.
 
+   A failure with errno set to EPIPE may or may not indicate an error
+   situation worth signaling to the user.  See the documentation of the
+   close_stdout_set_ignore_EPIPE function for details.
+
    If a program writes *anything* to STREAM, that program should close
    STREAM and make sure that it succeeds before exiting.  Otherwise,
    suppose that you go to the extreme of checking the return status