From: Arnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Date: Sun, 15 Oct 2017 12:41:38 +0000 (+0200)
Subject: Document last changes to public API, and keep old method (marked as deprecated).
X-Git-Tag: v3.18~455
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/9735ec835f0285768ee462eeabcd76c619e645a6

Document last changes to public API, and keep old method (marked as deprecated).
---

diff --git a/ChangeLog b/ChangeLog
index c595a7fdb2..5dc0488440 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 SimGrid (3.18) NOT RELEASED YET (target: December 24 2017)
 
+ S4U
+ - Link::name() is deprecated and will be removed in v3.21, use instead
+   Link::getCname().
+ - Mailbox::getName() changed to return a std::string, use instead
+   Mailbox::getCname() to get a char*.
+ - Storage::getName() changed to return a std::string, use intead
+   Storage::getCname() to get a char*.
+
 SimGrid (3.17) Released October 8 2017
 
  The Drained Leaks release: (almost) no known leaks despite the tests.
diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index fce807cfe4..86379248ee 100644
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -83,6 +83,8 @@ public:
 
   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
   static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
+
+  const char* XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") name();
 };
 }
 }
diff --git a/src/s4u/s4u_link.cpp b/src/s4u/s4u_link.cpp
index 66351429ac..c640077613 100644
--- a/src/s4u/s4u_link.cpp
+++ b/src/s4u/s4u_link.cpp
@@ -90,6 +90,10 @@ const char* Link::getCname() const
 {
   return this->pimpl_->getCname();
 }
+const char* Link::name()
+{
+  return getCname();
+}
 bool Link::isUsed()
 {
   return this->pimpl_->isUsed();