From 81a7e4ff1d9fa7397b8dd584d05f18ccf704106f Mon Sep 17 00:00:00 2001 From: Thomas Spenke Date: Tue, 3 Feb 2026 13:16:18 +0100 Subject: [PATCH] Documentation: Update outdated comments to --enable-debug etc. --- src/t8.h | 2 +- src/t8_cmesh/t8_cmesh.cxx | 3 ++- src/t8_vtk/t8_vtk_write_ASCII.hxx | 4 ++-- src/t8_vtk/t8_vtk_writer.h | 12 ++++++------ test/t8_gtest_netcdf_linkage.cxx | 2 +- test/t8_gtest_occ_linkage.cxx | 2 +- test/t8_gtest_vtk_linkage.cxx | 2 +- tutorials/general/t8_step3_adapt_forest.cxx | 2 +- tutorials/general/t8_step7_interpolation.cxx | 2 +- 9 files changed, 16 insertions(+), 15 deletions(-) diff --git a/src/t8.h b/src/t8.h index d3626802f7..a360785cfd 100644 --- a/src/t8.h +++ b/src/t8.h @@ -261,7 +261,7 @@ t8_productionf (const char *fmt, ...) /** Log a message, no matter what rank, with priority SC_LP_DEBUG. * \param [in] fmt Printf-style format string. * \note This function does not print anything unless t8code was compiled - * in debug mode (--enable-debug, T8_ENABLE_DEBUG was defined). + * in debug mode (using -DCMAKE_BUILD_TYPE=Debug, so T8_ENABLE_DEBUG is defined). */ void t8_debugf (const char *fmt, ...) diff --git a/src/t8_cmesh/t8_cmesh.cxx b/src/t8_cmesh/t8_cmesh.cxx index cc1cbbe98f..3e7ef65e0e 100644 --- a/src/t8_cmesh/t8_cmesh.cxx +++ b/src/t8_cmesh/t8_cmesh.cxx @@ -1368,7 +1368,8 @@ t8_cmesh_debug_print_trees ([[maybe_unused]] const t8_cmesh_t cmesh, [[maybe_unu } #else - t8_global_errorf ("Do not call t8_cmesh_debug_print_trees if t8code is not compiled with --enable-debug.\n"); + t8_global_errorf ( + "Do not call t8_cmesh_debug_print_trees if t8code is not compiled with -DCMAKE_BUILD_TYPE=Debug.\n"); #endif /* T8_ENABLE_DEBUG */ } diff --git a/src/t8_vtk/t8_vtk_write_ASCII.hxx b/src/t8_vtk/t8_vtk_write_ASCII.hxx index 1d0d73c611..710096cacb 100644 --- a/src/t8_vtk/t8_vtk_write_ASCII.hxx +++ b/src/t8_vtk/t8_vtk_write_ASCII.hxx @@ -34,7 +34,7 @@ /** Write the forest in .pvtu file format. Writes one .vtu file per * process and a meta .pvtu file. * This function writes ASCII files and can be used when - * t8code is not configure with "--enable-vtk" and + * t8code is not configured with "-DT8CODE_ENABLE_VTK=ON" and * \ref t8_forest_vtk_write_file_via_API is not available. * \param [in] forest The forest. * \param [in] fileprefix The prefix of the output files. @@ -59,7 +59,7 @@ t8_forest_vtk_write_ASCII (t8_forest_t forest, const char *fileprefix, const int /** Write the cmesh in .pvtu file format. Writes one .vtu file per * process and a meta .pvtu file. * This function writes ASCII files and can be used when - * t8code is not configure with "--enable-vtk" and + * t8code is not configured with "-DT8CODE_ENABLE_VTK=ON" and * \ref t8_cmesh_vtk_write_file_via_API is not available. * \param [in] cmesh The cmesh. * \param [in] fileprefix The prefix of the output files. diff --git a/src/t8_vtk/t8_vtk_writer.h b/src/t8_vtk/t8_vtk_writer.h index 4b8d47a884..0b1ccf1567 100644 --- a/src/t8_vtk/t8_vtk_writer.h +++ b/src/t8_vtk/t8_vtk_writer.h @@ -42,7 +42,7 @@ T8_EXTERN_C_BEGIN (); /** * Translate a forest into a vtkUnstructuredGrid with respect to the given flags. * This function uses the vtk library. t8code must be configured with - * "--enable-vtk" in order to use it. + * "-DT8CODE_ENABLE_VTK=ON" in order to use it. * \param [in] forest The forest. * \param[in, out] unstructuredGrid * \param [in] write_treeid If true, the global tree id is written for each element. @@ -67,7 +67,7 @@ t8_forest_to_vtkUnstructuredGrid (t8_forest_t forest, vtkSmartPointer diff --git a/tutorials/general/t8_step3_adapt_forest.cxx b/tutorials/general/t8_step3_adapt_forest.cxx index a2b5d028cd..72983b5fe5 100644 --- a/tutorials/general/t8_step3_adapt_forest.cxx +++ b/tutorials/general/t8_step3_adapt_forest.cxx @@ -97,7 +97,7 @@ t8_step3_adapt_callback (t8_forest_t forest, t8_forest_t forest_from, t8_locidx_ const struct t8_step3_adapt_data *adapt_data = (const struct t8_step3_adapt_data *) t8_forest_get_user_data (forest); double dist; /* Will store the distance of the element's midpoint and the sphere midpoint. */ - /* You can use T8_ASSERT for assertions that are active in debug mode (when configured with --enable-debug). + /* You can use T8_ASSERT for assertions that are active in debug mode (when compiled with -DCMAKE_BUILD_TYPE=Debug). * If the condition is not true, then the code will abort. * In this case, we want to make sure that we actually did set a user pointer to forest and thus * did not get the NULL pointer from t8_forest_get_user_data. diff --git a/tutorials/general/t8_step7_interpolation.cxx b/tutorials/general/t8_step7_interpolation.cxx index 14a6618018..9f4eae297d 100644 --- a/tutorials/general/t8_step7_interpolation.cxx +++ b/tutorials/general/t8_step7_interpolation.cxx @@ -122,7 +122,7 @@ t8_step7_adapt_callback (t8_forest_t forest, t8_forest_t forest_from, t8_locidx_ const struct t8_step7_adapt_data *adapt_data = (const struct t8_step7_adapt_data *) t8_forest_get_user_data (forest); double dist; /* Will store the distance of the element's midpoint and the sphere midpoint. */ - /* You can use T8_ASSERT for assertions that are active in debug mode (when configured with --enable-debug). + /* You can use T8_ASSERT for assertions that are active in debug mode (when compiled with -DCMAKE_BUILD_TYPE=Debug). * If the condition is not true, then the code will abort. * In this case, we want to make sure that we actually did set a user pointer to forest and thus * did not get the NULL pointer from t8_forest_get_user_data.