X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/befbbbe1fbb31663a8f91e24ce12df271cf4ae79..20f5604e5582663868f57fb5db28a88929ac3d43:/doc/doxygen/inside.doc?ds=sidebyside diff --git a/doc/doxygen/inside.doc b/doc/doxygen/inside.doc deleted file mode 100644 index 03e3270ceb..0000000000 --- a/doc/doxygen/inside.doc +++ /dev/null @@ -1,42 +0,0 @@ -/*! @page uhood_tech Coding Standard and Technical Considerations - - -There is two main things you want to know about the internals of -SimGrid. First, you need to understand the component organization, as -SimGrid is heavily layered, with each level being rather highly -specialized and optimized toward a task. For that, please head to -@ref uhood_arch. - -Then, if you work actively on the SimGrid project, the second point -you need to understand is about the infrastructure of the SimGrid -project, ie how to extend the framework in any way, how the automatic -tests are run, and so on. These informations are split on several -pages, as follows: - - - @subpage inside_tests - - @subpage inside_doxygen - - @subpage inside_extending - - @subpage inside_cmake - - @subpage inside_release - -@section uhood_tech_codstand Coding Standard - -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: - -@verbatim -sudo apt-get install clang-format-3.8 -ln -s $PWD/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, -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. - -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. - -*/