doc: advise to set STARPU_MICROBENCHS_DISABLED when running make check

starpu-runtime · Aug 14, 2024 · b816449 · b816449
1 parent 14f1626
commit b816449
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/doc/doxygen/chapters/starpu_installation/building.doxy b/doc/doxygen/chapters/starpu_installation/building.doxy
@@ -233,11 +233,14 @@ $ make
 
 Once everything is built, you may want to test the result. An
 extensive set of regression tests is provided with StarPU. Running the
-tests is done by calling <c>make check</c>. These tests are run every night
-and the result from the main profile is publicly available (https://starpu.gitlabpages.inria.fr/files/testing/master/).
+tests is done by calling <c>make check</c> (by setting the variable \c STARPU_MICROBENCHS_DISABLED to disable benchmarks)
+
+These tests are run every night and the result from the main profile
+is publicly available
+(https://starpu.gitlabpages.inria.fr/files/testing/master/).
 
 \verbatim
-$ make check
+$ STARPU_MICROBENCHS_DISABLED=1 make check
 \endverbatim
 
 \subsection InstallingStarPU Installing StarPU