libfossil
fsl_ckout_unmanage_opt Struct Reference

Options for use with fsl_ckout_unmanage(). More...

#include "checkout.h"

Collaboration diagram for fsl_ckout_unmanage_opt:

Data Fields

fsl_ckout_unmanage_f callback
 Optional predicate function which will be called after each file is made unmanaged.
void * callbackState
 State to be passed to this->callback.
char const * filename
 The file or directory name to add.
bool relativeToCwd
 Whether to evaluate this->filename as relative to the current working directory (true) or to the current checkout root (false).
bool scanForChanges
 If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.
fsl_id_bag const * vfileIds
 An alternative to assigning this->filename is to point this->vfileIds to a bag of vfile.id values.

Detailed Description

Options for use with fsl_ckout_unmanage().

Definition at line 465 of file checkout.h.

Field Documentation

◆ callback

fsl_ckout_unmanage_f fsl_ckout_unmanage_opt::callback

Optional predicate function which will be called after each file is made unmanaged.

The name it is passed is relative to the checkout root.

Definition at line 506 of file checkout.h.

◆ callbackState

void* fsl_ckout_unmanage_opt::callbackState

State to be passed to this->callback.

Definition at line 510 of file checkout.h.

◆ filename

char const* fsl_ckout_unmanage_opt::filename

The file or directory name to add.

If it is a directory, the add process will recurse into it. See also this->vfileIds.

Definition at line 470 of file checkout.h.

◆ relativeToCwd

bool fsl_ckout_unmanage_opt::relativeToCwd

Whether to evaluate this->filename as relative to the current working directory (true) or to the current checkout root (false).

This is ignored when this->vfileIds is not NULL.

This makes a subtle yet important difference in how the name is resolved. CLI apps which take file names from the user from within a checkout directory will generally want to set relativeToCwd to true. GUI apps, OTOH, will possibly need it to be false, depending on how they resolve and pass on the filenames.

Definition at line 491 of file checkout.h.

◆ scanForChanges

bool fsl_ckout_unmanage_opt::scanForChanges

If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.

If the client code has called that function, or its equivalent, since any changes were made to the checkout then this may be set to false to speed up the rm process.

Definition at line 499 of file checkout.h.

◆ vfileIds

fsl_id_bag const* fsl_ckout_unmanage_opt::vfileIds

An alternative to assigning this->filename is to point this->vfileIds to a bag of vfile.id values.

If this member is not NULL, fsl_ckout_unmanage() will ignore this->filename.

See also
fsl_filename_to_vfile_ids()

Definition at line 478 of file checkout.h.


The documentation for this struct was generated from the following file: