From 50fbaf4e49aff29840e80979ad9cb5f1415b83f5 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Thu, 13 Dec 2012 16:27:01 +0100 Subject: [PATCH] document how to react when stuff break during the upgrade --- doc/doxygen/FAQ.doc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/doxygen/FAQ.doc b/doc/doxygen/FAQ.doc index c2b2d899e7..400ee14a1f 100644 --- a/doc/doxygen/FAQ.doc +++ b/doc/doxygen/FAQ.doc @@ -466,6 +466,27 @@ assessed. Please keep this fact in mind when using it. \section faq_troubleshooting Troubleshooting +\subsubsection faq_trouble_changelog The feature X stopped to work after my last update + +I guess that you want to read the ChangeLog file, that always contains +all the information that could be important to the users during the +upgrade. Actually, you may want to read it (alongside with the NEWS +file that highlights the most important changes) even before you +upgrade your copy of SimGrid, too. + +Backward compatibility is very important to us, as we want to provide +a scientific tool allowing to evaluate the code you write in several +years, too. That being said, we sometimes change the interface to make +them more usable to the users. When we do so, we always keep the old +interface as DEPRECATED. If you still want to use them, you want to +define the SIMGRID_DEPRECATED preprocessor symbol before loading the +SimGrid files: + +@verbatim +#define SIMGRID_DEPRECATED +#include +@endverbatim + \subsection faq_trouble_lib_compil SimGrid compilation and installation problems \subsubsection faq_trouble_lib_config cmake fails! -- 2.20.1