Move deprecated functions to hwloc/deprecated.h

Only hwloc_obj_snprintf goes there for now
(it has been documented as deprecated for a long time).

This commit was SVN r5774.

diff --git a/NEWS b/NEWS
index b520748fc27b54f531bf61449bc847f0b5b83fd0..45fba498f4badb840f45a8b75598cd6431b97108 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -44,10 +44,12 @@ Version 1.8.0
     crashes when hwloc is dynamically loaded by another plugin mechanisms.
   + Add --with-hwloc-plugins-path to specify the install/load directories
     of plugins.
-* Documentation
+* API
   + hwloc.h and hwloc/helper.h have been reorganized to clarify the
-    documentation sections. The actual online code has moved out of hwloc.h
+    documentation sections. The actual inline code has moved out of hwloc.h
     into the new hwloc/inlines.h.
+  + Deprecated functions are now in hwloc/deprecated.h, and not in the
+    official documentation anymore.
 
 Version 1.7.1
 -------------

diff --git a/doc/Makefile.am b/doc/Makefile.am
index a00e63ee0d85787a98faf4a54c58adb64238599d..ab886295d208b80b6ceabb15d7f53f90a678ce2b 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -386,7 +386,6 @@ man3_object_strings_DATA = \
         $(DOX_MAN_DIR)/man3/hwloc_obj_type_of_string.3 \
         $(DOX_MAN_DIR)/man3/hwloc_obj_type_snprintf.3 \
         $(DOX_MAN_DIR)/man3/hwloc_obj_attr_snprintf.3 \
-        $(DOX_MAN_DIR)/man3/hwloc_obj_snprintf.3 \
         $(DOX_MAN_DIR)/man3/hwloc_obj_cpuset_snprintf.3 \
         $(DOX_MAN_DIR)/man3/hwloc_obj_get_info_by_name.3 \
         $(DOX_MAN_DIR)/man3/hwloc_obj_add_info.3

diff --git a/include/Makefile.am b/include/Makefile.am
index ad6c94ef635df7d4b3d80251dd55e4fe18ddc8a3..9c5318f187d5fe554ddc957ada0242c84827164f 100644 (file)
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -23,7 +23,8 @@ include_hwloc_HEADERS = \
         hwloc/plugins.h \
         hwloc/gl.h \
         hwloc/intel-mic.h \
-        hwloc/rename.h
+        hwloc/rename.h \
+        hwloc/deprecated.h
 include_hwloc_autogendir = $(includedir)/hwloc/autogen
 nodist_include_hwloc_autogen_HEADERS = hwloc/autogen/config.h 
 

diff --git a/include/hwloc.h b/include/hwloc.h
index 8ff37a04db5e1fd14649197f5d4ad88fb794501c..3c248363f885f6caa5f891138a1d80ba84407e41 100644 (file)
--- a/include/hwloc.h
+++ b/include/hwloc.h
@@ -1203,30 +1203,6 @@ HWLOC_DECLSPEC int hwloc_obj_type_snprintf(char * __hwloc_restrict string, size_
 HWLOC_DECLSPEC int hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t obj, const char * __hwloc_restrict separator,
                                   int verbose);
 
-/** \brief Stringify a given topology object into a human-readable form.
- *
- * \note This function is deprecated in favor of hwloc_obj_type_snprintf()
- * and hwloc_obj_attr_snprintf() since it is not very flexible and
- * only prints physical/OS indexes.
- *
- * Fill string \p string up to \p size characters with the description
- * of topology object \p obj in topology \p topology.
- *
- * If \p verbose is set, a longer description is used. Otherwise a
- * short description is used.
- *
- * \p indexprefix is used to prefix the \p os_index attribute number of
- * the object in the description. If \c NULL, the \c # character is used.
- *
- * If \p size is 0, \p string may safely be \c NULL.
- *
- * \return the number of character that were actually written if not truncating,
- * or that would have been written (not including the ending \\0).
- */
-HWLOC_DECLSPEC int hwloc_obj_snprintf(char * __hwloc_restrict string, size_t size,
-                            hwloc_topology_t topology, hwloc_obj_t obj,
-                            const char * __hwloc_restrict indexprefix, int verbose);
-
 /** \brief Stringify the cpuset containing a set of objects.
  *
  * If \p size is 0, \p string may safely be \c NULL.
@@ -2247,5 +2223,7 @@ HWLOC_DECLSPEC void hwloc_topology_set_userdata_import_callback(hwloc_topology_t
 /* inline code of some functions above */
 #include <hwloc/inlines.h>
 
+/* deprecated headers */
+#include <hwloc/deprecated.h>
 
 #endif /* HWLOC_H */

diff --git a/include/hwloc/rename.h b/include/hwloc/rename.h
index ad7fe067afe249d0c5d3c851df46d94a26f10620..51b99d7d302836ab80866e24c8ae93563e109ac9 100644 (file)
--- a/include/hwloc/rename.h
+++ b/include/hwloc/rename.h
@@ -178,7 +178,6 @@ extern "C" {
 #define hwloc_obj_type_of_string HWLOC_NAME(obj_type_of_string )
 #define hwloc_obj_type_snprintf HWLOC_NAME(obj_type_snprintf )
 #define hwloc_obj_attr_snprintf HWLOC_NAME(obj_attr_snprintf )
-#define hwloc_obj_snprintf HWLOC_NAME(obj_snprintf)
 #define hwloc_obj_cpuset_snprintf HWLOC_NAME(obj_cpuset_snprintf)
 #define hwloc_obj_get_info_by_name HWLOC_NAME(obj_get_info_by_name)
 #define hwloc_obj_add_info HWLOC_NAME(obj_add_info)
@@ -460,6 +459,10 @@ extern "C" {
 #define hwloc_pci_find_linkspeed HWLOC_NAME(pci_find_linkspeed)
 #define hwloc_pci_prepare_bridge HWLOC_NAME(pci_prepare_bridge)
 
+/* hwloc/deprecated.h */
+
+#define hwloc_obj_snprintf HWLOC_NAME(obj_snprintf)
+
 /* private/debug.h */
 
 #define hwloc_debug HWLOC_NAME(debug)