svn commit: r1649875 - /subversion/trunk/subversion/include/svn_repos.h

[ju...@apache.org]

Author: julianfoad
Date: Tue Jan  6 17:09:16 2015
New Revision: 1649875

URL: http://svn.apache.org/r1649875
Log:
* subversion/include/svn_repos.h
  (svn_repos_get_fs_build_parser5): Document the 'use_history' flag better.

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

Modified: subversion/trunk/subversion/include/svn_repos.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1649875&r1=1649874&r2=1649875&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Tue Jan  6 17:09:16 2015
@@ -3340,11 +3340,17 @@ svn_repos_parse_dumpstream3(svn_stream_t
  * @a end_rev).  They refer to dump stream revision numbers rather than
  * committed revision numbers.
  *
- * If @a use_history is set, then the parser will require relative
- * 'copyfrom' history to exist in the repository when it encounters
- * nodes that are added-with-history.
- * ### What does 'require relative copyfrom history to exist' mean?
- * ### What happens if @a use_history is false?
+ * If @a use_history is true, then when the parser encounters a node that
+ * is added-with-history, it will require 'copy-from' history to exist in
+ * the repository at the relative (adjusted) copy-from revision and path.
+ * It will perform a copy from that source location, and will fail if no
+ * suitable source exists there. If @a use_history is false, then it will
+ * instead convert every copy to a plain add.
+ *
+ * ### The 'use_history=FALSE' case is unused and untested in Subversion.
+ *     It seems to me it would not work with a deltas dumpfile (a driver
+ *     that calls the @c apply_textdelta method), as it would not have
+ *     access to the delta base text.
  *
  * If @a use_pre_commit_hook is set, call the repository's pre-commit
  * hook before committing each loaded revision.