svn commit: r918937 - /subversion/trunk/subversion/include/svn_subst.h

[st...@apache.org]

Author: stsp
Date: Thu Mar  4 11:14:10 2010
New Revision: 918937

URL: http://svn.apache.org/viewvc?rev=918937&view=rev
Log:
* subversion/include/svn_subst.h:
  (svn_subst_stream_translated): Document EOL_STR and REPAIR parameters.

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

Modified: subversion/trunk/subversion/include/svn_subst.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_subst.h?rev=918937&r1=918936&r2=918937&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_subst.h (original)
+++ subversion/trunk/subversion/include/svn_subst.h Thu Mar  4 11:14:10 2010
@@ -292,6 +292,13 @@
  * contract keywords.  One stream supports both read and write
  * operations.  Reads and writes may be mixed.
  *
+ * If @a eol_str is non-@c NULL, replace whatever bytestring the input uses
+ * to denote line endings with @a eol_str in the output.  If the input has an
+ * inconsistent line ending style, then: if @a repair is @c FALSE, return
+ * @c SVN_ERR_IO_INCONSISTENT_EOL, else if @a repair is @c TRUE, convert any
+ * line ending to @a eol_str in @a .  Recognized line endings are:
+ * "\n", "\r", and "\r\n".
+ *
  * The stream returned is allocated in @a pool.
  *
  * If the inner stream implements resetting via svn_stream_reset(),