Client Shelving Functions
[Client working copy management]

Shelving commands. More...

Data Structures
struct	svn_client_shelved_patch_info_t
	Information about a shelved patch. More...
Functions
SVN_EXPERIMENTAL svn_error_t *	svn_client_shelve (const char *name, const apr_array_header_t *paths, svn_depth_t depth, const apr_array_header_t *changelists, svn_boolean_t keep_local, svn_boolean_t dry_run, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Shelve a change.
SVN_EXPERIMENTAL svn_error_t *	svn_client_unshelve (const char *name, const char *local_abspath, svn_boolean_t keep, svn_boolean_t dry_run, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Unshelve the shelved change name.
SVN_EXPERIMENTAL svn_error_t *	svn_client_shelves_delete (const char *name, const char *local_abspath, svn_boolean_t dry_run, svn_client_ctx_t *ctx, apr_pool_t *pool)
	Delete the shelved patch name.
SVN_EXPERIMENTAL svn_error_t *	svn_client_shelves_list (apr_hash_t **shelved_patch_infos, const char *local_abspath, svn_client_ctx_t *ctx, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
	Set *shelved_patch_infos to a hash, keyed by patch name, of pointers to svn_client_shelved_patch_info_t structures.
SVN_EXPERIMENTAL svn_error_t *	svn_client_shelves_any (svn_boolean_t *any_shelved, const char *local_abspath, svn_client_ctx_t *ctx, apr_pool_t *scratch_pool)
	Set *any_shelved to indicate if there are any shelved changes in this WC.
SVN_EXPERIMENTAL svn_error_t *	svn_client_shelf_get_paths (apr_hash_t **affected_paths, const char *name, const char *local_abspath, svn_client_ctx_t *ctx, apr_pool_t *result_pool, apr_pool_t *scratch_pool)
	Set *affected_paths to a hash with one entry for each path affected by the shelf name.
SVN_EXPERIMENTAL svn_error_t *	svn_client_shelf_has_changes (svn_boolean_t *has_changes, const char *name, const char *local_abspath, svn_client_ctx_t *ctx, apr_pool_t *scratch_pool)
	Set *has_changes to indicate whether the shelf name contains any modifications, in other words if svn_client_shelf_get_paths() would return a non-empty set of paths.

---

Detailed Description

Shelving commands.

---

Function Documentation

SVN_EXPERIMENTAL svn_error_t* svn_client_shelf_get_paths	(	apr_hash_t **	affected_paths,
		const char *	name,
		const char *	local_abspath,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	result_pool,
		apr_pool_t *	scratch_pool
	)

Set *affected_paths to a hash with one entry for each path affected by the shelf name.

The hash key is the old path and value is the new path, both relative to the WC root. The key and value are the same except when a path is moved or copied.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.

SVN_EXPERIMENTAL svn_error_t* svn_client_shelf_has_changes	(	svn_boolean_t *	has_changes,
		const char *	name,
		const char *	local_abspath,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	scratch_pool
	)

Set *has_changes to indicate whether the shelf name contains any modifications, in other words if svn_client_shelf_get_paths() would return a non-empty set of paths.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.

SVN_EXPERIMENTAL svn_error_t* svn_client_shelve	(	const char *	name,
		const apr_array_header_t *	paths,
		svn_depth_t	depth,
		const apr_array_header_t *	changelists,
		svn_boolean_t	keep_local,
		svn_boolean_t	dry_run,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Shelve a change.

Shelve as name the local modifications found by paths, depth, changelists. Revert the shelved change from the WC unless keep_local is true.

If dry_run is true, don't actually do it.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.

SVN_EXPERIMENTAL svn_error_t* svn_client_shelves_any	(	svn_boolean_t *	any_shelved,
		const char *	local_abspath,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	scratch_pool
	)

Set *any_shelved to indicate if there are any shelved changes in this WC.

This shall provide the answer fast, regardless of how many changes are stored, unlike svn_client_shelves_list().

### Initial implementation isn't O(1) fast -- it just calls svn_client_shelves_list().

local_abspath is any path in the WC and is used to find the WC root.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.

SVN_EXPERIMENTAL svn_error_t* svn_client_shelves_delete	(	const char *	name,
		const char *	local_abspath,
		svn_boolean_t	dry_run,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Delete the shelved patch name.

local_abspath is any path in the WC and is used to find the WC root.

If dry_run is true, don't actually do it.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.

SVN_EXPERIMENTAL svn_error_t* svn_client_shelves_list	(	apr_hash_t **	shelved_patch_infos,
		const char *	local_abspath,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	result_pool,
		apr_pool_t *	scratch_pool
	)

Set *shelved_patch_infos to a hash, keyed by patch name, of pointers to svn_client_shelved_patch_info_t structures.

local_abspath is any path in the WC and is used to find the WC root.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.

SVN_EXPERIMENTAL svn_error_t* svn_client_unshelve	(	const char *	name,
		const char *	local_abspath,
		svn_boolean_t	keep,
		svn_boolean_t	dry_run,
		svn_client_ctx_t *	ctx,
		apr_pool_t *	pool
	)

Unshelve the shelved change name.

local_abspath is any path in the WC and is used to find the WC root. Rename the shelved patch to add a '.bak' extension unless keep is true.

If dry_run is true, don't actually do it.

Since:

New in 1.10.

Warning:

EXPERIMENTAL.