Git::Raw::Worktree(3pm)

Git::Raw::Worktree3pm

Git worktree class

Version

version 0.90

Overview

A Git::Raw::Worktree represents a git worktree.

WARNING: The API of this module is unstable and may change without warning (any change will be appropriately documented in the changelog).

Methods

add( $repo, $name, $path )

Add a new worktree.

lookup( $repo, $name )

Lookup a worktree.

name( )

Retrieve the name of the worktree.

path( )

Retrieve the filesystem path for the worktree.

repository( )

Open the worktree as a repository. Returns a Git::Raw::Repository object.

list( $repo )

List all worktress for $repo.

is_locked( )

Check if the worktree is locked. Returns the reason for locking or a falsy value.

is_prunable( \%prune_opts )

Check if the worktree can be pruned. Valid fields for th %prune_opts hash are:

•

"flags"

Prune flags. Valid values include:

•

"valid"

Prune the working tree even if working tree is valid.

•

"locked"

Prune the working tree even if it is locked.

•

"working_tree"

Prune checked out working tree.

lock( $reason )

Lock the worktree with $reason.

unlock( )

Unlock the worktree.

validate( )

Check if the worktree is valid. A valid worktree requirest both the git data structures inside the linked parent repository and the linked working copy to be present.

prune( \%prune_opts )

Prune the working tree. Pruning the working tree removes the git data structures on disk. See "is_prunable" for valid values of %prune_opts.

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

Author

Jacques Germishuys <[email protected]>

From libgit-raw-perl 0.90+ds-3+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.