I'm using morituri in an environment (Mac OS) where lots of things go wrong. I would like to see a log file with detailed diagnostics. The documentation doesn't say anything about how to make this happen. But clearly the code is ready to make it happen; it is rich in logging statements.
Expected behaviour:
Nothing in the usual end-user documentation describing how to turn on logging. There's a passing reference in HACKING, but it's not reasonable to expect end users to read that.
Expected behaviour:
Brief but clear statement in README.md and/or in manpage and/or in runtime help (rip -h) which tells how to use RIP_DEBUG and how to generate log files.
Other information:
Spoiler alert: You turn on logging by setting an environment variable RIP_DEBUG to a integer value from 1 to 5, where 1 shows only the severe errors and 5 logs almost every sniffle and hiccup of the program.
On Linux (bash shell) an easy way to set this variable is by putting it before your morituri command: RIP_DEBUG=5 rip help. On MacOS (tcsh shell) , this prefix doesn't work, so use setenv:
setenv RIP_DEBUG 4
rip help
On Windows, use set, which requires an equals sign:
set RIP_DEBUG=3
rip help
I intend to offer a patch to README.md to describe this much. I haven't figured out yet if it's possible to redirect the log output to a file, so I can't document that.
I'm using morituri in an environment (Mac OS) where lots of things go wrong. I would like to see a log file with detailed diagnostics. The documentation doesn't say anything about how to make this happen. But clearly the code is ready to make it happen; it is rich in logging statements.
Expected behaviour:
Nothing in the usual end-user documentation describing how to turn on logging. There's a passing reference in HACKING, but it's not reasonable to expect end users to read that.
Expected behaviour:
Brief but clear statement in README.md and/or in manpage and/or in runtime help (
rip -h
) which tells how to use RIP_DEBUG and how to generate log files.Other information:
Spoiler alert: You turn on logging by setting an environment variable RIP_DEBUG to a integer value from 1 to 5, where 1 shows only the severe errors and 5 logs almost every sniffle and hiccup of the program.
On Linux (bash shell) an easy way to set this variable is by putting it before your morituri command:
RIP_DEBUG=5 rip help
. On MacOS (tcsh shell) , this prefix doesn't work, so use setenv:On Windows, use set, which requires an equals sign:
I intend to offer a patch to README.md to describe this much. I haven't figured out yet if it's possible to redirect the log output to a file, so I can't document that.