[Energy] Mark sg_host_get_idle_consumption as deprecated

diff --git a/include/simgrid/plugins/energy.h b/include/simgrid/plugins/energy.h
index 3bf3429..035103c 100644 (file)
--- a/include/simgrid/plugins/energy.h
+++ b/include/simgrid/plugins/energy.h
@@ -14,7 +14,8 @@ SG_BEGIN_DECL()
 XBT_PUBLIC void sg_host_energy_plugin_init();
 XBT_PUBLIC void sg_host_energy_update_all();
 XBT_PUBLIC double sg_host_get_consumed_energy(sg_host_t host);
-XBT_PUBLIC double sg_host_get_idle_consumption(sg_host_t host);
+XBT_ATTRIB_DEPRECATED_v327("Please use !sg_host_get_idle_consumption_at()") \
+  XBT_PUBLIC double sg_host_get_idle_consumption(sg_host_t host); /* deprecated */
 XBT_PUBLIC double sg_host_get_idle_consumption_at(sg_host_t host, int pstate);
 XBT_PUBLIC double sg_host_get_wattmin_at(sg_host_t host, int pstate);
 XBT_PUBLIC double sg_host_get_wattmax_at(sg_host_t host, int pstate);

diff --git a/src/plugins/host_energy.cpp b/src/plugins/host_energy.cpp
index 4b82556..772d5b7 100644 (file)
--- a/src/plugins/host_energy.cpp
+++ b/src/plugins/host_energy.cpp
@@ -599,6 +599,7 @@ double sg_host_get_consumed_energy(sg_host_t host)
 
 /** @ingroup plugin_host_energy
  *  @brief Get the amount of watt dissipated when the host is idling
+ *  This function is deprecated and will not work after v3.27. Use sg_host_get_idle_consumption_at instead.
  */
 double sg_host_get_idle_consumption(sg_host_t host)
 {