diff options
author | Matthias Radestock <matthias@rabbitmq.com> | 2012-08-08 05:35:00 +0100 |
---|---|---|
committer | Matthias Radestock <matthias@rabbitmq.com> | 2012-08-08 05:35:00 +0100 |
commit | 986bc8580ab13db5ac7b08ac6431d7dfa1f51d5b (patch) | |
tree | 849a01a0648292f95e190040ce8c4e40aa3581a2 | |
parent | 0b3b4496ad5599a744ebc822a3c84feedc97e7c0 (diff) | |
download | rabbitmq-server-986bc8580ab13db5ac7b08ac6431d7dfa1f51d5b.tar.gz |
restore docs (but reformatted)
-rw-r--r-- | src/rabbit_misc.erl | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/rabbit_misc.erl b/src/rabbit_misc.erl index 31512b67..5eb24327 100644 --- a/src/rabbit_misc.erl +++ b/src/rabbit_misc.erl @@ -396,10 +396,16 @@ report_coverage_percentage(File, Cov, NotCov, Mod) -> confirm_to_sender(Pid, MsgSeqNos) -> gen_server2:cast(Pid, {confirm, MsgSeqNos, self()}). +%% @doc Halts the emulator after printing out an error message +%% io-formatted with the supplied arguments. The exit status of the +%% beam process will be set to 1. quit(Fmt, Args) -> io:format("ERROR: " ++ Fmt ++ "~n", Args), quit(1). +%% @doc Halts the emulator returning the given status code to the os. +%% On Windows this function will block indefinitely so as to give the io +%% subsystem time to flush stdout completely. quit(Status) -> case os:type() of {unix, _} -> halt(Status); |