add some docco from John Vasta

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@87000 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/modules/dav/main/mod_dav.h b/modules/dav/main/mod_dav.h
index e7385c9e86bf467ed3a8515ca9aec8782020c537..33a4bd1f11c8eae4da54238f761e43ae14cfd6f8 100644 (file)
--- a/modules/dav/main/mod_dav.h
+++ b/modules/dav/main/mod_dav.h
@@ -301,11 +301,71 @@ typedef enum {
 */
 typedef struct dav_resource_private dav_resource_private;
 
-/* Resource descriptor, generated by a repository provider.
- * Note: the lock-null state is not explicitly represented here,
- * since it may be expensive to compute. Use dav_get_resource_state()
- * to determine whether a non-existent resource is a lock-null resource.
- */
+/*
+** Resource descriptor, generated by a repository provider.
+**
+** Note: the lock-null state is not explicitly represented here,
+** since it may be expensive to compute. Use dav_get_resource_state()
+** to determine whether a non-existent resource is a lock-null resource.
+**
+** A quick explanation of how the flags can apply to different resources:
+**
+** unversioned file or collection:
+**     type       = DAV_RESOURCE_TYPE_REGULAR
+**     exists     = ? (1 if exists)
+**     collection = ? (1 if collection)
+**     versioned  = 0
+**     baselined  = 0
+**     working    = 0
+**
+** version/baseline selector:
+**     type       = DAV_RESOURCE_TYPE_REGULAR
+**     exists     = 1
+**     collection = ? (1 if collection)
+**     versioned  = 1
+**     baselined  = ? (1 if baseline selector)
+**     working    = ? (1 if checked out)
+**
+** version/baseline history:
+**     type       = DAV_RESOURCE_TYPE_HISTORY
+**     exists     = 1
+**     collection = 0
+**     versioned  = 0
+**     baselined  = 0
+**     working    = 0
+**
+** version/baseline:
+**     type       = DAV_RESOURCE_TYPE_VERSION
+**     exists     = 1
+**     collection = ? (1 if collection)
+**     versioned  = 1
+**     baselined  = ? (1 if baseline)
+**     working    = 0
+**
+** working resource:
+**     type       = DAV_RESOURCE_TYPE_WORKING
+**     exists     = 1
+**     collection = ? (1 if collection)
+**     versioned  = 1
+**     baselined  = 0
+**     working    = 1
+**
+** workspace:
+**     type       = DAV_RESOURCE_TYPE_WORKSPACE
+**     exists     = ? (1 if exists)
+**     collection = 1
+**     versioned  = * (jvasta: I'm seeking clarification on whether a
+**     baselined  = *  workspace can be versioned or baselined)
+**     working    = *
+**
+** activity:
+**     type       = DAV_RESOURCE_TYPE_ACTIVITY
+**     exists     = ? (1 if exists)
+**     collection = 0
+**     versioned  = 0
+**     baselined  = 0
+**     working    = 0
+*/
 typedef struct dav_resource {
     dav_resource_type type;
 
@@ -329,7 +389,7 @@ typedef struct dav_resource {
 
     const char *uri;   /* the URI for this resource */
 
-    dav_resource_private *info;         /* repository provider's private info */
+    dav_resource_private *info;         /* the provider's private info */
 
     const dav_hooks_repository *hooks; /* hooks used for this resource */