X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7def8a1471cff759a06b836d283a39cbd0f0864f..e2d3cb7c869ece98836a275af3bafc4fe487e08b:/doc/doxygen/inside.doc diff --git a/doc/doxygen/inside.doc b/doc/doxygen/inside.doc index a5c25914f8..d6eb7d0ac0 100644 --- a/doc/doxygen/inside.doc +++ b/doc/doxygen/inside.doc @@ -2,8 +2,8 @@ This page describes the software infrastructure behind the SimGrid project. This is not the components' organisation (described in @ref -uhood_arch) but informations on how to extend the framework, how the -automatic tests are run, and so on. These informations are split on +uhood_arch) but information on how to extend the framework, how the +automatic tests are run, and so on. These information are split on several pages, as follows: - @ref uhood_tech_inside @@ -69,10 +69,10 @@ ln -s $(realpath tools/git-hooks/clang-format.pre-commit) .git/hooks/pre-commit @endverbatim This will add an extra verification before integrating any commit that -you could prepare. If your code does not respects our formating code, +you could prepare. If your code does not respects our formatting code, git will say so, and provide a ready to use patch that you can apply to improve your commit. Just carefully read the error message you get -to find the exact command with git-apply to fix your formating. +to find the exact command with git-apply to fix your formatting. If you find that for a specific commit, the formatter does a very bad job, then add --no-verify to your git commit command line. @@ -88,7 +88,7 @@ Launching all tests can be very time consuming, so you want to build and run the tests in parallel. Also, you want to save the build output to disk, for further reference. This is exactly what the BuildSimGrid.sh script does. It is upper-cased so that the shell -completion works and allow to run it in 4 key press: `./B` +completion works and allows one to run it in 4 key press: `./B` Note that if you build out of tree (as you should, see below), the script builds the build/default directory. I usually copy the file in