You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by ju...@apache.org on 2010/12/07 13:38:44 UTC
svn commit: r1043009 - /subversion/trunk/subversion/include/svn_path.h
Author: julianfoad
Date: Tue Dec 7 12:38:43 2010
New Revision: 1043009
URL: http://svn.apache.org/viewvc?rev=1043009&view=rev
Log:
* subversion/include/svn_path.h
In the doc strings of deprecated functions, move the paragraph offering
suggested replacements into the '@deprecated' paragraph, where that
information is expected.
Modified:
subversion/trunk/subversion/include/svn_path.h
Modified: subversion/trunk/subversion/include/svn_path.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_path.h?rev=1043009&r1=1043008&r2=1043009&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_path.h (original)
+++ subversion/trunk/subversion/include/svn_path.h Tue Dec 7 12:38:43 2010
@@ -65,10 +65,9 @@ extern "C" {
/** Convert @a path from the local style to the canonical internal style.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_internal_style() or
* svn_relpath_internal_style().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
const char *
@@ -76,10 +75,9 @@ svn_path_internal_style(const char *path
/** Convert @a path from the canonical internal style to the local style.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_local_style() or
* svn_relpath_local_style().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
const char *
@@ -109,10 +107,9 @@ svn_path_local_style(const char *path, a
* @a component won't be detected. An absolute URI can only be used
* for the base.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_join(), svn_uri_join(),
* svn_relpath_join() or svn_fspath__join().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
char *
@@ -130,10 +127,9 @@ svn_path_join(const char *base, const ch
*
* See svn_path_join() for further notes about joining paths.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* For new code, consider using svn_dirent_join_many() or a sequence of
* calls to one of the *_join() functions.
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
char *
@@ -152,10 +148,9 @@ svn_path_join_many(apr_pool_t *pool, con
*
* @note If an empty string is passed, then an empty string will be returned.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_basename(), svn_uri_basename(),
* svn_relpath_basename() or svn_fspath__basename().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
char *
@@ -167,10 +162,9 @@ svn_path_basename(const char *path, apr_
*
* The returned dirname will be allocated in @a pool.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_dirname(), svn_uri_dirname(),
* svn_relpath_dirname() or svn_fspath__dirname().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
char *
@@ -240,10 +234,9 @@ svn_path_remove_components(svn_stringbuf
* - <pre>"bar" ==> "" and "bar"</pre>
* - <pre>"" ==> "" and ""</pre>
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_split(), svn_uri_split(),
* svn_relpath_split() or svn_fspath__split().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
void
@@ -282,10 +275,9 @@ svn_dirent_is_root(const char *dirent, a
* The returned path may be statically allocated, equal to @a path, or
* allocated from @a pool.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_canonicalize(), svn_uri_canonicalize(),
* svn_relpath_canonicalize() or svn_fspath__canonicalize().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
const char *
@@ -294,11 +286,10 @@ svn_path_canonicalize(const char *path,
/** Return @c TRUE iff path is canonical. Use @a pool for temporary
* allocations.
*
- * New code should use svn_dirent_is_canonical(), svn_uri_is_canonical(),
- * svn_relpath_is_canonical() or svn_fspath__is_canonical().
- *
* @since New in 1.5.
* @deprecated Provided for backward compatibility with the 1.6 API.
+ * New code should use svn_dirent_is_canonical(), svn_uri_is_canonical(),
+ * svn_relpath_is_canonical() or svn_fspath__is_canonical().
*/
SVN_DEPRECATED
svn_boolean_t
@@ -322,11 +313,10 @@ svn_path_compare_paths(const char *path1
* different resources), and (b) share a common ancestor in their path
* component, i.e. 'protocol://' is not a sufficient ancestor.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_get_longest_ancestor(),
* svn_uri_get_longest_ancestor(), svn_relpath_get_longest_ancestor() or
* svn_fspath__get_longest_ancestor().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
char *
@@ -340,9 +330,8 @@ svn_path_get_longest_ancestor(const char
* @a relative may be a URL, in which case no attempt is made to convert it,
* and a copy of the URL is returned.
*
- * New code should use svn_dirent_get_absolute() on a non-URL input.
- *
* @deprecated Provided for backward compatibility with the 1.6 API.
+ * New code should use svn_dirent_get_absolute() on a non-URL input.
*/
SVN_DEPRECATED
svn_error_t *
@@ -356,10 +345,9 @@ svn_path_get_absolute(const char **pabso
* empty string. If @a path does not exist it is treated as if it is
* a file, since directories do not normally vanish.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should implement the required logic directly; no direct
* replacement is provided.
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
svn_error_t *
@@ -399,10 +387,9 @@ svn_path_split_if_file(const char *path,
* @note There is no guarantee that @a *pcommon is within a working
* copy.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_condense_targets() or
* svn_uri_condense_targets().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
svn_error_t *
@@ -523,10 +510,9 @@ svn_path_is_dotpath_present(const char *
* in which case a pointer into @a path2 will be returned to
* identify the remainder path.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_is_child(), svn_uri_is_child(),
* svn_relpath_is_child() or svn_fspath__is_child().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
const char *
@@ -537,10 +523,9 @@ svn_path_is_child(const char *path1, con
*
* @since New in 1.3.
*
+ * @deprecated Provided for backward compatibility with the 1.6 API.
* New code should use svn_dirent_is_ancestor(), svn_uri_is_ancestor(),
* svn_relpath_is_ancestor() or svn_fspath__is_ancestor().
- *
- * @deprecated Provided for backward compatibility with the 1.6 API.
*/
SVN_DEPRECATED
svn_boolean_t