subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cmpil...@apache.org
Subject svn commit: r1462626 - /subversion/trunk/subversion/include/svn_client.h
Date Fri, 29 Mar 2013 20:08:01 GMT
Author: cmpilato
Date: Fri Mar 29 20:08:01 2013
New Revision: 1462626

URL: http://svn.apache.org/r1462626
Log:
* subversion/include/svn_client.h
  Miscellaneous docstring tweaks for clarity and correctness.

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

Modified: subversion/trunk/subversion/include/svn_client.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_client.h?rev=1462626&r1=1462625&r2=1462626&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_client.h (original)
+++ subversion/trunk/subversion/include/svn_client.h Fri Mar 29 20:08:01 2013
@@ -515,10 +515,11 @@ typedef struct svn_client_commit_item3_t
    * When committing a move, this contains the absolute path where
    * the node was directly moved from. (If an ancestor at the original
    * location was moved then it points to where the node itself was
-   * moved, from. Not the original location)
+   * moved from; not the original location.)
    * @since New in 1.8.
    */
   const char *moved_from_abspath;
+
 } svn_client_commit_item3_t;
 
 /** The commit candidate structure.
@@ -1857,8 +1858,9 @@ svn_client_delete(svn_client_commit_info
  * for it when walking the directory tree. Only the kind of node, including
  * special status is available in @a dirent.
  *
- * Implementations can set @a *filtered to TRUE, to make the import filter the
- * node and (if the node is a directory) all its descendants.
+ * Implementations can set @a *filtered to TRUE, to make the import
+ * process omit the node and (if the node is a directory) all its
+ * descendants.
  *
  * @a scratch_pool can be used for temporary allocations.
  *
@@ -2093,9 +2095,9 @@ svn_client_import(svn_client_commit_info
  *
  * If @a include_file_externals and/or @a include_dir_externals are #TRUE,
  * also commit all file and/or dir externals (respectively) that are reached
- * by recursion, with these exceptions: Never recurse to externals
- * - that have a fixed revision or
- * - that come from a different repository root URL (dir externals).
+ * by recursion, except for those externals which:
+ *     - have a fixed revision, or
+ *     - come from a different repository root URL (dir externals).
  * These flags affect only recursion; externals that directly appear in @a
  * targets are always included in the commit.
  *
@@ -2140,6 +2142,7 @@ svn_client_commit6(const apr_array_heade
 /**
  * Similar to svn_client_commit6(), but passes @a include_file_externals as
  * FALSE and @a include_dir_externals as FALSE.
+ * 
  * @since New in 1.7.
  * @deprecated Provided for backward compatibility with the 1.7 API.
  */
@@ -3031,8 +3034,10 @@ svn_client_diff6(const apr_array_header_
                  apr_pool_t *pool);
 
 /** Similar to svn_client_diff6(), but with @a outfile and @a errfile,
- * instead of @a outstream and @a errstream, and always showing property
- * changes and additions.
+ * instead of @a outstream and @a errstream, and with @a
+ * no_diff_added, @a ignore_properties, and @a properties_only always
+ * passed as @c FALSE (which means that additions and property changes
+ * are always transmitted).
  *
  * @deprecated Provided for backward compatibility with the 1.7 API.
  * @since New in 1.7.
@@ -3192,9 +3197,11 @@ svn_client_diff_peg6(const apr_array_hea
                      svn_client_ctx_t *ctx,
                      apr_pool_t *pool);
 
-/** Similar to svn_client_diff_peg6(), but with @a outfile and @a errfile,
- * instead of @a outstream and @a errstream, and always showing property
- * changes.
+/** Similar to svn_client_diff6_peg6(), but with @a outfile and @a errfile,
+ * instead of @a outstream and @a errstream, and with @a
+ * no_diff_added, @a ignore_properties, and @a properties_only always
+ * passed as @c FALSE (which means that additions and property changes
+ * are always transmitted).
  *
  * @deprecated Provided for backward compatibility with the 1.7 API.
  * @since New in 1.7.
@@ -4613,8 +4620,8 @@ svn_client_move7(const apr_array_header_
                  apr_pool_t *pool);
 
 /**
- * Similar to svn_client_move7(), but with allow_mixed_revisions always
- * set to @c TRUE and record_only always to @c FALSE.
+ * Similar to svn_client_move7(), but with @a allow_mixed_revisions always
+ * set to @c TRUE and @a metadata_only always to @c FALSE.
  *
  * @since New in 1.7.
  * @deprecated Provided for backward compatibility with the 1.7 API.
@@ -5047,8 +5054,8 @@ svn_client_propget5(apr_hash_t **props,
                     apr_pool_t *scratch_pool);
 
 /**
- * Similar to svn_client_propget5 but doesn't support the retrieval of the
- * properties inherited by @a target.
+ * Similar to svn_client_propget5 but with @a inherited_props always
+ * passed as NULL.
  *
  * @since New in 1.7.
  * @deprecated Provided for backward compatibility with the 1.8 API.
@@ -5207,9 +5214,9 @@ svn_client_proplist4(const char *target,
                      apr_pool_t *scratch_pool);
 
 /**
- * Similar to svn_client_proplist4(), except that the @a receiver type is
- * a #svn_proplist_receiver_t and there is no support for finding the
- * inherited properties for @a target and there is no separate scratch pool.
+ * Similar to svn_client_proplist4(), except that the @a receiver type
+ * is a #svn_proplist_receiver_t, @a get_target_inherited_props is
+ * always passed NULL, and there is no separate scratch pool.
  *
  * @since New in 1.5.
  *
@@ -5484,7 +5491,7 @@ svn_client_export(svn_revnum_t *result_r
  * Moreover, we will never mix items which are part of separate
  * externals, and will always finish listing an external before listing
  * the next one.
-
+ *
  * @a scratch_pool may be used for temporary allocations.
  *
  * @since New in 1.8.
@@ -5567,8 +5574,8 @@ svn_client_list3(const char *path_or_url
                  apr_pool_t *pool);
 
 
-/** Similar to svn_client_list3(), but with @a include_externals set to FALSE, 
- * and using a #svn_client_list_func_t as callback.
+/** Similar to svn_client_list3(), but with @a include_externals set
+ * to FALSE, and using a #svn_client_list_func_t as callback.
  *
  * @deprecated Provided for backwards compatibility with the 1.7 API.
  *
@@ -6524,8 +6531,9 @@ svn_client_open_ra_session2(svn_ra_sessi
                            apr_pool_t *result_pool,
                            apr_pool_t *scratch_pool);
 
-/** Similar to svn_client_open_ra_session(), but doesn't allow passing a
- * working copy path.
+/** Similar to svn_client_open_ra_session(), but with @ wri_abspath
+ * always passed as NULL, and with the same pool used as both @a
+ * result_pool and @a scratch_pool.
  *
  * @since New in 1.3.
  * @deprecated Provided for backward compatibility with the 1.7 API.



Mime
View raw message