libcruft-util/README.adoc

21 lines
1.1 KiB
Plaintext
Raw Normal View History

2018-06-05 09:35:33 +10:00
== libcruft-util
A simple cross-platform C++ utility library.
Supported compilers: >=clang-5.x, >=gcc7.x; specifically, we require cxx17 features such as structured bindings which aren't present in older compilers. No attempt has been made to compile under MSVC.
=== Environment Variables
The following variables can be defined at runtime to change the library behaviour.
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.
2018-06-05 09:35:33 +10:00
Ideally one would not resort to using these variables, but they may make debugging a little easier in some circumstances.