summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhil Pennock <pdp@exim.org>2017-02-14 18:20:52 -0500
committerPhil Pennock <pdp@exim.org>2017-02-14 18:20:52 -0500
commit544dd905b208164eaae771ab6d2a198b4c67aa0c (patch)
tree27c5a6284991b61dd39bf1273d2fd86fbf82e9bc
parentd953610fa77ec9a08fad9c1a183181079a79674e (diff)
nit: document that `fout` must be open for reading too
-rw-r--r--src/src/receive.c3
1 files changed, 2 insertions, 1 deletions
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
*/