Logo AND Algorithmique Numérique Distribuée
Public GIT Repository
projects / simgrid.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (from parent 1: b97705a)
Attach the dev guide to forge and doc
authornavarro <navarro@caraja.(none)>
Thu, 25 Oct 2012 13:58:14 +0000 (15:58 +0200)
committernavarro <navarro@caraja.(none)>
Thu, 25 Oct 2012 13:58:14 +0000 (15:58 +0200)
buildtools/Cmake/GenerateDevGuide.cmake patch | blob | history
buildtools/Cmake/GenerateDoc.cmake patch | blob | history
doc/Doxyfile.in patch | blob | history
doc/SimgridDoxygenLayout.xml patch | blob | history
doc/dev_guide/doxygen/DevGuideDoxyfile.in patch | blob | history
doc/dev_guide/doxygen/header.html patch | blob | history
doc/dev_guide/doxygen/index.doc patch | blob | history
doc/index.doc patch | blob | history
doc/ref_guide/doxygen/header.html patch | blob | history
doc/user_guide/doxygen/header.html patch | blob | history

diff --git a/buildtools/Cmake/GenerateDevGuide.cmake b/buildtools/Cmake/GenerateDevGuide.cmake
index 4e1ce97acc4e9a6b7fa65917bca76e0b472773b5..e20f2890ad7b6e31df0e3998050cfa9ced8ead7d 100644 (file)
--- a/buildtools/Cmake/GenerateDevGuide.cmake
+++ b/buildtools/Cmake/GenerateDevGuide.cmake
@@ -2,6 +2,11 @@
 
 if(DOXYGEN_PATH)
 
 
 if(DOXYGEN_PATH)
 
