Hi,
Just finished reading svn_wc.h and came up with a few
changes to some docstrings.
Log
[[[
Made a few docstring changes.
* subversion/include/svn_wc.h
(svn_wc_adm_open_anchor): s/ @c/ @c/
(svn_wc_parse_externals_description3):s/, look/. Look/
(svn_opt_revision_t file_external_rev;): s/a intra/an intra/
(svn_wc_add3): s/its/it's/
(svn_wc_crawl_revisions4): s/locks are or/locks or/
s/Iff/If/
(svn_wc_get_diff_editor6): s/from repository/from the repository/
]]]
------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1844863
Index: subversion/include/svn_wc.h
===================================================================
--- subversion/include/svn_wc.h (revision 37409)
+++ subversion/include/svn_wc.h (working copy)
@@ -287,7 +287,7 @@
*
* @a levels_to_lock determines the levels_to_lock used when opening
* @a path if @a path is a versioned directory, @a levels_to_lock is
- * ignored otherwise. If @a write_lock is @c TRUE the access batons
+ * ignored otherwise. If @a write_lock is @c TRUE the access batons
* will hold write locks.
*
* If @a cancel_func is non-NULL, call it with @a cancel_baton to determine
@@ -664,7 +664,7 @@
* and don't care about the parsed result, pass NULL for @a externals_p.
*
* The format of @a desc is the same as for values of the directory
- * property @c SVN_PROP_EXTERNALS, look there for more details.
+ * property @c SVN_PROP_EXTERNALS. Look there for more details.
*
* Allocate the table, keys, and values in @a pool.
*
@@ -2362,7 +2362,7 @@
* @since New in 1.6. */
svn_opt_revision_t file_external_peg_rev;
- /** The entry is a intra-repository file external and this is the
+ /** The entry is an intra-repository file external and this is the
* operative revision number specified in the externals definition.
* This field is only valid when the file_external_path field is
* non-NULL. The only permissible values are
@@ -3485,7 +3485,7 @@
* - ### @todo Remove old wcprops too, see the '###' below.
*
*<pre> ### I think possibly the "switchover" functionality should be
- * ### broken out into a separate function, but its all intertwined in
+ * ### broken out into a separate function, but it's all intertwined in
* ### the code right now. Ben, thoughts? Hard? Easy? Mauve?</pre>
*
* ### Update: see "###" comment in svn_wc_add_repos_file3()'s doc
@@ -3999,7 +3999,7 @@
* to @a reporter/@a report_baton. Obviously, if @a path is a file
* instead of a directory, this depth-first crawl will be a short one.
*
- * No locks are or logs are created, nor are any animals harmed in the
+ * No locks or logs are created, nor are any animals harmed in the
* process. No cleanup is necessary. @a adm_access must be an access
* baton for the @a path hierarchy, it does not require a write lock.
*
@@ -4018,7 +4018,7 @@
* course. If @a depth is @c svn_depth_unknown, then just use
* @c svn_depth_infinity, which in practice means depth of @a path.
*
- * Iff @a honor_depth_exclude is TRUE, the crawler will report paths
+ * If @a honor_depth_exclude is TRUE, the crawler will report paths
* whose ambient depth is @c svn_depth_exclude as being excluded, and
* thus prevent the server from pushing update data for those paths;
* therefore, don't set this flag if you wish to pull in excluded paths.
@@ -4035,7 +4035,7 @@
* not, because the latter is trying to explicitly pull in E. In
* general, we never report the update target as excluded.
*
- * Iff @a depth_compatibility_trick is TRUE, then set the @c start_empty
+ * If @a depth_compatibility_trick is TRUE, then set the @c start_empty
* flag on @a reporter->set_path() and @a reporter->link_path() calls
* as necessary to trick a pre-1.5 (i.e., depth-unaware) server into
* sending back all the items the client might need to upgrade a
@@ -4668,7 +4668,7 @@
* If @a use_text_base is TRUE, then compare the repository against
* the working copy's text-base files, rather than the working files.
*
- * Normally, the difference from repository->working_copy is shown.
+ * Normally, the difference from the repository->working_copy is shown.
* If @a reverse_order is TRUE, then show working_copy->repository diffs.
*
* If @a cancel_func is non-NULL, it will be used along with @a cancel_baton
Received on 2009-04-21 17:19:53 CEST