doc/doxygen/inside.doc

   1 /*! @page uhood_tech Coding Standard and Technical Considerations
   2
   3
   4 There is two main things you want to know about the internals of
   5 SimGrid. First, you need to understand the component organization, as
   6 SimGrid is heavily layered, with each level being rather highly
   7 specialized and optimized toward a task. For that, please head to
   8 @ref uhood_arch.
   9
  10 Then, if you work actively on the SimGrid project, the second point
  11 you need to understand is about the infrastructure of the SimGrid
  12 project, ie how to extend the framework in any way, how the automatic
  13 tests are run, and so on. These informations are split on several
  14 pages, as follows:
  15
  16  - @subpage inside_tests
  17  - @subpage inside_doxygen
  18  - @subpage inside_extending
  19  - @subpage inside_cmake
  20  - @subpage inside_release
  21
  22 @section uhood_tech_codstand Coding Standard
  23
  24 If you plan to commit code to the SimGrid project, you definitely need
  25 to install the relevant tool to ensure that your changes follow our
  26 coding standards:
  27
  28 @verbatim
  29 sudo apt-get install clang-format-3.8
  30 ln -s $PWD/tools/git-hooks/clang-format.pre-commit .git/hooks/pre-commit
  31 @endverbatim
  32
  33 This will add an extra verification before integrating any commit that
  34 you could prepare. If your code does not respects our formating code,
  35 git will say so, and provide a ready to use patch that you can apply
  36 to improve your commit. Just carefully read the error message you get
  37 to find the exact command with git-apply to fix your formating.
  38
  39 */