svn commit: r1423463 - /subversion/trunk/subversion/libsvn_wc/props.c

[ju...@apache.org]

Author: julianfoad
Date: Tue Dec 18 14:59:45 2012
New Revision: 1423463

URL: http://svn.apache.org/viewvc?rev=1423463&view=rev
Log:
* subversion/libsvn_wc/props.c
  (validate_eol_prop_against_file): Document this function.

Modified:
    subversion/trunk/subversion/libsvn_wc/props.c

Modified: subversion/trunk/subversion/libsvn_wc/props.c
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_wc/props.c?rev=1423463&r1=1423462&r2=1423463&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_wc/props.c (original)
+++ subversion/trunk/subversion/libsvn_wc/props.c Tue Dec 18 14:59:45 2012
@@ -1608,7 +1608,16 @@ get_file_for_validation(const svn_string
 }
 
 
-/* */
+/* Validate that a file has a 'non-binary' MIME type and contains
+ * self-consistent line endings.  If not, then return an error.
+ *
+ * Call GETTER (which must not be NULL) with GETTER_BATON to get the
+ * file's MIME type and/or content.  If the MIME type is non-null and
+ * is categorized as 'binary' then return an error and do not request
+ * the file content.
+ *
+ * Use PATH (a local path or a URL) only for error messages.
+ */
 static svn_error_t *
 validate_eol_prop_against_file(const char *path,
                                svn_wc_canonicalize_svn_prop_get_file_t getter,