From 6e8c91fbf97819081008566496f5798182affb59 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sat, 25 Dec 2021 00:48:36 +0100 Subject: [PATCH] Kill more deprecated content from the old doc --- MANIFEST.in | 1 - doc/doxygen/FAQ.doc | 85 ------------------------------ doc/doxygen/module-index.doc | 17 ------ doc/doxygen/uhood_arch.doc | 88 -------------------------------- docs/source/XML_reference.rst | 2 +- tools/cmake/DefinePackages.cmake | 1 - 6 files changed, 1 insertion(+), 193 deletions(-) delete mode 100644 doc/doxygen/uhood_arch.doc diff --git a/MANIFEST.in b/MANIFEST.in index 922864bbf0..374066b2ab 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1812,7 +1812,6 @@ include doc/doxygen/module-surf.doc include doc/doxygen/outcomes_vizu.doc include doc/doxygen/platform.doc include doc/doxygen/uhood.doc -include doc/doxygen/uhood_arch.doc include doc/doxygen/uhood_switch.doc include docs/Build.sh include docs/README.md diff --git a/doc/doxygen/FAQ.doc b/doc/doxygen/FAQ.doc index ad1fe528f1..f38dfc95f4 100644 --- a/doc/doxygen/FAQ.doc +++ b/doc/doxygen/FAQ.doc @@ -202,17 +202,6 @@ keep working on it. You may find inspiring ideas in it. @subsection faq_platform Platform building and Dynamic resources -@subsubsection faq_platform_example Where can I find SimGrid platform files? - -There are several little examples in the archive, in the examples/platforms -directory. From time to time, we are asked for other files, but we -don't have much at hand right now. - -You should refer to the Platform Description Archive -(http://pda.gforge.inria.fr) project to see the other platform file we -have available, as well as the Simulacrum simulator, meant to generate -SimGrid platforms using all classical generation algorithms. - @subsubsection faq_platform_synthetic Generating synthetic but realistic platforms Another possibility to get a platform file is to generate synthetic @@ -237,61 +226,6 @@ assessed. Please keep this fact in mind when using it. @section faq_troubleshooting Troubleshooting -@subsection faq_trouble_compil User code compilation problems - -@subsubsection faq_trouble_err_logcat "gcc: _simgrid_this_log_category_does_not_exist__??? undeclared (first use in this function)" - -This is because you are using the log mechanism, but you didn't created -any default category in this file. You should refer to @ref XBT_log -for all the details, but you simply forgot to call one of -XBT_LOG_NEW_DEFAULT_CATEGORY() or XBT_LOG_NEW_DEFAULT_SUBCATEGORY(). - -@subsection faq_trouble_errors Runtime error messages - -@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 -improved. For example, we decided to change the units used in SimGrid -from MBytes, MFlops and seconds to Bytes, Flops and seconds to ease -people exchanging small messages. We also reworked the route -descriptions to allow more compact descriptions. - -That is why the XML files are versioned using the 'version' attribute -of the root tag. Currently, it should read: -@verbatim - -@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. - -@subsection faq_trouble_debug Debugging SMPI applications - -In order to debug SMPI programs, you can use the following options: - -- -wrapper 'gdb --args': this option is used to use a wrapper - in order to call the SMPI process. Good candidates for this options - are "gdb --args", "valgrind", "rr record", "strace", etc; - -- -foreground: this options gives the debugger access to the terminal - which is needed in order to use an interactive debugger. - -Both options are needed in order to run the SMPI process under GDB. - -@subsection faq_deadlock There is a deadlock in my code!!! - -Unfortunately, we cannot debug every code written in SimGrid. We -furthermore believe that the framework provides ways enough -information to debug such information yourself. If the textual output -is not enough, Make sure to check the @ref faq_visualization FAQ entry to see -how to get a graphical one. - -Now, if you come up with a really simple example that deadlocks and -you're absolutely convinced that it should not, you can ask on the -list. Just be aware that you'll be severely punished if the mistake is -on your side... We have plenty of FAQ entries to redact and new -features to implement for the impenitents! ;) - @subsection faq_surf_network_latency I get weird timings when I play with the latencies. OK, first of all, remember that units should be Bytes, Flops and @@ -333,23 +267,4 @@ that may make your result be unexpected. For example, two flows competing on a saturated link receive an amount of bandwidth inversely proportional to their round trip time. -@subsection faq_bugrepport So I've found a bug in SimGrid. How to report it? - -We do our best to make sure to hammer away any bugs of SimGrid, but this is -still an academic project so please be patient if/when you find bugs in it. -If you do, the best solution is to drop an email either on the simgrid-user -or the simgrid-devel mailing list and explain us about the issue. You can -also decide to open a formal bug report using the -relevant -interface. You need to login on the server to get the ability to submit -bugs. - -We will do our best to solve any problem reported, but you need to help us -finding the issue. Just telling "it segfault" isn't enough. Telling "It -segfaults when running the attached simulator" doesn't really help either. -You may find the following article interesting to see how to report -informative bug repports: -http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (it is not SimGrid -specific at all, but it's full of good advices). - */ diff --git a/doc/doxygen/module-index.doc b/doc/doxygen/module-index.doc index 83a56794b6..0f252d6d61 100644 --- a/doc/doxygen/module-index.doc +++ b/doc/doxygen/module-index.doc @@ -99,20 +99,3 @@ working to make it possible from the C++ code (or even from bindings in other languages). Until then, please head to @ref platform. */ - -/** -@defgroup SURF_API SURF -@brief Internal kernel of all the simulators used in SimGrid, and associated models. - -SURF provides the core functionalities to simulate a virtual -platform. It is very low-level and is not intended to be used by end -users, but rather to serve as a basis for higher-level simulators. Its -interfaces are not frozen (and probably never will be), and the -structure emphasis on performance over ease of use. This module -contains the platform models. If you need a model that is not encoded -yet, please come to the devel mailing list so that we can discuss on -the feasibility of your idea. - -Please note that as it is not really intended for public use, this -module is only partially documented. -*/ diff --git a/doc/doxygen/uhood_arch.doc b/doc/doxygen/uhood_arch.doc deleted file mode 100644 index ea0a3eb607..0000000000 --- a/doc/doxygen/uhood_arch.doc +++ /dev/null @@ -1,88 +0,0 @@ -/*! @page uhood_arch Project Architecture Overview - -This page presents the current code organization, as you will see it -if you dig into the src/ directory. But things will change during -the current Gran Refactoring leading to SimGrid 4. So take the -information on this page with a grain of salt, and don't be afraid if -things are not exactly as documented here. - -At some point, we at least extend this page to present the overall -design that we are currently pursuing for SimGrid 4. - -If you need to extend SimGrid, then you probably need to head to @ref -uhood_tech once you understant the overall design presented on this -page. - -@htmlonly -
-htmlinclude simgrid_modules.map -
SimGrid Components (click to jump to API) -
-@endhtmlonly - - -@section ug_overview Overview of the toolkit components - - -@subsection ug_overview_envs Programming environments layer - -SimGrid provides several programming environments built on top of a unique -simulation kernel. Each environment targets a specific audience and -constitutes a different paradigm. To choose which of them you want to use, -you have to think about what you want to do and what would be the result of -your work. - - - If you want to study a theoretical problem and compare several - heuristics, you probably want to try @ref MSG_API (yet another - historical name). It was designed exactly to that extend and should allow - you to build easily rather realistic multi-agents simulation. Yet, - realism is not the main goal of this environment and the most annoying - technical issues of real platforms are masked here. Check the @ref - MSG_API section for more information. - - - If you want to study the behavior of an MPI application using emulation, - you should have a look at the @ref SMPI_API (Simulated - MPI) programming environment. Unfortunately, this work is still underway. - Check the @ref SMPI_API section for more information. - -If your favorite programming environment/model is not there (BSP, -components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may -consider adding it. You should contact us first on the -SimGrid -developers mailing list, though. - -@subsection ug_overview_kernel Simulation kernel layer - -The core functionalities to simulate a virtual platform are provided by a -module called @ref SURF_API. It is -very low-level and is not intended to be used as such by end-users. Instead, -it serve as a basis for the higher level layer. - -SURF main features are a fast max-min linear solver and the ability to -change transparently the model used to describe the platform. This greatly -eases the comparison of the several models existing in the literature. - -See the @ref SURF_API section for more details. - -@subsection ug_overview_fundation Base layer - -The base of the whole toolkit is constituted by the @ref XBT_API -(eXtended Bundle of Tools). - -It is a portable library providing some grounding features such as @ref -XBT_log, @ref XBT_ex and @ref XBT_config. - -XBT also encompass the following convenient C data structures: -@ref XBT_dynar and @ref XBT_dict. -The code is being migrated in C++ so you should probably want -to use standard C++ containers instead of them if possible. - -It contains some C++ polyfills and utilities as well. - -See the @ref XBT_API section for more details. - - -@subsection ug_lucas_layer Tracing simulation -Finally, a transversal module allows you to trace your simulation. More documentation in the section @ref TRACE_doc - -*/ diff --git a/docs/source/XML_reference.rst b/docs/source/XML_reference.rst index b006d55465..c4ad1fad55 100644 --- a/docs/source/XML_reference.rst +++ b/docs/source/XML_reference.rst @@ -588,7 +588,7 @@ etc. .. TODO:: - Missing tags: + Missing tags: .. |br| raw:: html diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake index 5adc48b9b0..114adb3ee0 100644 --- a/tools/cmake/DefinePackages.cmake +++ b/tools/cmake/DefinePackages.cmake @@ -859,7 +859,6 @@ set(DOC_SOURCES doc/doxygen/platform.doc doc/doxygen/uhood.doc doc/doxygen/uhood_switch.doc - doc/doxygen/uhood_arch.doc examples/README.rst -- 2.20.1