+  set(DOC_PNGS
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
+    )
+
   configure_file(${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile @ONLY)
 
   ADD_CUSTOM_TARGET(dev_guide
   configure_file(${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile @ONLY)
 
   ADD_CUSTOM_TARGET(dev_guide
@@ -13,6 +18,20 @@ if(DOXYGEN_PATH)
     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/
     )
     
     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/
     )
     
+ foreach(file ${DOC_FIGS})
+    string(REPLACE ".fig" ".png" tmp_file ${file})
+    string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/" tmp_file ${tmp_file})
+    ADD_CUSTOM_COMMAND(TARGET dev_guide
+      COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
+      )
+  endforeach(file ${DOC_FIGS})
+
+  foreach(file ${DOC_PNGS})
+    ADD_CUSTOM_COMMAND(TARGET dev_guide
+      COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/
+      )
+  endforeach(file ${DOC_PNGS})
+    
   ADD_CUSTOM_COMMAND(TARGET dev_guide
     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
     COMMAND ${DOXYGEN_PATH}/doxygen DevGuideDoxyfile
   ADD_CUSTOM_COMMAND(TARGET dev_guide
     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
     COMMAND ${DOXYGEN_PATH}/doxygen DevGuideDoxyfile
diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake
index 18c0ae92a214f386fb0e182cf0793530b373ba82..c69b51629e56917eaea5e082148a377ed8be58c6 100644 (file)
--- a/buildtools/Cmake/GenerateDoc.cmake
+++ b/buildtools/Cmake/GenerateDoc.cmake
@@ -88,14 +88,23 @@ add_custom_target(sync-gforge-doc
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true
+  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
+  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html/ || true
+
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
+
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
+
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
+
+  COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
+  doc/dev_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html || true
+
   COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
   COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 83195ba34b1072e8bc38fe8fef92f7ba37516a39..6c231fd5ddb7ccc99f360c35c91e39134ec231b1 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -1557,7 +1557,9 @@ SKIP_FUNCTION_MACROS   = YES
 # NOT include the path). If a tag file is not located in the directory in which
 # doxygen is run, you must also specify the path to the tagfile here.
 
 # NOT include the path). If a tag file is not located in the directory in which
 # doxygen is run, you must also specify the path to the tagfile here.
 
-TAGFILES               = shared/doxygen/simgridrefguide.tag=ref_guide/html/ shared/doxygen/simgriduserguide.tag=user_guide/html/
+TAGFILES               = shared/doxygen/simgridrefguide.tag=ref_guide/html/ \ 
+                         shared/doxygen/simgriduserguide.tag=user_guide/html/ \
+                         shared/doxygen/simgriddevguide.tag=dev_guide/html/
 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 # a tag file that is based on the input files it reads.
 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 # a tag file that is based on the input files it reads.
diff --git a/doc/SimgridDoxygenLayout.xml b/doc/SimgridDoxygenLayout.xml
index 263b04f1730539575648ee82338a04146e508714..c6712398fbedde6d6e6615045ea088fc2ba45d29 100644 (file)
--- a/doc/SimgridDoxygenLayout.xml
+++ b/doc/SimgridDoxygenLayout.xml
@@ -4,6 +4,7 @@
     <tab type="mainpage" visible="yes" title="Home"/>
     <tab type="user" url="../ref_guide/html/index.html" title="Reference Manual"/>
     <tab type="user" url="../user_guide/html/index.html" title="User Guide"/>
     <tab type="mainpage" visible="yes" title="Home"/>
     <tab type="user" url="../ref_guide/html/index.html" title="Reference Manual"/>
     <tab type="user" url="../user_guide/html/index.html" title="User Guide"/>
+    <tab type="user" url="../dev_guide/html/index.html" title="Developer Guide"/>
     <tab type="user" url="http://simgrid.gforge.inria.fr/tutorials" title="Tutorials"/>
     <tab type="user" url="https://gforge.inria.fr/projects/simgrid" title="Forge"/>
     <tab type="user" url="http://simgrid.gforge.inria.fr/" title="Website"/>
     <tab type="user" url="http://simgrid.gforge.inria.fr/tutorials" title="Tutorials"/>
     <tab type="user" url="https://gforge.inria.fr/projects/simgrid" title="Forge"/>
     <tab type="user" url="http://simgrid.gforge.inria.fr/" title="Website"/>
diff --git a/doc/dev_guide/doxygen/DevGuideDoxyfile.in b/doc/dev_guide/doxygen/DevGuideDoxyfile.in
index e1c17c69d7d2d526ad8a760e8f3373b99b597d16..698cce167c95d6c0869a9cbfef0c807c77d0b1f1 100644 (file)
--- a/doc/dev_guide/doxygen/DevGuideDoxyfile.in
+++ b/doc/dev_guide/doxygen/DevGuideDoxyfile.in
@@ -29,7 +29,7 @@ DOXYFILE_ENCODING      = UTF-8
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME           = "SimGrid Developer Guide"
+PROJECT_NAME           = SimGrid
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
diff --git a/doc/dev_guide/doxygen/header.html b/doc/dev_guide/doxygen/header.html
index 4aaa6d1570e62d1f3987d8f2537bef6af8f055d0..65b3ebe45fca47561cec192f3312212d72cdd17b 100644 (file)
--- a/doc/dev_guide/doxygen/header.html
+++ b/doc/dev_guide/doxygen/header.html
@@ -49,7 +49,7 @@ $mathjax
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="../../doc/index.html"><span>Home</span></a></li>
+      <li><a href="../../html/index.html"><span>Home</span></a></li>
       <li><a href="../../ref_guide/html/index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
       <li class="current"><a href="index.html"><span>Developer&nbsp;Guide</span></a></li>
       <li><a href="../../ref_guide/html/index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
       <li class="current"><a href="index.html"><span>Developer&nbsp;Guide</span></a></li>
diff --git a/doc/dev_guide/doxygen/index.doc b/doc/dev_guide/doxygen/index.doc
index fe5f9387ff25f2f62e542ad9830b2748aee18db7..015215513906a819b03e4e275c673e3071d6cf87 100644 (file)
--- a/doc/dev_guide/doxygen/index.doc
+++ b/doc/dev_guide/doxygen/index.doc
@@ -1,5 +1,6 @@
 /*!
 /*!
-@mainpage SimGrid Developer Guide - Welcome
+@mainpage SimGrid Developer Guide
+
 <center>
 \htmlonly
 <table width="100%">
 <center>
 \htmlonly
 <table width="100%">
diff --git a/doc/index.doc b/doc/index.doc
index 8b1414a8acf403ffbdd753a21138578a9256a2a6..c1fe91d99c57df0c52964896da6085a794ec3922 100644 (file)
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -17,6 +17,7 @@ Currently, the documentation contains 3 main sections:
 <ul>
   <li><h2><a href="../user_guide/html/index.html">SimGrid User Guide</a></h2></li>
   <li><h2><a href="../ref_guide/html/index.html">SimGrid Reference Manual</a>.</h2></li>
 <ul>
   <li><h2><a href="../user_guide/html/index.html">SimGrid User Guide</a></h2></li>
   <li><h2><a href="../ref_guide/html/index.html">SimGrid Reference Manual</a>.</h2></li>
+  <li><h2><a href="../dev_guide/html/index.html">SimGrid Developer Manual</a>.</h2></li>
   <li><h2>You can also retrieve tutorials from <a href="http://simgrid.gforge.inria.fr/faq.html">here</a>.</h2></li> 
 </ul>
 \endhtmlonly
   <li><h2>You can also retrieve tutorials from <a href="http://simgrid.gforge.inria.fr/faq.html">here</a>.</h2></li> 
 </ul>
 \endhtmlonly
diff --git a/doc/ref_guide/doxygen/header.html b/doc/ref_guide/doxygen/header.html
index 8773d3fe33ab04778e648cfcdea728fad2d1dd34..a1cd7d16bb39487a010a9dd60005fed0806afbc7 100644 (file)
--- a/doc/ref_guide/doxygen/header.html
+++ b/doc/ref_guide/doxygen/header.html
@@ -49,9 +49,10 @@ $mathjax
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="../../doc/index.html"><span>Home</span></a></li>
+      <li><a href="../../html/index.html"><span>Home</span></a></li>
       <li class="current"><a href="index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
       <li class="current"><a href="index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
+      <li><a href="../../dev_guide/html/index.html"><span>Developer&nbsp;Guide</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/tutorials"><span>Tutorials</span></a></li>
       <li><a href="https://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/tutorials"><span>Tutorials</span></a></li>
       <li><a href="https://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>
diff --git a/doc/user_guide/doxygen/header.html b/doc/user_guide/doxygen/header.html
index de0a5e7a50521de5dddf0bff3d5d66bf01088b64..75bc94f64a10ce55277fd74010ca7f6628726d94 100644 (file)
--- a/doc/user_guide/doxygen/header.html
+++ b/doc/user_guide/doxygen/header.html
@@ -49,9 +49,10 @@ $mathjax
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
 
 <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="../../doc/index.html"><span>Home</span></a></li>
+      <li><a href="../../html/index.html"><span>Home</span></a></li>
       <li><a href="../../ref_guide/html/index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li class="current"><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
       <li><a href="../../ref_guide/html/index.html"><span>Reference&nbsp;Manual</span></a></li>
       <li class="current"><a href="../../user_guide/html/index.html"><span>User&nbsp;Guide</span></a></li>
+      <li><a href="../../dev_guide/html/index.html"><span>Developer&nbsp;Guide</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/tutorials"><span>Tutorials</span></a></li>
       <li><a href="https://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/tutorials"><span>Tutorials</span></a></li>
       <li><a href="https://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>
       <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>
Clone of SimGrid repository with local patches