Add comments into relevant cmake files

Author: godexsoft

cmake/Settings.cmake

@@ -40,7 +40,12 @@ if (is_appleclang)
 endif ()
 
 if (san)
-  # for the time being we want the builds to succeed and sanitizers to assess our runtime behaviour
+  # When building with sanitizers some compilers will actually produce extra warnings/errors. We don't want this yet, at
+  # least not until we have fixed all runtime issues reported by the sanitizers. Once that is done we can start removing
+  # some of these and trying to fix it in our codebase. We can never remove all of below because most of them are
+  # reported from deep inside libraries like boost or libxrpl.
+  #
+  # TODO: Address in https://github.com/XRPLF/clio/issues/1885
   list(
     APPEND
     COMPILER_FLAGS

cmake/deps/libbacktrace.cmake

@@ -3,5 +3,8 @@ if (Boost_STACKTRACE_FOUND)
   target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_USE_BACKTRACE)
   find_package(libbacktrace REQUIRED CONFIG)
 else ()
+  # Some sanitizers (TSAN and ASAN for sure) can't be used with libbacktrace because they have their own backtracing
+  # capabilities and there are conflicts. In any case, this makes sure Clio code knows that backtrace is not available.
+  # See relevant conan profiles for sanitizers where we disable stacktrace in Boost explicitly.
   target_compile_definitions(clio_options INTERFACE CLIO_WITHOUT_STACKTRACE)
 endif ()