class Git::Commands::SymbolicRef::Delete

Deletes a symbolic ref via ‘git symbolic-ref –delete`

Removes the named symbolic ref. When ‘quiet: true`, exit status 1 (non-symbolic ref) does not produce an error message.

@example Delete a symbolic ref

cmd = Git::Commands::SymbolicRef::Delete.new(execution_context)
cmd.call('HEAD')

@note ‘arguments` block audited against git-scm.com/docs/git-symbolic-ref/2.53.0

@see Git::Commands::SymbolicRef

@see git-scm.com/docs/git-symbolic-ref git-symbolic-ref documentation

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/symbolic_ref/delete.rb, line 66
def call(*, **)
  super
end

Executes the git symbolic-ref –delete command

@overload call(name, **options)

@param name [String] the symbolic ref name to delete
  (e.g. `HEAD`)

@param options [Hash] command options

@option options [Boolean, nil] :quiet (nil) suppress error message
  when the name is not a symbolic ref

  Alias: :q

@return [Git::CommandLine::Result] the result of calling
  `git symbolic-ref --delete`

@raise [ArgumentError] if unsupported options are provided

@raise [ArgumentError] if the name operand is missing

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call