working copy status.

We have two functions for getting working copy status: one function for getting the status of exactly one thing, and another for getting the statuses of (potentially) multiple things. More...

Data Structures

struct  svn_wc_status2_t
 Structure for holding the "status" of a working copy item. More...
struct  svn_wc_status_t
 Same as svn_wc_status2_t, but without the svn_lock_t 'repos_lock' field. More...

Typedefs

typedef void(*) svn_wc_status_func2_t (void *baton, const char *path, svn_wc_status2_t *status)
 A callback for reporting a status about path.
typedef void(*) svn_wc_status_func_t (void *baton, const char *path, svn_wc_status_t *status)
 Same as svn_wc_status_func2_t(), but for older svn_wc_status_t structures.

Enumerations

enum  svn_wc_status_kind {
  svn_wc_status_none = 1,
  svn_wc_status_unversioned,
  svn_wc_status_normal,
  svn_wc_status_added,
  svn_wc_status_missing,
  svn_wc_status_deleted,
  svn_wc_status_replaced,
  svn_wc_status_modified,
  svn_wc_status_merged,
  svn_wc_status_conflicted,
  svn_wc_status_ignored,
  svn_wc_status_obstructed,
  svn_wc_status_external,
  svn_wc_status_incomplete
}

Functions

svn_wc_status2_tsvn_wc_dup_status2 (svn_wc_status2_t *orig_stat, apr_pool_t *pool)
 Return a deep copy of the orig_stat status structure, allocated in pool.
svn_wc_status_tsvn_wc_dup_status (svn_wc_status_t *orig_stat, apr_pool_t *pool)
 Same as svn_wc_dup_status2(), but for older svn_wc_status_t structures.
