diff --git a/doc/ref/mloop.xml b/doc/ref/mloop.xml index 1fbd52d7b6..c50f7357f3 100644 --- a/doc/ref/mloop.xml +++ b/doc/ref/mloop.xml @@ -989,10 +989,13 @@ or brk> or brk_nn> prompt. -A GapExitCode sets the return value which will be used when -⪆ exits. This may be an integer, or a boolean (where -true is interpreted as 0, and -false is interpreted as 1. +GapExitCode sets the exit value which is returned +to the operating system (or parent process) when ⪆ exits. +This may be an integer in the range [-128..127] (other values +are reduced modulo 256), or a boolean. true corresponds +to the return value 0, which by convention is treated as "success". +false corresponds to the return value 1, which by convention +is treated as "failure".

@@ -1001,9 +1004,10 @@ A GapExitCode sets the return value which will be used when -A QuitGap acts similarly to the keyword quit. It exits +A QuitGap acts similarly to the keyword QUIT, except +QUIT can not be called from a function. It exits ⪆ cleanly, calling any function installed using InstallAtExit. -The optional argument will be passed to GapExitCode. +The optional argument ret will be passed to GapExitCode.

@@ -1014,8 +1018,9 @@ The optional argument will be passed to GapExitCode. A ForceQuitGap is similar to QuitGap, except it ignores any functions installed with InstallAtExit, or any other functions -normally run at GAP exit, and exits GAP immediately. -The optional argument will be passed to GapExitCode. +normally run at GAP exit, such as flushing any partially outputted lines +to both the screen and files, and exits GAP immediately. +The optional argument ret will be passed to GapExitCode.

@@ -1434,4 +1439,3 @@ interpret. -