Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up and document exit-code handling #150

Merged
merged 1 commit into from
Apr 6, 2015
Merged

Clean up and document exit-code handling #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions doc/ref/mloop.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,6 +961,41 @@ or <C>brk></C> or <C>brk_<A>nn</A>></C> prompt.
</Description>
</ManSection>

<ManSection>
<Func Name="GAP_EXIT_CODE" Arg='ret'/>

<Description>
A <C>GAP_EXIT_CODE</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.
<P/>
</Description>
</ManSection>

<ManSection>
<Func Name="QUIT_GAP" Arg='[ret]'/>

<Description>
A <C>QUIT_GAP</C> acts similarly to the keyword <C>quit</C>. It exits
&GAP; cleanly, calling any function installed using <C>InstallAtExit</C>.
The optional argument will be passed to <C>GAP_EXIT_CODE</C>.
<P/>
</Description>
</ManSection>

<ManSection>
<Func Name="FORCE_QUIT_GAP" Arg='[ret]'/>

<Description>
A <C>FORCE_QUIT_GAP</C> is similar to <C>QUIT_GAP</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>GAP_EXIT_CODE</C>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better to put a proper cross-reference here (and above), replacing <C>GAP_EXIT_CODE</C> by <Ref Func="GAP_EXIT_CODE"/> ?

<P/>
</Description>
</ManSection>


<ManSection>
<Func Name="InstallAtExit" Arg='func'/>
Expand Down