BLD Keep debug builds optimized

Author: luispedro

Makefile

@@ -1,10 +1,10 @@
 PIP_EDITABLE = python -m pip install --editable . --no-deps --no-build-isolation
 
 debug: mahotas/*.cpp mahotas/*.h mahotas/*.hpp
-	$(PIP_EDITABLE) --config-settings=build-dir=build/debug --config-settings=setup-args=-Dbuildtype=debug --config-settings=setup-args=-Dglibcpp_debug=true
+	$(PIP_EDITABLE) --config-settings=build-dir=build/debug --config-settings=setup-args=-Dbuildtype=release --config-settings=setup-args=-Db_ndebug=false --config-settings=setup-args=-Dglibcpp_debug=true
 
 debug3: mahotas/*.cpp mahotas/*.h mahotas/*.hpp
-	python3 -m pip install --editable . --no-deps --no-build-isolation --config-settings=build-dir=build/debug --config-settings=setup-args=-Dbuildtype=debug --config-settings=setup-args=-Dglibcpp_debug=true
+	python3 -m pip install --editable . --no-deps --no-build-isolation --config-settings=build-dir=build/debug --config-settings=setup-args=-Dbuildtype=release --config-settings=setup-args=-Db_ndebug=false --config-settings=setup-args=-Dglibcpp_debug=true
 
 fast: mahotas/*.cpp mahotas/*.h mahotas/*.hpp
 	$(PIP_EDITABLE) --config-settings=build-dir=build/fast --config-settings=setup-args=-Dbuildtype=release

README.md

@@ -193,9 +193,9 @@ Development happens on github
 ([https://github.com/luispedro/mahotas](https://github.com/luispedro/mahotas)).
 
 The `Makefile` that is shipped with the source of mahotas can be useful
-too. `make debug` rebuilds the editable install with a Meson debug build and
-enables `_GLIBCXX_DEBUG`. `make fast` rebuilds it in release mode. `make tests`
-runs the test suite after a debug rebuild.
+too. `make debug` rebuilds the editable install in optimized mode while keeping
+assertions enabled and adding `_GLIBCXX_DEBUG`. `make fast` rebuilds it in
+plain release mode. `make tests` runs the test suite after a debug rebuild.
 
 ```bash
 make debug
@@ -208,12 +208,13 @@ If you want the equivalent of the old `DEBUG=1` build without
 ```bash
 python -m pip install -e . --no-deps --no-build-isolation \
   --config-settings=build-dir=build/debug \
-  --config-settings=setup-args=-Dbuildtype=debug
+  --config-settings=setup-args=-Dbuildtype=release \
+  --config-settings=setup-args=-Db_ndebug=false
 ```
 
 Be careful not to use the debug build in production unless you are chasing a
-bug. The `_GLIBCXX_DEBUG` configuration used by `make debug` is very slow as it
-adds many runtime checks.
+bug. The `_GLIBCXX_DEBUG` configuration used by `make debug` can still be much
+slower than a plain release build because it adds many runtime checks.
 
 ## Links & Contacts
 

docs/source/contributing.rst

@@ -23,13 +23,13 @@ of runtime checks.
 
 There are two levels:
 
-1.  A Meson ``debug`` build turns on assertions. The code will run slower, but
+1.  A release build with ``b_ndebug=false`` turns on assertions. The code will run slower, but
     probably not noticeably slower, except for very large images.
-2.  ``make debug`` uses a Meson ``debug`` build and additionally defines
-    ``_GLIBCXX_DEBUG``. This only has an effect with libstdc++, but when
-    available it enables checked iterators in the C++ standard library. The
-    result will be code that runs **much slower** as many iterator operations
-    are now checked. However, it catches many errors.
+2.  ``make debug`` uses an optimized release build with assertions enabled and
+    additionally defines ``_GLIBCXX_DEBUG``. This only has an effect with
+    libstdc++, but when available it enables checked iterators in the C++
+    standard library. The result can still be **much slower** as many iterator
+    operations are now checked. However, it catches many errors.
 
 The Makefile that comes with the source helps you::
 

docs/source/install.rst

@@ -49,7 +49,7 @@ source. For a normal install, use::
 
 For a debug-style editable install, use::
 
-    python -m pip install -e . --no-deps --no-build-isolation --config-settings=build-dir=build/debug --config-settings=setup-args=-Dbuildtype=debug
+    python -m pip install -e . --no-deps --no-build-isolation --config-settings=build-dir=build/debug --config-settings=setup-args=-Dbuildtype=release --config-settings=setup-args=-Db_ndebug=false
 
 
 Bleeding Edge (Development)