libfossil
fsl_repo_open_ckout_opt Struct Reference

Under construction. More...

#include "checkout.h"

Collaboration diagram for fsl_repo_open_ckout_opt:

Data Fields

bool checkForOpenedCkout
 If true, the checkout-open process will look for an opened checkout in the target directory and its parents (recursively) and fail with FSL_RC_ALREADY_EXISTS if one is found.
char const * ckoutDbFile
 The filename, with no directory components, of the desired checkout db name.
bool dbOverwritePolicy
 fsl_repo_open_ckout() installs the fossil checkout schema.
fsl_file_overwrite_policy_e fileOverwritePolicy
 Policy for how to handle overwrites of files extracted from a newly-opened checkout.
char const * targetDir
 Name of the target directory, which must already exist.

Detailed Description

Under construction.

Work in progress...

Options for "opening" a fossil repository database. That is, creating a new fossil checkout database and populating its schema, without checking out any files. (That latter part is up for reconsideration and this API might change in the future to check out files after creating/opening the db.)

Definition at line 1472 of file checkout.h.

Field Documentation

◆ checkForOpenedCkout

bool fsl_repo_open_ckout_opt::checkForOpenedCkout

If true, the checkout-open process will look for an opened checkout in the target directory and its parents (recursively) and fail with FSL_RC_ALREADY_EXISTS if one is found.

Definition at line 1514 of file checkout.h.

◆ ckoutDbFile

char const* fsl_repo_open_ckout_opt::ckoutDbFile

The filename, with no directory components, of the desired checkout db name.

For the time being, always leave this NULL and let the library decide. It "might" (but probably won't) be interesting at some point to allow the client to specify a different name (noting that that would be directly incompatible with fossil(1)).

Definition at line 1490 of file checkout.h.

◆ dbOverwritePolicy

bool fsl_repo_open_ckout_opt::dbOverwritePolicy

fsl_repo_open_ckout() installs the fossil checkout schema.

If this is true it will forcibly replace any existing relevant schema components in the checkout db, otherwise it will fail when it tries to overwrite an existing schema and cannot.

Definition at line 1507 of file checkout.h.

◆ fileOverwritePolicy

fsl_file_overwrite_policy_e fsl_repo_open_ckout_opt::fileOverwritePolicy

Policy for how to handle overwrites of files extracted from a newly-opened checkout.

Potential TODO: replace this with a fsl_confirmer, though that currently seems like overkill for this particular case.

Definition at line 1499 of file checkout.h.

◆ targetDir

char const* fsl_repo_open_ckout_opt::targetDir

Name of the target directory, which must already exist.

May be relative, e.g. ".". The repo-open operation will chdir to this directory for the duration of the operation. May be NULL, in which case the current directory is assumed and no chdir is performed.

Definition at line 1480 of file checkout.h.


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