Rename gras_os_property_value() to gras_os_host_property_value(); Documentation tiny...

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@4888 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/include/gras/virtu.h b/include/gras/virtu.h
index c422fda..f67f5c6 100644 (file)
--- a/include/gras/virtu.h
+++ b/include/gras/virtu.h
@@ -69,13 +69,12 @@ gras_os_hostport(void);
 XBT_PUBLIC(int) gras_os_getpid(void);
 
 
-/* The following functions handle process property query */
+/* Properties related */
 XBT_PUBLIC(xbt_dict_t) gras_process_properties(void);
 XBT_PUBLIC(const char*) gras_process_property_value(char* name);
 
-/* The following functions handle host/cpu property query */
 XBT_PUBLIC(xbt_dict_t) gras_os_host_properties(void);
-XBT_PUBLIC(const char*) gras_os_property_value(char* name);   
+XBT_PUBLIC(const char*) gras_os_host_property_value(char* name);   
 
 /** @} */
 SG_END_DECL()

diff --git a/src/gras/Virtu/sg_process.c b/src/gras/Virtu/sg_process.c
index 416c9d5..e84f1ab 100644 (file)
--- a/src/gras/Virtu/sg_process.c
+++ b/src/gras/Virtu/sg_process.c
@@ -137,20 +137,13 @@ gras_libdata_by_name_from_remote(const char *name, smx_process_t p) {
   return gras_libdata_by_name_from_procdata(name, pd);
 }   
 
-/**
- * \brief Returns the value of a property for the current gras process
- *
- * \return the value of the property
- */
-const char* gras_process_property_value(char* name)
-{
+/** @brief retrieve the value of a given process property (or NULL if not defined) */
+const char* gras_process_property_value(char* name) {
  return xbt_dict_get_or_null(SIMIX_process_get_properties(SIMIX_process_self()), name);
 }
 
-/**
- * \brief Returns the dictionary of properties for the current gras process
- *
- * \return the dictionary
+/** @brief retrieve the process properties dictionnary
+ *  @warning it's the original one, not a copy. Don't mess with it
  */
 xbt_dict_t gras_process_properties(void)
 {
@@ -182,23 +175,16 @@ int gras_os_getpid(void) {
     return 0;
 }
 
-/**
- * \brief Returns the value of a property for the current gras os
- *
- * \return the value of the property
- */
-const char* gras_os_property_value(char* name)
-{
+
+/** @brief retrieve the value of a given host property (or NULL if not defined) */
+const char* gras_os_host_property_value(char* name) {
  return xbt_dict_get_or_null(SIMIX_host_get_properties(SIMIX_process_get_host(SIMIX_process_self())), name);
 }
 
-/**
- * \brief Returns the dictionary of properties for the gras host
- *
- * \return the dictionary
+/** @brief retrieve the host properties dictionnary
+ *  @warning it's the original one, not a copy. Don't mess with it
  */
-xbt_dict_t gras_os_host_properties(void)
-{
+xbt_dict_t gras_os_host_properties(void) {
   return SIMIX_host_get_properties(SIMIX_process_get_host(SIMIX_process_self()));
 }