From: Phil Pennock <pdp@exim.org>
Date: Tue, 14 Feb 2017 23:20:52 +0000 (-0500)
Subject: nit: document that `fout` must be open for reading too
X-Git-Url: https://git.exim.org/users/jgh/exim.git/commitdiff_plain/544dd905b208164eaae771ab6d2a198b4c67aa0c

nit: document that `fout` must be open for reading too
---

diff --git a/src/src/receive.c b/src/src/receive.c
index 5125a4f47..ed2c57ba5 100644
--- a/src/src/receive.c
+++ b/src/src/receive.c
@@ -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
 */