1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 11:40:18 +02:00

Document quit and exit

* doc/ref/posix.texi (Processes): document `quit' and `exit'
* doc/ref/r6rs.texi (rnrs programs): xref exit
This commit is contained in:
Mike Gran 2013-03-21 09:20:31 -07:00
parent edb6de0bec
commit 14ae4725ab
2 changed files with 15 additions and 3 deletions

View file

@ -1718,6 +1718,18 @@ interpretation is not required.
Example: (system* "echo" "foo" "bar")
@end deffn
@deffn {Scheme Procedure} quit [status]
@deffnx {Scheme Procedure} exit [status]
Terminate the current process with proper unwinding of the Scheme stack.
The exit status zero if @var{status} is not supplied. If @var{status}
is supplied, and it is an integer, that integer is used as the exit
status. If @var{status} is @code{#t} or @code{#f}, the exit status is 0
or 1, respectively.
The procedure @code{exit} is an alias of @code{quit}. They have the
same functionality.
@end deffn
@deffn {Scheme Procedure} primitive-exit [status]
@deffnx {Scheme Procedure} primitive-_exit [status]
@deffnx {C Function} scm_primitive_exit (status)

View file

@ -1521,9 +1521,9 @@ This procedure is identical to the one provided by Guile's core library.
@xref{Runtime Environment}, for documentation.
@end deffn
@deffn {Scheme Procedure} exit
@deffnx {Scheme Procedure} exit obj
This procedure is identical to the one provided by Guile's core library.
@deffn {Scheme Procedure} exit [status]
This procedure is identical to the one provided by Guile's core
library. @xref{Processes}, for documentation.
@end deffn
@node rnrs arithmetic fixnums