libfossil
fsl_checkin_opt Struct Reference

Parameters for fsl_checkin_commit(). More...

#include "fossil-content.h"

Data Fields

char const * bgColor
 If this->branch is not NULL, this is applied as its "bgcolor" propagating property. More...
 
char const * branch
 Don't use this yet - it is not yet tested all that well. More...
 
int calcRCard
 Whether or not to calculate an R-card. More...
 
char const * closeBranch
 If this is not NULL then the committed manifest will include a tag which closes the branch. More...
 
int deltaPolicy
 Whether to allow (or try to force) a delta manifest or not. More...
 
char const * dumpManifestFile
 Tells fsl_checkin_commit() to dump the generated manifest to this file. More...
 
int integrate
 Tells the checkin to close merged-in branches (merge type of 0). More...
 
char isPrivate
 If true, the checkin will be marked as private, otherwise it will be marked as private or public, depending on whether or not it inherits private content. More...
 
fsl_double_t julianTime
 Time of the checkin. More...
 
char const * message
 The commit message. More...
 
char const * messageMimeType
 The optional mime type for the message. More...
 
char const * user
 The user name for the checkin. More...
 

Detailed Description

Parameters for fsl_checkin_commit().

Checkins are created in a multi-step process:

Note that this API uses the terms "enqueue" and "unqueue" rather than "add" and "remove" because those both have very specific (and much different) meanings in the overall SCM scheme.

Definition at line 2652 of file fossil-content.h.

Field Documentation

char const* fsl_checkin_opt::bgColor

If this->branch is not NULL, this is applied as its "bgcolor" propagating property.

If this->branch is NULL then this is applied as a one-time color tag to the checkin.

It must be NULL, empty, or in a form usable by HTML/CSS, preferably #RRGGBB form. Length-0 values are ignored (as if they were NULL).

Definition at line 2689 of file fossil-content.h.

char const* fsl_checkin_opt::branch

Don't use this yet - it is not yet tested all that well.

If not NULL, makes the checkin the start of a new branch with this name.

Definition at line 2678 of file fossil-content.h.

int fsl_checkin_opt::calcRCard

Whether or not to calculate an R-card.

Doing so is very expensive (memory and I/O) but it adds another layer of consistency checking to manifest files. In practice, the R-card is somewhat superfluous and the cost of calculating it has proven painful on very large repositories. fossil(1) creates an R-card for all checkins but does not require that one be set when it reads a manifest.

Definition at line 2707 of file fossil-content.h.

char const* fsl_checkin_opt::closeBranch

If this is not NULL then the committed manifest will include a tag which closes the branch.

The value of this string will be the value of the "closed" tag, and the value may be an empty string. The intention is that this gets set to a comment about why the branch is closed, but it is in no way mandatory.

Definition at line 2755 of file fossil-content.h.

int fsl_checkin_opt::deltaPolicy

Whether to allow (or try to force) a delta manifest or not.

0 means no deltas allowed - it will generate a baseline manifest. Greater than 0 forces generation of a delta if possible (if one can be readily found) even if doing so would not save a notable amount of space. Less than 0 means to decide via some heuristics.

A "readily available" baseline means either the current checkout is a baseline or has a baseline. In either case, we can use that as a baseline for a delta. i.e. a baseline "should" basically available except on the initial checkin, which has neither a parent checkin nor a baseline.

The current behaviour for "auto-detect" mode is: it will generate a delta if a baseline is "readily available." Once it calculates a delta form, it calculates whether that form saves any appreciable space/overhead compared to whether a baseline manifest was generated. If so, it discards the delta and re-generates the manifest as a baseline. The "force" behaviour (deltaPolicy>0) bypasses the "is it too big?" test, and is only intended for testing, not real-life use.

Definition at line 2732 of file fossil-content.h.

char const* fsl_checkin_opt::dumpManifestFile

Tells fsl_checkin_commit() to dump the generated manifest to this file.

Intended only for debugging and testing. Checking in will fail if this file cannot be opened for writing.

Definition at line 2762 of file fossil-content.h.

int fsl_checkin_opt::integrate

Tells the checkin to close merged-in branches (merge type of 0).

INTEGRATE merges (type=-4) are always closed by a checkin. This does not apply to CHERRYPICK (type=-1) and BACKOUT (type=-2) merges.

Definition at line 2740 of file fossil-content.h.

char fsl_checkin_opt::isPrivate

If true, the checkin will be marked as private, otherwise it will be marked as private or public, depending on whether or not it inherits private content.

Definition at line 2696 of file fossil-content.h.

fsl_double_t fsl_checkin_opt::julianTime

Time of the checkin.

If 0 or less, the current time is used.

Definition at line 2746 of file fossil-content.h.

char const* fsl_checkin_opt::message

The commit message.

May not be empty - the library forbids empty checkin messages.

Definition at line 2657 of file fossil-content.h.

char const* fsl_checkin_opt::messageMimeType

The optional mime type for the message.

Only set this if you know what you're doing.

Definition at line 2663 of file fossil-content.h.

char const* fsl_checkin_opt::user

The user name for the checkin.

If NULL or empty, it defaults to fsl_cx_user_get(). If that is NULL, a FSL_RC_RANGE error is triggered.

Definition at line 2670 of file fossil-content.h.


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