* subversion/include/svn_dirent_uri.h
(svn_dirent_canonicalize,
svn_relpath_canonicalize,
svn_uri_canonicalize): Update docstrings, refering to the safe versions.
@@ -486,7 +486,8 @@ svn_boolean_t
svn_uri_is_root(const char *uri,
apr_size_t len);
-/** Return a new dirent like @a dirent, but transformed such that some types
+/**
+ * Return a new dirent like @a dirent, but transformed such that some types
* of dirent specification redundancies are removed.
*
* This involves:
@@ -500,6 +501,10 @@ svn_uri_is_root(const char *uri,
*
* Allocate the result in @a result_pool.
*
+ * @warning This function may call @c abort() if @a dirent can not be
+ * canonicalized.
+ * Use svn_dirent_canonicalize_safe() for tainted input.
+ *
* @since New in 1.6.
*/
const char *
@@ -531,7 +536,8 @@ svn_dirent_canonicalize_safe(const char **canonical_dirent,
apr_pool_t *scratch_pool);
-/** Return a new relpath like @a relpath, but transformed such that some types
+/**
+ * Return a new relpath like @a relpath, but transformed such that some types
* of relpath specification redundancies are removed.
*
* This involves:
@@ -543,6 +549,10 @@ svn_dirent_canonicalize_safe(const char **canonical_dirent,
*
* Allocate the result in @a result_pool.
*
+ * @warning This function may call @c abort() if @a relpath can not be
+ * canonicalized.
+ * Use svn_relpath_canonicalize_safe() for tainted input.
+ *
* @since New in 1.7.
*/
const char *
@@ -575,7 +585,8 @@ svn_relpath_canonicalize_safe(const char **canonical_relpath,
apr_pool_t *scratch_pool);
-/** Return a new uri like @a uri, but transformed such that some types
+/**
+ * Return a new uri like @a uri, but transformed such that some types
* of uri specification redundancies are removed.
*
* This involves:
@@ -591,6 +602,10 @@ svn_relpath_canonicalize_safe(const char **canonical_relpath,
* and possibly other semantically inoperative transformations.
*
* Allocate the result in @a result_pool.
+ *
+ * @warning This function may call @c abort() if @a uri can not be
+ * canonicalized.
+ * Use svn_uri_canonicalize_safe() for tainted input.
*
* @since New in 1.7.
*/
