Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
authorMartin Quinson <martin.quinson@loria.fr>
Fri, 20 May 2016 13:42:08 +0000 (15:42 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Fri, 20 May 2016 13:42:08 +0000 (15:42 +0200)
.gitignore
doc/Doxyfile.in
doc/doxygen/FAQ.doc
tools/cmake/DefinePackages.cmake
tools/cmake/Documentation.cmake
tools/doxygen/index_create.pl [deleted file]

index 6c39838..3f4150b 100644 (file)
@@ -100,7 +100,6 @@ doc/html
 doc/index.php
 doc/simgrid.tag
 doc/doxygen/logcategories.doc
-doc/index-API.doc
 doc/simgrid_modules.map
 doc/javadoc
 ### Specific of project 
index 0d14f2a..b795ddc 100644 (file)
@@ -672,7 +672,6 @@ INPUT                  = doxygen/index.doc \
                            doxygen/module-simix.doc \
                            doxygen/module-smpi.doc \
                            doxygen/module-trace.doc \
-                           index-API.doc \
                          @CMAKE_HOME_DIRECTORY@/doc/doxygen/logcategories.doc \
                          @CMAKE_HOME_DIRECTORY@/src/instr/ \
                          @CMAKE_HOME_DIRECTORY@/include/ \
index 44e4f9a..2a8a74d 100644 (file)
@@ -496,53 +496,6 @@ come after <tt>-lsimgrid</tt> on this command line.
 
 \subsection faq_trouble_errors Runtime error messages
 
-\subsubsection faq_flexml_limit "surf_parse_lex: Assertion `next limit' failed."
-
-This is because your platform file is too big for the parser.
-
-Actually, the message comes directly from FleXML, the technology on top of
-which the parser is built. FleXML has the bad idea of fetching the whole
-document in memory before parsing it. And moreover, the memory buffer size
-must be determined at compilation time.
-
-We use a value which seems big enough for our need without bloating the
-simulators footprints. But of course your mileage may vary. In this case,
-just edit src/surf/surfxml.l modify the definition of
-FLEXML_BUFFERSTACKSIZE. E.g.
-
-\verbatim
-#define FLEXML_BUFFERSTACKSIZE 1000000000
-\endverbatim
-
-Then recompile and everything should be fine, provided that your version of
-Flex is recent enough (>= 2.5.31). If not the compilation process should
-warn you.
-
-A while ago, we worked on FleXML to reduce a bit its memory consumption, but
-these issues remain. There is two things we should do:
-
-  - use a dynamic buffer instead of a static one so that the only limit
-    becomes your memory, not a stupid constant fixed at compilation time
-    (maybe not so difficult).
-  - change the parser so that it does not need to get the whole file in
-    memory before parsing
-    (seems quite difficult, but I'm a complete newbe wrt flex stuff).
-
-These are changes to FleXML itself, not SimGrid. But since we kinda hijacked
-the development of FleXML, I can grant you that any patches would be really
-welcome and quickly integrated.
-
-<b>Update:</b> A new version of FleXML (1.7) was released. Most of the work
-was done by William Dowling, who use it in his own work. The good point is
-that it now use a dynamic buffer, and that the memory usage was greatly
-improved. The downside is that William also changed some things internally,
-and it breaks the hack we devised to bypass the parser, as explained in
-\ref pf_flexml_bypassing. Indeed, this is not a classical usage of the
-parser, and Will didn't imagine that we may have used (and even documented)
-such a crude usage of FleXML. So, we now have to repair the bypassing
-functionality to use the latest FleXML version and fix the memory usage in
-SimGrid.
-
 \subsubsection faq_trouble_errors_big_fat_warning I'm told that my XML files are too old.
 
 The format of the XML platform description files is sometimes
@@ -553,9 +506,9 @@ descriptions to allow more compact descriptions.
 
 That is why the XML files are versionned using the 'version' attribute
 of the root tag. Currently, it should read:
-\verbatim
-  <platform version="2">
-\endverbatim
+@verbatim
+  <platform version="4">
+@endverbatim
 
 If your files are too old, you can use the simgrid_update_xml.pl
 script which can be found in the tools directory of the archive.
index e28b2f3..d111567 100644 (file)
@@ -844,7 +844,6 @@ set(DOC_FIGS
 
 set(DOC_TOOLS
   tools/doxygen/fig2dev_postprocessor.pl
-  tools/doxygen/index_create.pl
   tools/doxygen/xbt_log_extract_hierarchy.pl
   tools/doxygen/list_routing_models_examples.sh
   )
index ee1c13b..555a3b1 100644 (file)
@@ -60,7 +60,6 @@ if(DOXYGEN_FOUND)
     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
     COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files"
-    COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for routing models"
diff --git a/tools/doxygen/index_create.pl b/tools/doxygen/index_create.pl
deleted file mode 100755 (executable)
index 987f2a1..0000000
+++ /dev/null
@@ -1,81 +0,0 @@
-#!/usr/bin/env perl
-
-# Copyright (c) 2005, 2012-2014. The SimGrid Team.
-# All rights reserved.
-
-# This program is free software; you can redistribute it and/or modify it
-# under the terms of the license (GNU LGPL) which comes with this package.
-
-use warnings;
-
-($#ARGV >= 1) or die "Usage: index_create.pl <input-tag-file> <output-doc-file>";
-
-my($type) = "";
-my($name) = "";
-my(%database);
-
-$input  = $ARGV[0];
-$output = $ARGV[1];
-open FILE,$input;
-while($line=<FILE>) {
-    chomp $line;
-    if($line=~/compound kind=/) {
-       $type = $line;
-       $type =~ s/^[^\"]*\"//;
-       $type =~ s/\".*$//;
-       $line=<FILE>;chomp $line;
-    }
-    if($line=~/member kind=/) {
-       $type = $line;
-       $type =~ s/^[^\"]*\"//;
-       $type =~ s/\".*$//;
-       $line=<FILE>;chomp $line;
-    }
-    if($line=~/<name>/) {
-       $name = $line;
-       $name =~ s/.*<name>//;
-       $name =~ s/<\/name>.*//;
-       $database{$type}{$name} = 1;
-       $type = "";
-       $name = "";
-       next;
-    }
-}
-close FILE;
-
-open OUTPUT,"> $output";
-print OUTPUT <<EOF;
-This file was generated by tools/doxygen/index_create.pl. DO NOT EDIT.
-
-/** \\defgroup API_index Full Index
- * \\brief The alphabetical list of all functions, macros and types
- *  defined by SimGrid
- *
- * List of all functions, variables, defines, enums, and typedefs with
- * links to the files they belong to.
- *
- * \\htmlonly Although completely useless, the complete list of structures defined can be found <a href="annotated.html">here</a> \\endhtmlonly
-
-EOF
-
-foreach $type (qw(define enumeration enumvalue function typedef)) {
-    if(defined $database{$type}) {
-       print OUTPUT "<h2>$type</h2> \n  <ul>\n";
-       foreach $name (sort keys %{$database{$type}}) {
-           if($type eq "function") {
-               print OUTPUT "\t<LI> $name()</LI>\n";
-           } else {
-          if($type eq "enumeration") {
-                   print OUTPUT "\t<LI> ".$name."::EType</LI>\n";
-          }
-          else {
-                   print OUTPUT "\t<LI> #$name</LI>\n";
-          }
-           }
-       }
-       print OUTPUT "\n  </ul>\n";
-    }
-}
-print OUTPUT "*/";
-close OUTPUT;
-