From 0ecfbd6020832cb4d8260da5361fa942dae8043e Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Fri, 24 Feb 2023 16:39:28 +0100 Subject: [PATCH] Two more random hints to contributors (and reindent the existing ones) --- docs/source/Contributors_Documentation.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/source/Contributors_Documentation.rst b/docs/source/Contributors_Documentation.rst index 8a8f26605c..da9640a0e9 100644 --- a/docs/source/Contributors_Documentation.rst +++ b/docs/source/Contributors_Documentation.rst @@ -184,11 +184,18 @@ In C: Unsorted hints -------------- -* To thoroughly test your changes before pushing your commits, use several cmake configurations under sub-trees of ``build/`` (that is ignored by git) as - explained in :ref:`install_cmake_outsrc`. For example, I have the following directories: build/clang build/full build/mc (but YMMV). +* To thoroughly test your changes before pushing your commits, use several cmake configurations under sub-trees of ``build/`` + (that is ignored by git) as explained in :ref:`install_cmake_outsrc`. For example, I have the following directories: + build/clang build/full build/mc (but YMMV). -* If you break the logs, you want to define XBT_LOG_MAYDAY at the beginning of log.h. It deactivates the whole logging mechanism, switching to printfs instead. - SimGrid then becomes incredibly verbose, but it you let you fixing things. +* If you add or remove a file, you can check that everything is correctly setup with ``make distcheck``. + +* If everything gets crazy, as if it were not using the code that you actually compile, well, maybe it's using another version + of SimGrid on your disk. Use ``ldd`` on any simulator to check which library gets used. If you installed a SimGrid package, + you probably need to uninstall it. + +* If you break the logs, you want to define XBT_LOG_MAYDAY at the beginning of log.h. It deactivates the whole logging + mechanism, switching to printfs instead. SimGrid then becomes incredibly verbose, but it you let you fixing things. .. |br| raw:: html -- 2.20.1