svn_wc_get_status_editor5

Function svn_wc_get_status_editor5 

Source
pub unsafe extern "C" fn svn_wc_get_status_editor5(
    editor: *mut *const svn_delta_editor_t,
    edit_baton: *mut *mut c_void,
    set_locks_baton: *mut *mut c_void,
    edit_revision: *mut svn_revnum_t,
    wc_ctx: *mut svn_wc_context_t,
    anchor_abspath: *const c_char,
    target_basename: *const c_char,
    depth: svn_depth_t,
    get_all: svn_boolean_t,
    no_ignore: svn_boolean_t,
    depth_as_sticky: svn_boolean_t,
    server_performs_filtering: svn_boolean_t,
    ignore_patterns: *const apr_array_header_t,
    status_func: svn_wc_status_func4_t,
    status_baton: *mut c_void,
    cancel_func: svn_cancel_func_t,
    cancel_baton: *mut c_void,
    result_pool: *mut apr_pool_t,
    scratch_pool: *mut apr_pool_t,
) -> *mut svn_error_t
Expand description

DEPRECATED – please use APIs from svn_client.h


Set @a *editor and @a *edit_baton to an editor that generates #svn_wc_status3_t structures and sends them through @a status_func / @a status_baton. @a anchor_abspath is a working copy directory directory which will be used as the root of our editor. If @a target_basename is not “”, it represents a node in the @a anchor_abspath which is the subject of the editor drive (otherwise, the @a anchor_abspath is the subject).

If @a set_locks_baton is non-@c NULL, it will be set to a baton that can be used in a call to the svn_wc_status_set_repos_locks() function.

Callers drive this editor to describe working copy out-of-dateness with respect to the repository. If this information is not available or not desired, callers should simply call the close_edit() function of the @a editor vtable.

If the editor driver calls @a editor’s set_target_revision() vtable function, then when the edit drive is completed, @a *edit_revision will contain the revision delivered via that interface.

Assuming the target is a directory, then:

  • If @a get_all is FALSE, then only locally-modified entries will be returned. If TRUE, then all entries will be returned.

  • If @a depth is #svn_depth_empty, a status structure will be returned for the target only; if #svn_depth_files, for the target and its immediate file children; if #svn_depth_immediates, for the target and its immediate children; if #svn_depth_infinity, for the target and everything underneath it, fully recursively.

    If @a depth is #svn_depth_unknown, take depths from the working copy and behave as above in each directory’s case.

    If the given @a depth is incompatible with the depth found in a working copy directory, the found depth always governs.

If @a no_ignore is set, statuses that would typically be ignored will instead be reported.

@a ignore_patterns is an array of file patterns matching unversioned files to ignore for the purposes of status reporting, or @c NULL if the default set of ignorable file patterns should be used.

If @a cancel_func is non-NULL, call it with @a cancel_baton while building the @a statushash to determine if the client has canceled the operation.

If @a depth_as_sticky is set handle @a depth like when depth_is_sticky is passed for updating. This will show excluded nodes show up as added in the repository.

If @a server_performs_filtering is TRUE, assume that the server handles the ambient depth filtering, so this doesn’t have to be handled in the editor.

Allocate the editor itself in @a result_pool, and use @a scratch_pool for temporary allocations. The editor will do its temporary allocations in a subpool of @a result_pool.

@since New in 1.7. @deprecated Provided for backward compatibility with the 1.7 API.