From 5cc92ffd70ab649e5f61a33b0b9153848af06644 Mon Sep 17 00:00:00 2001 From: David Adam Date: Fri, 28 Sep 2018 22:57:02 +0800 Subject: [PATCH] Documentation for while: note new exit status changes Work on #4982. --- doc_src/while.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc_src/while.txt b/doc_src/while.txt index d8bd012e4..38338792f 100644 --- a/doc_src/while.txt +++ b/doc_src/while.txt @@ -9,7 +9,10 @@ while CONDITION; COMMANDS...; end `while` repeatedly executes `CONDITION`, and if the exit status is 0, then executes `COMMANDS`. -If the exit status of `CONDITION` is non-zero on the first iteration, `COMMANDS` will not be executed at all. +If the exit status of `CONDITION` is non-zero on the first iteration, `COMMANDS` will not be +executed at all, and the exit status of the loop set to the exit status of `CONDITION`. + +The exit status of the loop is 0 otherwise. You can use `and` or `or` for complex conditions. Even more complex control can be achieved with `while true` containing a break.