Merge pull request #179 from dotjrich/debug-docs

Adds ability to control block and stack debug output via CMake

CMakeLists.txt

@@ -4,6 +4,18 @@ cmake_minimum_required(VERSION 3.1)
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+# Debug options.
+option(ENABLE_BLOCK_DEBUG "Enable block debugging" OFF)
+option(ENABLE_STACK_DEBUG "Enable stack debugging" OFF)
+
+# Turn debug defs on if they're enabled.
+if (ENABLE_BLOCK_DEBUG)
+    add_definitions(-DBLOCK_DEBUG)
+endif()
+if (ENABLE_STACK_DEBUG)
+    add_definitions(-DSTACK_DEBUG)
+endif()
+
 # For generating the bytes tables
 find_package(PythonInterp REQUIRED)
 

README.markdown

@@ -15,10 +15,18 @@ https://github.com/zrax/pycdc
 
 ## Building Decompyle++
 * Generate a project or makefile with [CMake](http://www.cmake.org) (See CMake's documentation for details)
+  * The following options can be passed to CMake to control debug features:
+
+    | Option | Description |
+    | --- | --- |
+    | `-DCMAKE_BUILD_TYPE=Debug` | Produce debugging symbols |
+    | `-DENABLE_BLOCK_DEBUG=ON` | Enable block debugging output |
+    | `-DENABLE_STACK_DEBUG=ON` | Enable stack debugging output |
+
 * Build the generated project or makefile
   * For projects (e.g. MSVC), open the generated project file and build it
   * For makefiles, just run `make`
-  * To run tests (on \*nix or MSYS), run `make test`
+  * To run tests (on \*nix or MSYS), run `make check`
 
 ## Usage
 **To run pycdas**, the PYC Disassembler: