docs: tell what ORC_CODE=debug is for
authorStefan Kost <ensonic@users.sf.net>
Wed, 23 Feb 2011 10:31:35 +0000 (12:31 +0200)
committerDavid Schleef <ds@schleef.org>
Wed, 18 May 2011 19:28:21 +0000 (12:28 -0700)
doc/running.xml

index dfb0ccf..496cbf5 100644 (file)
@@ -42,8 +42,10 @@ At runtime several environment variables can be used to control ORC.
   <para>
     This variable can be set to a comma separated list of flags to control the
     code selection and execution. Supported values are: backup, emulate and
-    debug. 'Backup' would instruct ORC to select the C based backup functions.
-    'Emulate' will run the ORC code through an interpreter.
+    debug. The value 'backup' would instruct ORC to select the C based backup
+    functions. Selecting 'emulate' will run the ORC code through an interpreter.
+    Using 'debug' enables debuggers such as gdb to create useful backtraces from
+    ORC-generated code
   </para>
 </formalpara>