svn commit: r1575245 - /subversion/trunk/subversion/include/svn_fs.h

[st...@apache.org]

Author: stefan2
Date: Fri Mar  7 12:27:29 2014
New Revision: 1575245

URL: http://svn.apache.org/r1575245
Log:
* subversion/include/svn_fs.h
  (svn_fs_compare_ids
   svn_fs_check_related): Document that we would like API users to switch
                          to the new path-based comparison function.

Modified:
    subversion/trunk/subversion/include/svn_fs.h

Modified: subversion/trunk/subversion/include/svn_fs.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1575245&r1=1575244&r2=1575245&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Fri Mar  7 12:27:29 2014
@@ -823,6 +823,10 @@ typedef struct svn_fs_id_t svn_fs_id_t;
 
 /** Return -1, 0, or 1 if node revisions @a a and @a b are respectively
  * unrelated, equivalent, or otherwise related (part of the same node).
+ *
+ * @note Using FS ID based functions is now discouraged and may be fully
+ * deprecated in future releases.  New code should use #svn_fs_node_relation()
+ * and #svn_fs_node_relation_t instead.
  */
 int
 svn_fs_compare_ids(const svn_fs_id_t *a,
@@ -832,6 +836,10 @@ svn_fs_compare_ids(const svn_fs_id_t *a,
 
 /** Return TRUE if node revisions @a id1 and @a id2 are related (part of the
  * same node), else return FALSE.
+ *
+ * @note Using FS ID based functions is now discouraged and may be fully
+ * deprecated in future releases.  New code should use #svn_fs_node_relation()
+ * and #svn_fs_node_relation_t instead.
  */
 svn_boolean_t
 svn_fs_check_related(const svn_fs_id_t *id1,