[geos-commits] [SCM] GEOS branch main updated. 2aa98200475266fb63e132f806f82c00c8665c6c

[git at osgeo.org]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GEOS".

The branch, main has been updated
       via  2aa98200475266fb63e132f806f82c00c8665c6c (commit)
      from  eea66b88041b0dd54a91bd3119e894f8b133851b (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 2aa98200475266fb63e132f806f82c00c8665c6c
Author: Martin Davis <mtnclimb at gmail.com>
Date:   Fri Jun 14 10:14:44 2024 -0700

    Add ASAN info to docs

diff --git a/web/content/project/development/tests.md b/web/content/project/development/tests.md
index a512bb462..2298639a3 100644
--- a/web/content/project/development/tests.md
+++ b/web/content/project/development/tests.md
@@ -61,9 +61,17 @@ Options:
 
 ### Performance Tests
 
-There are performance tests which are built, but not run as part of the standard test suite.
-These can be run from the command line:
+There are performance tests which are not built or run as part of the standard test suite.
+Building this is enabled by the `cmake -DBUILD_BENCHMARKS=ON` flag.
+The various tests can be run from the command line, e.g.:
 
 ```
 $ bin/perf_iterated_buffer
 ```
+
+### Memory Usage testing
+
+In some cases bugs are caused by improper memory access after deallocation (`heap-use-after-free`).
+This may be able to be detected and reported by using the Address Sanitizer compiler capability.
+Enable this via `cmake -DCMAKE_BUILD_TYPE=ASAN`.
+
diff --git a/web/content/usage/download.md b/web/content/usage/download.md
index 569a77a8f..997f132d5 100644
--- a/web/content/usage/download.md
+++ b/web/content/usage/download.md
@@ -60,7 +60,7 @@ They are specified on the `cmake` cmdline as `-DVAR=VALUE`.
 
 | Option               | Default    | Note  |
 | :------------------: | :--------: | :---: |
-| CMAKE_BUILD_TYPE     | Release    | Use `Debug` to build with debug flags and optimizations off. Use `Release` for packaging and production installs. Use `RelWithDebInfo` for optimized build with debug symbols. |
+| CMAKE_BUILD_TYPE     | Release    | Use `Debug` to build with debug flags and optimizations off. Use `Release` for packaging and production installs. Use `RelWithDebInfo` for optimized build with debug symbols. Use `ASAN` to enable memory usage checking. |
 | CMAKE_INSTALL_PREFIX | /usr/local | Set to install root. Libraries end up in `./lib` or `./lib64`, headers in `./include`, executables in `./bin` |
 | BUILD_DOCUMENTATION  | ON         | Attempt to find `doxygen` executable and build API docs |
 | BUILD_SHARED_LIBS    | ON         | Build dynamically linkable libraries |
@@ -69,6 +69,7 @@ They are specified on the `cmake` cmdline as `-DVAR=VALUE`.
 | USE_CCACHE           | OFF        | Use [`ccache`](https://ccache.dev/) to compile C/C++ objects, making subsequent builds quicker |
 
 
+
 ## Testing
 
 It is possible to run `ctest` directly. This gives access to ctest command line options (see `ctest --help` for a listing).

-----------------------------------------------------------------------

Summary of changes:
 web/content/project/development/tests.md | 12 ++++++++++--
 web/content/usage/download.md            |  3 ++-
 2 files changed, 12 insertions(+), 3 deletions(-)


hooks/post-receive
-- 
GEOS