svn commit: r1704825 - /subversion/trunk/subversion/libsvn_client/client.h

[rh...@apache.org]

Author: rhuijben
Date: Wed Sep 23 12:05:47 2015
New Revision: 1704825

URL: http://svn.apache.org/viewvc?rev=1704825&view=rev
Log:
Update some documentation to avoid regressions as the one fixed in r1703689.

* subversion/libsvn_client/client.h
  (svn_client__get_normalized_stream):
     Following up on r1703689, tweak documentation.

Modified:
    subversion/trunk/subversion/libsvn_client/client.h

Modified: subversion/trunk/subversion/libsvn_client/client.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_client/client.h?rev=1704825&r1=1704824&r2=1704825&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_client/client.h (original)
+++ subversion/trunk/subversion/libsvn_client/client.h Wed Sep 23 12:05:47 2015
@@ -1072,9 +1072,13 @@ svn_client__ensure_revprop_table(apr_has
    EXPAND_KEYWORDS operates as per the EXPAND argument to
    svn_subst_stream_translated, which see.  If NORMALIZE_EOLS is TRUE and
    LOCAL_ABSPATH requires translation, then normalize the line endings in
-   *NORMAL_STREAM.
+   *NORMAL_STREAM to "\n" if the stream has svn:eol-style set.
 
-   Uses SCRATCH_POOL for temporary allocations. */
+   Note that this IS NOT the repository normal form of the stream as that
+   would use "\r\n" if set to CRLF and "\r" if set to CR.
+
+   The stream is allocated in RESULT_POOL and temporary SCRATCH_POOL is
+   used for temporary allocations. */
 svn_error_t *
 svn_client__get_normalized_stream(svn_stream_t **normal_stream,
                                   svn_wc_context_t *wc_ctx,