gitstatus

func CommonDirectory ¶ added in v0.8.0

func CommonDirectory(root string) (string, error)

CommonDirectory resolves root's Git common directory from the `.git` marker and `commondir` pointer the way Status does, and spawns no Git process. It refuses a `.git` marker that is a symlink and reads each pointer file with a bounded no-follow open, but it follows symlinks when it resolves the gitdir and commondir paths those pointers name. A plain clone's common directory is its `.git`.

func Executable ¶

func Executable() string

Executable returns the path to spawn for Git. It is the executable `git` names on PATH, except that Apple's xcrun shim is resolved to the Git it would execute, so each spawn runs the same binary without paying the shim again. The result is memoised per PATH and DEVELOPER_DIR value; when `git` cannot be resolved the literal name is returned so the spawn fails as it did before. After Pin, it returns the pinned path.

func Isolated ¶

func Isolated(ctx context.Context) bool

func Pin ¶ added in v0.8.0

func Pin() (string, error)

Pin resolves Git once and fixes that absolute path for the rest of the process, so a later PATH or DEVELOPER_DIR change, or a git planted earlier on PATH after start, cannot change which binary a kernel spawns. It refuses when Git does not resolve to an absolute path.

func RefusalMessage ¶ added in v0.8.1

func RefusalMessage(err error) string

RefusalMessage is the caller-facing text for a failed isolated status: the fixed refusal sentence plus the specific reason when one is known.

func RefusalReason ¶ added in v0.8.1

func RefusalReason(err error) (string, bool)

RefusalReason is the specific reason behind a failed isolated status, when one is known. It is fixed text plus at most a closed config key, a Git metadata name, or a filter driver name bounded by plainToken.

func ScratchOutside ¶

func ScratchOutside(ctx context.Context, candidate string, roots ...string) error

ScratchOutside refuses an existing, symlink-resolved candidate directory that is, or lies under, any of roots. EvalSymlinks can preserve case and Unicode aliases, so directory identity is compared throughout the bounded ancestry before any private metadata is created.

func Status ¶

func Status(ctx context.Context, root string, limit int, run Runner, arguments ...string) ([]byte, error)

Status runs only against private metadata. All failures are closed: callers must not retry status against the live Git directory.

func StatusIn ¶

func StatusIn(ctx context.Context, root, temporaryParent string, limit int, run Runner, arguments ...string) ([]byte, error)

StatusIn preserves a caller's existing scratch ownership instead of consulting ambient TMPDIR. The parent must remain outside the observed repository.

func WithIsolation ¶

func WithIsolation(ctx context.Context) context.Context

WithIsolation also confines Git's repository discovery at external consumption boundaries. Status always uses private metadata, including standalone calls.

func WithProbeReuse ¶

func WithProbeReuse(ctx context.Context) context.Context

WithProbeReuse lets a status read answer a metadata probe from an earlier successful probe in this process over the same captured bytes (proposed GPK-V0-065; opt-in, never the default). Each probe is a pure function of the private copy: `config --list` of one config file, and `ls-files --stage` plus `rev-parse --shared-index-path` of one index under one config pair, all against the same root and Git directory. Only a success is remembered, so a failure of any kind is asked again, and the status run itself is never reused. The reuse assumes one Git executable for the whole process.