Class: Git::Commands::Worktree::Unlock Private

Inherits:

ManagementBase

• Object
• Base
• ManagementBase
• Git::Commands::Worktree::Unlock

Defined in:

lib/git/commands/worktree/unlock.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Note:

arguments block audited against https://git-scm.com/docs/git-worktree/2.54.0

Unlocks a worktree, allowing it to be pruned, moved, or deleted

Examples:

Unlock a worktree

Git::Commands::Worktree::Unlock.new(execution_context).call('/tmp/feature')

See Also:

• Git::Commands::Worktree for the full sub-command list
• git-worktree documentation

Instance Method Summary

• #call(worktree) ⇒ Git::CommandLineResult

  Unlock a worktree, allowing it to be pruned, moved, or deleted.

Methods inherited from Base

allow_exit_status, arguments, #initialize, requires_git_version, skip_version_validation

Constructor Details

This class inherits a constructor from Git::Commands::Base

Instance Method Details

#call(worktree) ⇒ Git::CommandLineResult

Unlock a worktree, allowing it to be pruned, moved, or deleted

Parameters:

• worktree (String) —

  path or unique suffix identifying the worktree to unlock

Returns:

• (Git::CommandLineResult) —

  the result of calling git worktree unlock

Raises:

• (Git::FailedError) —

  if git exits with a non-zero exit status

# File 'lib/git/commands/worktree/unlock.rb', line 30