From: Christian Heinrich <franz-christian.heinrich@inria.fr>
Date: Wed, 6 Dec 2017 12:43:22 +0000 (+0100)
Subject: [SMPI] Added doc block for smpi_backup_global_memory_segment()
X-Git-Tag: v3.19~359
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/64e886453115b0d399c1ff6fd6bbc0d6f98c22cb

[SMPI] Added doc block for smpi_backup_global_memory_segment()
---

diff --git a/src/smpi/internals/smpi_memory.cpp b/src/smpi/internals/smpi_memory.cpp
index 8719bd57a5..62bac67f99 100644
--- a/src/smpi/internals/smpi_memory.cpp
+++ b/src/smpi/internals/smpi_memory.cpp
@@ -134,8 +134,11 @@ int smpi_is_privatization_file(char* file)
   return buffer_path.compare(0, std::string::npos, file, buffer_path.length()) == 0;
 }
 
-// TODO: cheinrich: The behavior changed; this now only makes a backup of the
-// data segment. I think the function should be renamed.
+/**
+ * @brief Makes a backup of the segment in memory that stores the global variables of a process.
+ *        This backup is then used to initialize the global variables for every single
+ *        process that is added, regardless of the progress of the simulation.
+ */
 void smpi_backup_global_memory_segment()
 {
 #if HAVE_PRIVATIZATION