You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by br...@apache.org on 2013/06/06 19:24:20 UTC

svn commit: r1490367 - in /subversion/branches/1.8.x: ./ subversion/include/

Author: breser
Date: Thu Jun  6 17:24:20 2013
New Revision: 1490367

URL: http://svn.apache.org/r1490367
Log:
Merge a bunch of documentation fixes from trunk.

Specifically: r1483964, r1483965, r1483968, r1483972, r1483975, r1483977,
r1483984, r1484006, r1484016, r1484017, r1484023, r1485018


Modified:
    subversion/branches/1.8.x/   (props changed)
    subversion/branches/1.8.x/subversion/include/mod_authz_svn.h
    subversion/branches/1.8.x/subversion/include/svn_auth.h
    subversion/branches/1.8.x/subversion/include/svn_config.h
    subversion/branches/1.8.x/subversion/include/svn_error.h
    subversion/branches/1.8.x/subversion/include/svn_repos.h
    subversion/branches/1.8.x/subversion/include/svn_types.h
    subversion/branches/1.8.x/subversion/include/svn_wc.h

Propchange: subversion/branches/1.8.x/
------------------------------------------------------------------------------
  Merged /subversion/trunk:r1483964-1483965,1483968,1483972,1483975,1483977,1483984,1484006,1484016-1484017,1484023

