Class: Git::Commands::ConfigOptionSyntax::Unset Private

Inherits:
Base
  • Object
show all
Defined in:
lib/git/commands/config_option_syntax/unset.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-config/2.53.0

Remove a single config entry

Wraps git config --unset to remove the entry matching the given key name and optional value regex.

Examples:

Unset a config key

cmd = Git::Commands::ConfigOptionSyntax::Unset.new(lib)
cmd.call('user.name')

Unset a global config key

cmd = Git::Commands::ConfigOptionSyntax::Unset.new(lib)
cmd.call('user.name', global: true)

See Also:

Instance Method Summary collapse

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(name, value_regex = nil, **options) ⇒ Git::CommandLineResult

Execute the git config --unset command

Parameters:

  • name (String) —

    the config key name to unset

  • value_regex (String, nil) (defaults to: nil) —

    (nil) optional regex to match the value to remove

  • options (Hash) —

    command options

Options Hash (**options):

  • :global (Boolean, nil) — default: nil —

    remove from global config (~/.gitconfig)

  • :system (Boolean, nil) — default: nil —

    remove from system config

  • :local (Boolean, nil) — default: nil —

    remove from repository config (.git/config)

  • :worktree (Boolean, nil) — default: nil —

    remove from worktree config

  • :file (String) — default: nil —

    remove from the specified file

    Alias: :f

  • :blob (String) — default: nil —

    read from the specified blob

  • :fixed_value (Boolean, nil) — default: nil —

    treat the value regex as an exact string

Returns:

Raises:

  • (ArgumentError) —

    if unsupported options are provided

  • (Git::FailedError) —

    if git exits outside the allowed range (exit code > 5)




# File 'lib/git/commands/config_option_syntax/unset.rb', line 53