libfossil
fsl_annotate_opt Struct Reference

Configuration for use with fsl_annotate(). More...

#include "repo.h"

Collaboration diagram for fsl_annotate_opt:

Data Fields

bool dumpVersions
 If true, annotation output will start with a list of all versions analyzed by the annotation process.
char const * filename
 The repository-root-relative NUL-terminated filename to annotate.
bool fileVersions
 Output file blob versions, instead of checkin versions.
uint32_t limitMs
 An approximate number of milliseconds of processing time to limit the annotation to.
uint32_t limitVersions
 The maximum number of versions to search through.
fsl_id_t originRid
 The origin checkin version.
fsl_annotate_step_f out
 The output channel for the resulting annotation.
void * outState
 State for passing as the first argument to this->out().
bool praise
 If true, include the name of the user for which each change is attributed (noting that merges show whoever merged the change, which may differ from the original committer, and amended user names will be used over those in the initial commit).
int16_t spacePolicy
fsl_id_t versionRid
 The checkin from which the file's version should be selected.

Detailed Description

Configuration for use with fsl_annotate().

This structure holds options for the "annotate" operation and its close cousin, "blame" a.k.a. "praise." Annotation takes a given file version and builds a line-by-line history, showing when each line was last modified. The "blame" a.k.a. "praise" option includes who* modified that line.

Definition at line 3582 of file repo.h.

Field Documentation

◆ dumpVersions

bool fsl_annotate_opt::dumpVersions

If true, annotation output will start with a list of all versions analyzed by the annotation process.

Definition at line 3649 of file repo.h.

◆ filename

char const* fsl_annotate_opt::filename

The repository-root-relative NUL-terminated filename to annotate.

Definition at line 3586 of file repo.h.

◆ fileVersions

bool fsl_annotate_opt::fileVersions

Output file blob versions, instead of checkin versions.

Definition at line 3643 of file repo.h.

◆ limitMs

uint32_t fsl_annotate_opt::limitMs

An approximate number of milliseconds of processing time to limit the annotation to.

Note that this is measured in CPU time, not "wall clock" time. This value is rough minimum approximation, and the annotation will stop at the first processing step after which this limit has been hit or surpassed.

Even with this limit in place, the annotation engine may impose a minimum number of versions to step through before it enforces this limit.

If both this and limitVersions are set to positive values, the first limit which is exceeded is applied.

Definition at line 3620 of file repo.h.

◆ limitVersions

uint32_t fsl_annotate_opt::limitVersions

The maximum number of versions to search through.

Definition at line 3604 of file repo.h.

◆ originRid

fsl_id_t fsl_annotate_opt::originRid

The origin checkin version.

A value of 0 or less means the "root of the tree."

TODO: figure out and explain the difference between versionRid and originRid.

Definition at line 3600 of file repo.h.

◆ out

fsl_annotate_step_f fsl_annotate_opt::out

The output channel for the resulting annotation.

Definition at line 3653 of file repo.h.

◆ outState

void* fsl_annotate_opt::outState

State for passing as the first argument to this->out().

Definition at line 3657 of file repo.h.

◆ praise

bool fsl_annotate_opt::praise

If true, include the name of the user for which each change is attributed (noting that merges show whoever merged the change, which may differ from the original committer, and amended user names will be used over those in the initial commit).

If false, show only version information.

This option is alternately known as "blame".

For reasons lost to history, blame/praise mode does not include line numbers. That may change in the future.

Definition at line 3639 of file repo.h.

◆ spacePolicy

int16_t fsl_annotate_opt::spacePolicy
  • 0 = do not ignore any spaces.
  • <0 = ignore trailing end-of-line spaces.
  • >1 = ignore all spaces

Definition at line 3626 of file repo.h.

◆ versionRid

fsl_id_t fsl_annotate_opt::versionRid

The checkin from which the file's version should be selected.

A value of 0 or less means the current checkout, if in a checkout, and is otherwise an error.

Definition at line 3592 of file repo.h.


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