Modified: subversion/branches/1.8.x/subversion/include/mod_authz_svn.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/mod_authz_svn.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/mod_authz_svn.h (original)
+++ subversion/branches/1.8.x/subversion/include/mod_authz_svn.h Thu Jun  6 17:24:20 2013
@@ -36,9 +36,20 @@ extern "C" {
 /*
  * mod_dav_svn to mod_authz_svn bypass mechanism
  */
+/** Provider group for subrequest bypass */
 #define AUTHZ_SVN__SUBREQ_BYPASS_PROV_GRP "dav2authz_subreq_bypass"
+/** Provider name for subrequest bypass */
 #define AUTHZ_SVN__SUBREQ_BYPASS_PROV_NAME "mod_authz_svn_subreq_bypass"
+/** Provider version for subrequest bypass */
 #define AUTHZ_SVN__SUBREQ_BYPASS_PROV_VER "00.00a"
+/** Provider to allow mod_dav_svn to bypass the generation of an apache
+ * request when checking GET access from "mod_dav_svn/auth.c".
+ *
+ * Uses @a r @a repos_path and @a repos_name to determine if the user
+ * making the request is authorized.
+ *
+ * If the access is allowed returns @c OK or @c HTTP_FORBIDDEN if it is not.
+ */
 typedef int (*authz_svn__subreq_bypass_func_t)(request_rec *r,
                                               const char *repos_path,
                                               const char *repos_name);

Modified: subversion/branches/1.8.x/subversion/include/svn_auth.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_auth.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_auth.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_auth.h Thu Jun  6 17:24:20 2013
@@ -569,11 +569,11 @@ svn_auth_get_parameter(svn_auth_baton_t 
 
 /**
  * @name Default credentials defines
- * Any 'default' credentials that came in through the application itself,
- * (e.g. --username and --password options). Property values are
- * const char *.
+ * Property values are const char *.
  * @{ */
+/** Default username provided by the application itself (e.g. --username) */
 #define SVN_AUTH_PARAM_DEFAULT_USERNAME  SVN_AUTH_PARAM_PREFIX "username"
+/** Default password provided by the application itself (e.g. --password) */
 #define SVN_AUTH_PARAM_DEFAULT_PASSWORD  SVN_AUTH_PARAM_PREFIX "password"
 /** @} */
 
@@ -628,9 +628,15 @@ svn_auth_get_parameter(svn_auth_baton_t 
 #define SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO SVN_AUTH_PARAM_PREFIX \
   "ssl:cert-info"
 
-/** Some providers need access to the @c svn_config_t configuration. */
-#define SVN_AUTH_PARAM_CONFIG_CATEGORY_CONFIG SVN_AUTH_PARAM_PREFIX "config-category-config"
-#define SVN_AUTH_PARAM_CONFIG_CATEGORY_SERVERS SVN_AUTH_PARAM_PREFIX "config-category-servers"
+/** This provides a pointer to a @c svn_config_t containting the config
+ * category. */
+#define SVN_AUTH_PARAM_CONFIG_CATEGORY_CONFIG SVN_AUTH_PARAM_PREFIX \
+  "config-category-config"
+
+/** This provides a pointer to a @c svn_config_t containting the servers
+ * category. */
+#define SVN_AUTH_PARAM_CONFIG_CATEGORY_SERVERS SVN_AUTH_PARAM_PREFIX \
+  "config-category-servers"
 
 /** @deprecated Provided for backward compatibility with the 1.5 API. */
 #define SVN_AUTH_PARAM_CONFIG SVN_AUTH_PARAM_CONFIG_CATEGORY_SERVERS

Modified: subversion/branches/1.8.x/subversion/include/svn_config.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_config.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_config.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_config.h Thu Jun  6 17:24:20 2013
@@ -247,7 +247,7 @@ svn_config_create(svn_config_t **cfgp,
  * otherwise return an empty @c svn_config_t.
  *
  * If @a section_names_case_sensitive is @c TRUE, populate section name hashes
- * case sensitively, except for the default #SVN_CONFIG__DEFAULT_SECTION.
+ * case sensitively, except for the @c "DEFAULT" section.
  *
  * If @a option_names_case_sensitive is @c TRUE, populate option name hashes
  * case sensitively.
@@ -292,7 +292,7 @@ svn_config_read(svn_config_t **cfgp,
  * @a result_pool.
  *
  * If @a section_names_case_sensitive is @c TRUE, populate section name hashes
- * case sensitively, except for the default #SVN_CONFIG__DEFAULT_SECTION.
+ * case sensitively, except for the @c "DEFAULT" section.
  *
  * If @a option_names_case_sensitive is @c TRUE, populate option name hashes
  * case sensitively.

Modified: subversion/branches/1.8.x/subversion/include/svn_error.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_error.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_error.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_error.h Thu Jun  6 17:24:20 2013
@@ -439,7 +439,7 @@ svn_error_t *svn_error_purge_tracing(svn
    err->apr_err == SVN_ERR_RA_NOT_LOCKED ||                 \
    err->apr_err == SVN_ERR_FS_LOCK_EXPIRED)
 
-/** Evaluates to @c TRUE iff @a apr_err (of type #apr_status_t) is in the given
+/** Evaluates to @c TRUE iff @a apr_err (of type apr_status_t) is in the given
  * @a category, which should be one of the @c SVN_ERR_*_CATEGORY_START
  * constants.
  *

Modified: subversion/branches/1.8.x/subversion/include/svn_repos.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_repos.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_repos.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_repos.h Thu Jun  6 17:24:20 2013
@@ -69,8 +69,11 @@ enum svn_node_action
 /** The different policies for processing the UUID in the dumpfile. */
 enum svn_repos_load_uuid
 {
+  /** only update uuid if the repos has no revisions. */
   svn_repos_load_uuid_default,
+  /** never update uuid. */
   svn_repos_load_uuid_ignore,
+  /** always update uuid. */
   svn_repos_load_uuid_force
 };
 
@@ -3309,8 +3312,14 @@ svn_repos_authz_check_access(svn_authz_t
  */
 typedef enum svn_repos_revision_access_level_t
 {
+  /** no access allowed to the revision properties and all changed-paths
+   * information. */ 
   svn_repos_revision_access_none,
+  /** access granted to some (svn:date and svn:author) revision properties and
+   * changed-paths information on paths the read has access to. */
   svn_repos_revision_access_partial,
+  /** access granted to all revision properites and changed-paths
+   * information. */
   svn_repos_revision_access_full
 }
 svn_repos_revision_access_level_t;

Modified: subversion/branches/1.8.x/subversion/include/svn_types.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_types.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_types.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_types.h Thu Jun  6 17:24:20 2013
@@ -276,8 +276,11 @@ svn_node_kind_from_word(const char *word
  * @since New in 1.7. */
 typedef enum svn_tristate_t
 {
+  /** state known to be false (the constant does not evaulate to false) */
   svn_tristate_false = 2,
+  /** state known to be true */
   svn_tristate_true,
+  /** state could be true or false */
   svn_tristate_unknown
 } svn_tristate_t;
 

Modified: subversion/branches/1.8.x/subversion/include/svn_wc.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_wc.h?rev=1490367&r1=1490366&r2=1490367&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_wc.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_wc.h Thu Jun  6 17:24:20 2013
@@ -8132,17 +8132,17 @@ svn_wc_exclude(svn_wc_context_t *wc_ctx,
  *
  * If @a show_hidden and @a show_deleted are both @c FALSE, the kind of
  * scheduled for delete, administrative only 'not present' and excluded
- * nodes is reported as #svn_node_kind_node. This is recommended as a check
+ * nodes is reported as #svn_node_none. This is recommended as a check
  * for 'is there a versioned file or directory here?'
  *
  * If @a show_deleted is FALSE, but @a show_hidden is @c TRUE then only
  * scheduled for delete and administrative only 'not present' nodes are
- * reported as #svn_node_kind_none. This is recommended as check for
+ * reported as #svn_node_none. This is recommended as check for
  * 'Can I add a node here?'
  *
  * If @a show_deleted is TRUE, but @a show_hidden is FALSE, then only
  * administrative only 'not present' nodes and excluded nodes are reported as
- * #svn_node_kind_none. This behavior is the behavior bescribed as 'hidden'
+ * #svn_node_none. This behavior is the behavior bescribed as 'hidden'
  * before Subversion 1.7.
  *
  * If @a show_hidden and @a show_deleted are both @c TRUE all nodes are