X-Git-Url: https://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=README.md;h=461574617f8abd4a92054fbe4a5b0c45d5e4d9b5;hp=7ce0edfeec0ef4203e286a4661eac6f7dd9ddeb1;hb=d4e640c06c2c999d5fc8f8375bc2f61da06c9cda;hpb=7fe7e9f353c3596b78b6bed1f4267037de750a48 diff --git a/README.md b/README.md index 7ce0edf..4615746 100644 --- a/README.md +++ b/README.md @@ -358,12 +358,19 @@ can be forced by specifying `--disable-compiler-tls` as configure argument. -### Usage of `DEBUG_RCU` +### Usage of `DEBUG_RCU` & `--enable-rcu-debug` -`DEBUG_RCU` is used to add internal debugging self-checks to the -RCU library. This define adds a performance penalty when enabled. -Can be enabled by uncommenting the corresponding line in -`Makefile.build.inc`. +By default the library is configured with internal debugging +self-checks disabled. + +For always-on debugging self-checks: + ./configure --enable-rcu-debug + +For fine grained enabling of debugging self-checks, build +urserspace-rcu with DEBUG_RCU defined and compile dependent +applications with DEBUG_RCU defined when necessary. + +Warning: Enabling this feature result in a performance penalty. ### Usage of `DEBUG_YIELD`