Client commit subsystem
[Client supporting subsystem]

Commit operations. More...

Data Structures

struct  svn_client_proplist_item_t
 This is a structure which stores a filename and a hash of property names and values. More...
struct  svn_client_commit_info_t
 Information about commits passed back to client from this module. More...
struct  svn_client_commit_item3_t
 The commit candidate structure. More...
struct  svn_client_commit_item2_t
 The commit candidate structure. More...
struct  svn_client_commit_item_t
 The commit candidate structure. More...

Typedefs

typedef svn_error_t *(*) svn_proplist_receiver_t (void *baton, const char *path, apr_hash_t *prop_hash, apr_pool_t *pool)
 The callback invoked by svn_client_proplist3().
typedef svn_error_t *(*) svn_client_get_commit_log3_t (const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)
 Callback type used by commit-y operations to get a commit log message from the caller.
typedef svn_error_t *(*) svn_client_get_commit_log2_t (const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)
 Callback type used by commit-y operations to get a commit log message from the caller.
typedef svn_error_t *(*) svn_client_get_commit_log_t (const char **log_msg, const char **tmp_file, apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)
 Callback type used by commit-y operations to get a commit log message from the caller.

Functions

svn_client_proplist_item_tsvn_client_proplist_item_dup (const svn_client_proplist_item_t *item, apr_pool_t *pool)
 Return a duplicate of item, allocated in pool.
svn_error_tsvn_client_commit_item_create (const svn_client_commit_item3_t **item, apr_pool_t *pool)
 Initialize a commit item.
svn_client_commit_item3_tsvn_client_commit_item3_dup (const svn_client_commit_item3_t *item, apr_pool_t *pool)
 Return a duplicate of item, allocated in pool.
svn_client_commit_item2_tsvn_client_commit_item2_dup (const svn_client_commit_item2_t *item, apr_pool_t *pool)
 Return a duplicate of item, allocated in pool.

Detailed Description

Commit operations.


Typedef Documentation

typedef svn_error_t*(*) svn_client_get_commit_log2_t(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)

Callback type used by commit-y operations to get a commit log message from the caller.

Set *log_msg to the log message for the commit, allocated in pool, or NULL if wish to abort the commit process. Set *tmp_file to the path of any temporary file which might be holding that log message, or NULL if no such file exists (though, if *log_msg is NULL, this value is undefined). The log message MUST be a UTF8 string with LF line separators.

commit_items is a read-only array of svn_client_commit_item2_t structures, which may be fully or only partially filled-in, depending on the type of commit operation.

baton is provided along with the callback for use by the handler.

All allocations should be performed in pool.

Deprecated:
Provided for backward compatibility with the 1.3 API.

Definition at line 587 of file svn_client.h.

typedef svn_error_t*(*) svn_client_get_commit_log3_t(const char **log_msg, const char **tmp_file, const apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)

Callback type used by commit-y operations to get a commit log message from the caller.

Set *log_msg to the log message for the commit, allocated in pool, or NULL if wish to abort the commit process. Set *tmp_file to the path of any temporary file which might be holding that log message, or NULL if no such file exists (though, if *log_msg is NULL, this value is undefined). The log message MUST be a UTF8 string with LF line separators.

commit_items is a read-only array of svn_client_commit_item3_t structures, which may be fully or only partially filled-in, depending on the type of commit operation.

baton is provided along with the callback for use by the handler.

All allocations should be performed in pool.

Since:
New in 1.5.

Definition at line 560 of file svn_client.h.

typedef svn_error_t*(*) svn_client_get_commit_log_t(const char **log_msg, const char **tmp_file, apr_array_header_t *commit_items, void *baton, apr_pool_t *pool)

Callback type used by commit-y operations to get a commit log message from the caller.

Set *log_msg to the log message for the commit, allocated in pool, or NULL if wish to abort the commit process. Set *tmp_file to the path of any temporary file which might be holding that log message, or NULL if no such file exists (though, if *log_msg is NULL, this value is undefined). The log message MUST be a UTF8 string with LF line separators.

commit_items is a read-only array of svn_client_commit_item_t structures, which may be fully or only partially filled-in, depending on the type of commit operation.

baton is provided along with the callback for use by the handler.

All allocations should be performed in pool.

Deprecated:
Provided for backward compatibility with the 1.2 API.

Definition at line 614 of file svn_client.h.

typedef svn_error_t*(*) svn_proplist_receiver_t(void *baton, const char *path, apr_hash_t *prop_hash, apr_pool_t *pool)

The callback invoked by svn_client_proplist3().

Each invocation describes the property specified by item. Use pool for all temporary allocation.

Since:
New in 1.5.

Definition at line 330 of file svn_client.h.


Function Documentation

svn_client_commit_item2_t* svn_client_commit_item2_dup ( const svn_client_commit_item2_t item,
apr_pool_t *  pool 
)

Return a duplicate of item, allocated in pool.

No part of the new structure will be shared with item.

Deprecated:
Provided for backward compatibility with the 1.3 API.

svn_client_commit_item3_t* svn_client_commit_item3_dup ( const svn_client_commit_item3_t item,
apr_pool_t *  pool 
)

Return a duplicate of item, allocated in pool.

No part of the new structure will be shared with item.

Since:
New in 1.5.

svn_error_t* svn_client_commit_item_create ( const svn_client_commit_item3_t **  item,
apr_pool_t *  pool 
)

Initialize a commit item.

Set *item to a commit item object, allocated in pool.

In order to avoid backwards compatibility problems, this function is used to intialize and allocate the svn_client_commit_item3_t structure rather than doing so explicitly, as the size of this structure may change in the future.

The current implementation never returns error, but callers should still check for error, for compatibility with future versions.

Since:
New in 1.5.

svn_client_proplist_item_t* svn_client_proplist_item_dup ( const svn_client_proplist_item_t item,
apr_pool_t *  pool 
)

Return a duplicate of item, allocated in pool.

No part of the new structure will be shared with item.

Since:
New in 1.3.
Deprecated:
Provided for backward compatibility with the 1.4 API.


Generated on Thu Dec 11 18:28:17 2008 for Subversion by  doxygen 1.5.1