Exception: FormulaConflictError Private

Inherits:
RuntimeError
  • Object
show all
Defined in:
exceptions.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Raised when a formula conflicts with another one.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(formula, conflicts) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:



539
540
541
542
543
 
# File 'exceptions.rb', line 539

def initialize(formula, conflicts)
  @formula = formula
  @conflicts = conflicts
  super message
end

Instance Attribute Details

#conflicts ⇒ Array<Formula::FormulaConflict> (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



536
537
538
 
# File 'exceptions.rb', line 536

def conflicts
  @conflicts
end

#formula ⇒ Formula (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



533
534
535
 
# File 'exceptions.rb', line 533

def formula
  @formula
end

Instance Method Details

#conflict_message(conflict) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



546
547
548
549
550
551
 
# File 'exceptions.rb', line 546

def conflict_message(conflict)
  message = []
  message << "  #{conflict.name}"
  message << ": because #{conflict.reason}" if conflict.reason
  message.join
end

#message ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'exceptions.rb', line 554

def message
  message = []
  message << "Cannot install #{formula.full_name} because conflicting formulae are installed."
  message.concat conflicts.map { |c| conflict_message(c) } << ""
  message << <<~EOS
    Please `brew unlink #{conflicts.map(&:name) * " "}` before continuing.

    Unlinking removes a formula's symlinks from #{HOMEBREW_PREFIX}. You can
    link the formula again after the install finishes. You can `--force` this
    install, but the build may fail or cause obscure side effects in the
    resulting software.
  EOS
  message.join("\n")
end