README: note all the environment variables we use.

This commit is contained in:
Danny Robson 2018-03-27 16:21:38 +11:00
parent 47613c5ec2
commit 5642ff43b8

10
README.asc Normal file
View File

@ -0,0 +1,10 @@
environment variables:
DEBUG:: whether to initialise basic debugging features at load time. the value is irrelevant; the test is for whether the variable is defined.
DEBUG_WAIT:: whether to wait for a debugger to attach before executing `main`.
LOG_LEVEL:: minimum log level that will render to the logging stream. note that a given level may have been compiled out and may not be present, eg. DEBUG tends to only be present for debug builds.
BREAK_LEVEL:: minimum log level that will trigger a breakpoint
JOB_THREADS:: default number of threads to spin up for job queues.
JOB_DEPTH:: the default size of the pending work item queue for a job queue.