Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Line ¶
type Line struct {
Text string
Version VersionInfo
BelowHorizon bool
}
Line represents an annotated line of a file, with the text and the version that last changed it.
BelowHorizon marks a line whose origin lies at or below the structural horizon of the store (draft-fossil-horizon-00 §5.5): the walk reached a parent the store does not hold because it lies below the horizon, so the line is reported as originating at the horizon, and Version is the horizon's check-in rather than the line's origin.
type Options ¶
type Options struct {
FilePath string // pathname of the file to annotate
StartRID libfossil.FslID // checkin to start from (tip)
Limit int // max ancestors to walk (0 = unlimited)
OriginRID libfossil.FslID // stop at this checkin (0 = none)
// Cache, when set, serves the walk in place of the one Annotate makes
// for itself, so a caller's longer-lived cache carries over between
// calls. The caller keeps its entries current.
Cache *content.Cache
// Fetch, when set, is asked for the payloads of a version the walk
// reads below a content horizon and the store does not hold, a version
// at a time, so that only what the walk reads is fetched
// (draft-fossil-horizon-00 §4.4). At most FetchLimit names are asked
// for; past that, or with no Fetch, the walk stops at the horizon.
Fetch func(ctx context.Context, names []string) error
FetchLimit int
}
Options controls the annotate operation.
Click to show internal directories.
Click to hide internal directories.