Skip to content

Commit 42e5fd8

Browse files
authored
Expand System.stop/1 docs on binary exit status (#11322)
1 parent 29d36f2 commit 42e5fd8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

lib/elixir/lib/system.ex

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -855,8 +855,13 @@ defmodule System do
855855
All applications are taken down smoothly, all code is unloaded, and all ports
856856
are closed before the system terminates by calling `halt/1`.
857857
858-
`status` must be a non-negative integer value which is returned by the
859-
runtime system to the operating system.
858+
`status` must be a non-negative integer or a binary.
859+
860+
* If an integer, the runtime system exits with the integer value which is
861+
returned to the operating system.
862+
863+
* If a binary, an Erlang crash dump is produced with status as slogan, and
864+
then the runtime system exits with status code 1.
860865
861866
Note that on many platforms, only the status codes 0-255 are supported
862867
by the operating system.

0 commit comments

Comments
 (0)