svn commit: r1436338 - /subversion/trunk/subversion/libsvn_client/patch.c

[st...@apache.org]

Author: stsp
Date: Mon Jan 21 13:37:49 2013
New Revision: 1436338

URL: http://svn.apache.org/viewvc?rev=1436338&view=rev
Log:
* subversion/libsvn_client/patch.c
  (tell_symlink, seek_symlink, write_symlink): Clarify the behaviour and
   purpose of these functions by rewriting their docstrings.

Modified:
    subversion/trunk/subversion/libsvn_client/patch.c

Modified: subversion/trunk/subversion/libsvn_client/patch.c
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_client/patch.c?rev=1436338&r1=1436337&r2=1436338&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_client/patch.c (original)
+++ subversion/trunk/subversion/libsvn_client/patch.c Mon Jan 21 13:37:49 2013
@@ -871,7 +871,8 @@ readline_symlink(void *baton, svn_string
   return SVN_NO_ERROR;
 }
 
-/* Return in *OFFSET whether we are before or after the link. */
+/* Set *OFFSET to 1 or 0 depending on whether the "normal form" of
+ * the symlink has already been read. */
 static svn_error_t *
 tell_symlink(void *baton, apr_off_t *offset, apr_pool_t *scratch_pool)
 {
@@ -881,8 +882,8 @@ tell_symlink(void *baton, apr_off_t *off
   return SVN_NO_ERROR;
 }
 
-/* Seek to the specified by OFFSET in the unpatched file content accessed
- * via BATON. Use SCRATCH_POOL for temporary allocations. */
+/* If offset is non-zero, mark the symlink as having been read in its
+ * "normal form". Else, mark the symlink as not having been read yet. */
 static svn_error_t *
 seek_symlink(void *baton, apr_off_t offset, apr_pool_t *scratch_pool)
 {
@@ -892,8 +893,9 @@ seek_symlink(void *baton, apr_off_t offs
   return SVN_NO_ERROR;
 }
 
-/* Write LEN bytes from BUF into the patched file content accessed
- * via BATON. Use SCRATCH_POOL for temporary allocations. */
+
+/* Set the target of the symlink accessed via BATON.
+ * The contents of BUF must be a valid "normal form" of a symlink. */
 static svn_error_t *
 write_symlink(void *baton, const char *buf, apr_size_t len,
            apr_pool_t *scratch_pool)