Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
more C++ish in EngineImpl
[simgrid.git] / doc / doxygen / inside.doc
index 3945ed00c69b34d6be2dfd3103f3ea695065fe45..5428876f42809ec0518c52c6094240ab82a5e02d 100644 (file)
@@ -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
@@ -49,13 +49,13 @@ things, and get them directly in master.
 
 Your commit message should follow the git habits, explained in this
 <a href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">blog
-post</a>, or in the 
+post</a>, or in the
 <a href="https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages">
 git styleguide of Atom</a>.
 
-  
+
 @subsection uhood_tech_inside_codstand Automatically Enforcing our Coding Standards
+
 If you plan to commit code to the SimGrid project, you definitely need
 to install the relevant tool to ensure that your changes follow our
 coding standards:
@@ -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.
@@ -135,9 +135,9 @@ Note that the links sometimes broken by git or others. Relaunching
     which valgrind does not really love).
     All this is configured with:
 
-    cmake -Denable_model-checking=OFF 
-          -Denable_mallocators=OFF 
-         -Denable_compile_optimizations=OFF .
+    cmake -Denable_model-checking=OFF
+          -Denable_mallocators=OFF
+          -Denable_compile_optimizations=OFF .
 
 * If you break the logs, you want to define XBT_LOG_MAYDAY at the
   beginning of log.h. It deactivates the whole logging mechanism,