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:24:29 -0500
commit58768f6ce3837ddc2e47e04e60527a0da85d77d5 (patch)
tree00620d795c1849e83b199f986d78faccbd389bd8
parent5db00eeac41e74cb9749b6344258b38b1da8c700 (diff)
downloadexim4-58768f6ce3837ddc2e47e04e60527a0da85d77d5.tar.gz
nit: document that `fout` must be open for reading too
(cherry picked from commit 544dd905b208164eaae771ab6d2a198b4c67aa0c) Signed-off-by: Phil Pennock <pdp@exim.org>
-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
*/