libfossil
fsl_merge_opt Struct Reference

UNDER CONSTRUCTION. More...

#include "checkout.h"

Collaboration diagram for fsl_merge_opt:

Data Fields

fsl_id_t baselineRid
 The version of the most recent common ancestor.
fsl_merge_f callback
 Gets called once per merge-updated file, passed a fsl_ckup_state instance with information about the merged file and related metadata.
void * callbackState
 Client-defined state for use with this->callback.
unsigned short debug
 This flag is not part of the public API and will be removed once the merge operation's development has settled down.
bool dryRun
 If true, the extraction process will "go through the motions" but will not write any files to disk.
fsl_id_t mergeRid
 The version of the repostitory to merge into the current checkout.
fsl_merge_type_e mergeType
 Specifies the merge type to perform.
bool scanForChanges
 A hint to fsl_ckout_merge() about whether it needs to scan the checkout for changes.

Detailed Description

UNDER CONSTRUCTION.

Options for use with fsl_ckout_merge().

Definition at line 2765 of file checkout.h.

Field Documentation

◆ baselineRid

fsl_id_t fsl_merge_opt::baselineRid

The version of the most recent common ancestor.

Must normally be

  1. The default is calculated automatically based on this->mergeRid and this->mergeType.

This corresponds to fossil(1)'s --baseline merge flag.

fsl_ckout_merge() will fail if this is >0 and it does not refer to a checkin version or if this->mergeType is FSL_MERGE_TYPE_CHERRYPICK.

Definition at line 2782 of file checkout.h.

◆ callback

fsl_merge_f fsl_merge_opt::callback

Gets called once per merge-updated file, passed a fsl_ckup_state instance with information about the merged file and related metadata.

May be NULL, in which case the merge process will do as much work as it can, even if that means doing certain questionable things (such as skipping updates of binary files or symlinks because it refuses to merge them). As a rule of thumb, if fossil(1) performs a given "questional" merge features without generating an error, fsl_ckout_merge() does as well. This callback gives clients a chance to decide that certain states Simply Will Not Stand and cancel the merge by returning non-0 (preferably after calling fsl_cx_err_set() on the passed-in fsl_merge_state::f object).

The callback is called after any on-disk changes are made to the file, e.g. merging, file permissions, renaming, etc. However, when this->dryRun is true, filesystem-level changes are skipped.

Definition at line 2807 of file checkout.h.

◆ callbackState

void* fsl_merge_opt::callbackState

Client-defined state for use with this->callback.

Definition at line 2811 of file checkout.h.

◆ debug

unsigned short fsl_merge_opt::debug

This flag is not part of the public API and will be removed once the merge operation's development has settled down.

Definition at line 2835 of file checkout.h.

◆ dryRun

bool fsl_merge_opt::dryRun

If true, the extraction process will "go through the motions" but will not write any files to disk.

It may still perform I/O such as stat()'ing to see, e.g., if it would have needed to overwrite a file. When in dry-run, this->callback is still called as if dry-run mode were not in effect. Thus the on-disk state may not actually reflect what the callback sees when dry-run mode is active.

Definition at line 2830 of file checkout.h.

◆ mergeRid

fsl_id_t fsl_merge_opt::mergeRid

The version of the repostitory to merge into the current checkout.

This must be the blob.rid of a checkin artifact.

Definition at line 2770 of file checkout.h.

◆ mergeType

fsl_merge_type_e fsl_merge_opt::mergeType

Specifies the merge type to perform.

Certain merge-internal logic may override this. Specifically, integrate-merges may be treated as regular merges, as documented for FSL_MERGE_TYPE_INTEGRATE.

Definition at line 2788 of file checkout.h.

◆ scanForChanges

bool fsl_merge_opt::scanForChanges

A hint to fsl_ckout_merge() about whether it needs to scan the checkout for changes.

Set this to false ONLY if the calling code calls fsl_ckout_changes_scan() (or equivalent, e.g. fsl_vfile_changes_scan()) immediately before calling fsl_ckout_merge(), as that function requires a non-stale changes scan in order to function properly.

Definition at line 2820 of file checkout.h.


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