nit: document that `fout` must be open for reading too
authorPhil Pennock <pdp@exim.org>
Tue, 14 Feb 2017 23:20:52 +0000 (18:20 -0500)
committerPhil Pennock <pdp@exim.org>
Tue, 14 Feb 2017 23:20:52 +0000 (18:20 -0500)
src/src/receive.c

index 5125a4f..ed2c57b 100644 (file)
@@ -906,7 +906,8 @@ a cut-down version of the state-machine above; we don't need to do leading-dot
 detection and unstuffing.
 
 Arguments:
-  fout      a FILE to which to write the message; NULL if skipping
+  fout      a FILE to which to write the message; NULL if skipping;
+            must be open for both writing and reading.
 
 Returns:    One of the END_xxx values indicating why it stopped reading
 */