svn_error_tsvn_wc_status2 (svn_wc_status2_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
 Fill *status for path, allocating in pool.
svn_error_tsvn_wc_status (svn_wc_status_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
 Same as svn_wc_status2(), but for older svn_wc_status_t structures.
svn_error_tsvn_wc_get_status_editor2 (const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func2_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
 Set *editor and *edit_baton to an editor that generates svn_wc_status2_t structures and sends them through status_func / status_baton.
svn_error_tsvn_wc_get_status_editor (const svn_delta_editor_t **editor, void **edit_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
 Same as svn_wc_get_status_editor2(), but with set_locks_baton set to NULL, and taking a deprecated svn_wc_status_func_t argument.
svn_error_tsvn_wc_status_set_repos_locks (void *set_locks_baton, apr_hash_t *locks, const char *repos_root, apr_pool_t *pool)
 Associate locks, a hash table mapping const char* absolute repository paths to svn_lock_t objects, with a set_locks_baton returned by an earlier call to svn_wc_get_status_editor2().

Detailed Description

We have two functions for getting working copy status: one function for getting the status of exactly one thing, and another for getting the statuses of (potentially) multiple things.

The WebDAV concept of "depth" may be useful in understanding the motivation behind this. Suppose we're getting the status of directory D. The three depth levels would mean

depth 0: D itself (just the named directory) depth 1: D and its immediate children (D + its entries) depth Infinity: D and all its descendants (full recursion)

To offer all three levels, we could have one unified function, taking a `depth' parameter. Unfortunately, because this function would have to handle multiple return values as well as the single return value case, getting the status of just one entity would become cumbersome: you'd have to roll through a hash to fhe tbridge one day...

Definition at line 358 of file svn_ra.h.

svn_ra_progress_notify_func_t svn_ra_callbacks2_t::progress_func

Notification callback used for progress information.

May be NULL if not used.

Definition at line 372 of file svn_ra.h.


The documentation for this struct was generated from the following file:
Generated on Thu Aug 6 17:28:25 2009 for Subversion by  doxygen 1.5.1
./usr/share/doc/libsvn1/html/group__svn__wc__status.html0000644000000000000000000012722111236611271022361 0ustar rootroot Subversion: working copy status.

working copy status.

We have two functions for getting working copy status: one function for getting the status of exactly one thing, and another for getting the statuses of (potentially) multiple things. More...

Data Structures

struct  svn_wc_status2_t
 Structure for holding the "status" of a working copy item. More...
struct  svn_wc_status_t
 Same as svn_wc_status2_t, but without the svn_lock_t 'repos_lock' field. More...

Typedefs

typedef void(*) svn_wc_status_func2_t (void *baton, const char *path, svn_wc_status2_t *status)
 A callback for reporting a status about path.
typedef void(*) svn_wc_status_func_t (void *baton, const char *path, svn_wc_status_t *status)
 Same as svn_wc_status_func2_t(), but for older svn_wc_status_t structures.

Enumerations

enum  svn_wc_status_kind {
  svn_wc_status_none = 1,
  svn_wc_status_unversioned,
  svn_wc_status_normal,
  svn_wc_status_added,
  svn_wc_status_missing,
  svn_wc_status_deleted,
  svn_wc_status_replaced,
  svn_wc_status_modified,
  svn_wc_status_merged,
  svn_wc_status_conflicted,
  svn_wc_status_ignored,
  svn_wc_status_obstructed,
  svn_wc_status_external,
  svn_wc_status_incomplete
}

Functions

svn_wc_status2_tsvn_wc_dup_status2 (svn_wc_status2_t *orig_stat, apr_pool_t *pool)
 Return a deep copy of the orig_stat status structure, allocated in pool.
svn_wc_status_tsvn_wc_dup_status (svn_wc_status_t *orig_stat, apr_pool_t *pool)
 Same as svn_wc_dup_status2(), but for older svn_wc_status_t structures.
svn_error_tsvn_wc_status2 (svn_wc_status2_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
 Fill *status for path, allocating in pool.
svn_error_tsvn_wc_status (svn_wc_status_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
 Same as svn_wc_status2(), but for older svn_wc_status_t structures.
svn_error_tsvn_wc_get_status_editor2 (const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func2_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
 Set *editor and *edit_baton to an editor that generates svn_wc_status2_t structures and sends them through status_func / status_baton.
svn_error_tsvn_wc_get_status_editor (const svn_delta_editor_t **editor, void **edit_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
 Same as svn_wc_get_status_editor2(), but with set_locks_baton set to NULL, and taking a deprecated svn_wc_status_func_t argument.
svn_error_tsvn_wc_status_set_repos_locks (void *set_locks_baton, apr_hash_t *locks, const char *repos_root, apr_pool_t *pool)
 Associate locks, a hash table mapping const char* absolute repository paths to svn_lock_t objects, with a set_locks_baton returned by an earlier call to svn_wc_get_status_editor2().

Detailed Description

We have two functions for getting working copy status: one function for getting the status of exactly one thing, and another for getting the statuses of (potentially) multiple things.

The WebDAV concept of "depth" may be useful in understanding the motivation behind this. Suppose we're getting the status of directory D. The three depth levels would mean

depth 0: D itself (just the named directory) depth 1: D and its immediate children (D + its entries) depth Infinity: D and all its descendants (full recursion)

To offer all three levels, we could have one unified function, taking a `depth' parameter. Unfortunately, because this function would have to handle multiple return values as well as the single return value case, getting the status of just one entity would become cumbersome: you'd have to roll through a hash to fhe tbridge one day...

Definition at line 358 of file svn_ra.h.

svn_ra_progress_notify_func_t svn_ra_callbacks2_t::progress_func

Notification callback used for progress information.

May be NULL if not used.

Definition at line 372 of file svn_ra.h.


The documentation for this struct was generated from the following file:
Generated on Thu Aug 6 17:28:25 2009 for Subversion by  doxygen 1.5.1
./usr/share/doc/libsvn1/html/group__svn__wc__status.html0000644000000000000000000012722111236611271022361 0ustar rootroot Subversion: working copy status.

working copy status.

We have two functions for getting working copy status: one function for getting the status of exactly one thing, and another for getting the statuses of (potentially) multiple things. More...

Data Structures

struct  svn_wc_status2_t
 Structure for holding the "status" of a working copy item. More...
struct  svn_wc_status_t
 Same as svn_wc_status2_t, but without the svn_lock_t 'repos_lock' field. More...

Typedefs

typedef void(*) svn_wc_status_func2_t (void *baton, const char *path, svn_wc_status2_t *status)
 A callback for reporting a status about path.
typedef void(*) svn_wc_status_func_t (void *baton, const char *path, svn_wc_status_t *status)
 Same as svn_wc_status_func2_t(), but for older svn_wc_status_t structures.

Enumerations

enum  svn_wc_status_kind {
  svn_wc_status_none = 1,
  svn_wc_status_unversioned,
  svn_wc_status_normal,
  svn_wc_status_added,
  svn_wc_status_missing,
  svn_wc_status_deleted,
  svn_wc_status_replaced,
  svn_wc_status_modified,
  svn_wc_status_merged,
  svn_wc_status_conflicted,
  svn_wc_status_ignored,
  svn_wc_status_obstructed,
  svn_wc_status_external,
  svn_wc_status_incomplete
}

Functions

svn_wc_status2_tsvn_wc_dup_status2 (svn_wc_status2_t *orig_stat, apr_pool_t *pool)
 Return a deep copy of the orig_stat status structure, allocated in pool.
svn_wc_status_tsvn_wc_dup_status (svn_wc_status_t *orig_stat, apr_pool_t *pool)
 Same as svn_wc_dup_status2(), but for older svn_wc_status_t structures.
svn_error_tsvn_wc_status2 (svn_wc_status2_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
 Fill *status for path, allocating in pool.
svn_error_tsvn_wc_status (svn_wc_status_t **status, const char *path, svn_wc_adm_access_t *adm_access, apr_pool_t *pool)
 Same as svn_wc_status2(), but for older svn_wc_status_t structures.
svn_error_tsvn_wc_get_status_editor2 (const svn_delta_editor_t **editor, void **edit_baton, void **set_locks_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func2_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton, svn_wc_traversal_info_t *traversal_info, apr_pool_t *pool)
 Set *editor and *edit_baton to an editor that generates svn_wc_status2_t structures and sends them through status_func / status_baton.
svn_error_tsvn_wc_get_status_editor (const svn_delta_editor_t **editor, void **edit_baton, svn_revnum_t *edit_revision, svn_wc_adm_access_t *anchor, const char *target, apr_hash_t *config, svn_boolean_t recurse, svn_boolean_t get_all, svn_boolean_t no_ignore, svn_wc_status_func_t status_func, void *status_baton, svn_cancel_func_t cancel_func, void *cancel_baton,