svn commit: r1305642 - /subversion/branches/inheritable-props/subversion/include/svn_ra.h

[pb...@apache.org]

Author: pburba
Date: Mon Mar 26 22:30:10 2012
New Revision: 1305642

URL: http://svn.apache.org/viewvc?rev=1305642&view=rev
Log:
On the inheritable-props branch: API comment tweak.

* subversion/include/svn_ra.h
  (svn_ra_get_file2,
   svn_ra_get_dir3): Document the dependency on the
   SVN_RA_CAPABILITY_INHERITED_PROPS capability when asking for inherited
   props.

Modified:
    subversion/branches/inheritable-props/subversion/include/svn_ra.h

Modified: subversion/branches/inheritable-props/subversion/include/svn_ra.h
URL: http://svn.apache.org/viewvc/subversion/branches/inheritable-props/subversion/include/svn_ra.h?rev=1305642&r1=1305641&r2=1305642&view=diff
==============================================================================
--- subversion/branches/inheritable-props/subversion/include/svn_ra.h (original)
+++ subversion/branches/inheritable-props/subversion/include/svn_ra.h Mon Mar 26 22:30:10 2012
@@ -938,12 +938,16 @@ svn_ra_get_commit_editor(svn_ra_session_
  * etc.)  The keys are <tt>const char *</tt>, values are
  * <tt>@c svn_string_t *</tt>.
  *
- * If @a inherited_props is not @c NULL, then set @a *inherited_props to a
- * depth-first ordered array of #svn_prop_inherited_item_t * structures
+ * If the server advertises the #SVN_RA_CAPABILITY_INHERITED_PROPS capability
+ * and if @a inherited_props is not @c NULL, then set @a *inherited_props to
+ * a depth-first ordered array of #svn_prop_inherited_item_t * structures
  * representing the properties inherited by @a path at @a revision (or the
  * 'head' revision if @a revision is @c SVN_INVALID_REVNUM.  If
  * @a inherited_props is not @c NULL and no inheritable properties are found,
- * then set @a *inherited_props to an empty array.
+ * then set @a *inherited_props to an empty array.  If the server does not
+ * advertise the #SVN_RA_CAPABILITY_INHERITED_PROPS capability and
+ * @a inherited_props is not @c NULL, then set @a *inherited_props to
+ * @c NULL.
  *
  * The stream handlers for @a stream may not perform any RA
  * operations using @a session.
@@ -1003,12 +1007,16 @@ svn_ra_get_file(svn_ra_session_t *sessio
  * etc.)  The keys are <tt>const char *</tt>, values are
  * <tt>@c svn_string_t *</tt>.
  *
- * If @a inherited_props is not @c NULL, then set @a *inherited_props to a
- * depth-first ordered array of #svn_prop_inherited_item_t * structures
+ * If the server advertises the #SVN_RA_CAPABILITY_INHERITED_PROPS capability
+ * and if @a inherited_props is not @c NULL, then set @a *inherited_props to
+ * a depth-first ordered array of #svn_prop_inherited_item_t * structures
  * representing the properties inherited by @a path at @a revision (or the
  * 'head' revision if @a revision is @c SVN_INVALID_REVNUM.  If
  * @a inherited_props is not @c NULL and no inheritable properties are found,
- * then set @a *inherited_props to an empty array.
+ * then set @a *inherited_props to an empty array.  If the server does not
+ * advertise the #SVN_RA_CAPABILITY_INHERITED_PROPS capability and
+ * @a inherited_props is not @c NULL, then set @a *inherited_props to
+ * @c NULL.
  *
  * @since New in 1.8.
  */