From: Martin Quinson Date: Fri, 10 Jun 2016 22:04:05 +0000 (+0200) Subject: rewrite the doc of option exceptions/cutpath X-Git-Tag: v3_14~1003 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/bc8e58c7e0b769a039f4ec3ae46b0dd73814ebc7 rewrite the doc of option exceptions/cutpath --- diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc index 98ebf9d78e..5a7d33331d 100644 --- a/doc/doxygen/options.doc +++ b/doc/doxygen/options.doc @@ -1058,13 +1058,12 @@ when \b verbose-exit is set to 0 (it is to 1 by default). --cfg=exceptions/cutpath:1 \endverbatim -This configuration option is an internal option and should normally not be used -by the user. It is used to remove the path from the backtrace -shown when an exception is thrown; if we didn't remove this part, the tests -testing the exception parts of simgrid would fail on most machines, as we are -currently comparing output. Clearly, the path used on different machines are almost -guaranteed to be different and hence, the output would -mismatch, causing the test to fail. +This configuration option is used to remove the path from the +backtrace shown when an exception is thrown. This is mainly useful for +the tests: the full file path makes the tests not reproducible, and +thus failing as we are currently comparing output. Clearly, the path +used on different machines are almost guaranteed to be different and +hence, the output would mismatch, causing the test to fail. \section options_log Logging Configuration