Skip to content

Commit

Permalink
Slightly improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisJefferson authored and fingolfin committed May 14, 2020
1 parent 5e12356 commit 8ded9de
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions doc/ref/mloop.xml
Original file line number Diff line number Diff line change
Expand Up @@ -989,10 +989,13 @@ or <C>brk></C> or <C>brk_<A>nn</A>></C> prompt.
<Func Name="GapExitCode" Arg='ret'/>

<Description>
A <C>GapExitCode</C> sets the return value which will be used when
&GAP; exits. This may be an integer, or a boolean (where
<K>true</K> is interpreted as 0, and
<K>false</K> is interpreted as 1.
<C>GapExitCode</C> sets the exit value which is returned
to the operating system (or parent process) when &GAP; exits.
This may be an integer in the range [-128..127] (other values
are reduced modulo 256), or a boolean. <K>true</K> corresponds
to the return value 0, which by convention is treated as "success".
<K>false</K> corresponds to the return value 1, which by convention
is treated as "failure".
<P/>
</Description>
</ManSection>
Expand All @@ -1001,9 +1004,10 @@ A <C>GapExitCode</C> sets the return value which will be used when
<Func Name="QuitGap" Arg='[ret]'/>

<Description>
A <C>QuitGap</C> acts similarly to the keyword <C>quit</C>. It exits
A <C>QuitGap</C> acts similarly to the keyword <C>QUIT</C>, except
<C>QUIT</C> can not be called from a function. It exits
&GAP; cleanly, calling any function installed using <C>InstallAtExit</C>.
The optional argument will be passed to <C>GapExitCode</C>.
The optional argument <A>ret</A> will be passed to <C>GapExitCode</C>.
<P/>
</Description>
</ManSection>
Expand All @@ -1014,8 +1018,9 @@ The optional argument will be passed to <C>GapExitCode</C>.
<Description>
A <C>ForceQuitGap</C> is similar to <C>QuitGap</C>, except it ignores any
functions installed with <C>InstallAtExit</C>, or any other functions
normally run at GAP exit, and exits GAP immediately.
The optional argument will be passed to <C>GapExitCode</C>.
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 <A>ret</A> will be passed to <C>GapExitCode</C>.
<P/>
</Description>
</ManSection>
Expand Down Expand Up @@ -1434,4 +1439,3 @@ interpret.
<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<!-- %% -->
<!-- %E -->

0 comments on commit 8ded9de

Please sign in to comment.