mutt: document patch policy

1 files changed, 30 insertions, 24 deletions

diff --git a/Library/Formula/mutt.rb b/Library/Formula/mutt.rb
index e4a8d5be2..86852ad31 100644
--- a/Library/Formula/mutt.rb
+++ b/Library/Formula/mutt.rb
@@ -1,10 +1,16 @@
-require 'formula'
-
+require "formula"
+
+# Note: Mutt has a large number of non-upstream patches available for it,
+# some of which conflict with each other. These patches are also not kept
+# up-to-date when new versions of mutt (occasionally) come out.
+# To reduce Homebrew's maintainence burden, new patches are not being
+# accepted for this formula. Mutt power-users are encouraged to copy the
+# formula and modify it locally, adding needed patches.
 class Mutt < Formula
-  homepage 'http://www.mutt.org/'
-  url 'ftp://ftp.mutt.org/mutt/mutt-1.5.23.tar.gz'
-  mirror 'http://fossies.org/linux/misc/mutt-1.5.23.tar.gz'
-  sha1 '8ac821d8b1e25504a31bf5fda9c08d93a4acc862'
+  homepage "http://www.mutt.org/"
+  url "ftp://ftp.mutt.org/mutt/mutt-1.5.23.tar.gz"
+  mirror "http://fossies.org/linux/misc/mutt-1.5.23.tar.gz"
+  sha1 "8ac821d8b1e25504a31bf5fda9c08d93a4acc862"
   revision 1
 
   bottle do
@@ -15,20 +21,20 @@ class Mutt < Formula
   end
 
   head do
-    url 'http://dev.mutt.org/hg/mutt#default', :using => :hg
+    url "http://dev.mutt.org/hg/mutt#default", :using => :hg
 
-    resource 'html' do
-      url 'http://dev.mutt.org/doc/manual.html', :using => :nounzip
+    resource "html" do
+      url "http://dev.mutt.org/doc/manual.html", :using => :nounzip
     end
   end
 
-  unless Tab.for_name('signing-party').used_options.include? 'with-rename-pgpring'
-    conflicts_with 'signing-party',
-      :because => 'mutt installs a private copy of pgpring'
+  unless Tab.for_name("signing-party").used_options.include? "with-rename-pgpring"
+    conflicts_with "signing-party",
+      :because => "mutt installs a private copy of pgpring"
   end
 
-  conflicts_with 'tin',
-    :because => 'both install mmdf.5 and mbox.5 man pages'
+  conflicts_with "tin",
+    :because => "both install mmdf.5 and mbox.5 man pages"
 
   option "with-debug", "Build with debug option enabled"
   option "with-trash-patch", "Apply trash folder patch"
@@ -37,13 +43,13 @@ class Mutt < Formula
   option "with-pgp-verbose-mime-patch", "Apply PGP verbose mime patch"
   option "with-confirm-attachment-patch", "Apply confirm attachment patch"
 
-  depends_on :autoconf
-  depends_on :automake
+  depends_on "autoconf" => :build
+  depends_on "automake" => :build
 
-  depends_on 'openssl'
-  depends_on 'tokyo-cabinet'
-  depends_on 's-lang' => :optional
-  depends_on 'gpgme' => :optional
+  depends_on "openssl"
+  depends_on "tokyo-cabinet"
+  depends_on "s-lang" => :optional
+  depends_on "gpgme" => :optional
 
   patch do
     url "ftp://ftp.openbsd.org/pub/OpenBSD/distfiles/mutt/trashfolder-1.5.22.diff0.gz"
@@ -83,10 +89,10 @@ class Mutt < Formula
             # the mutt_dotlock file (which we can't do if we're running as an
             # unpriviledged user)
             "--with-homespool=.mbox"]
-    args << "--with-slang" if build.with? 's-lang'
-    args << "--enable-gpgme" if build.with? 'gpgme'
+    args << "--with-slang" if build.with? "s-lang"
+    args << "--enable-gpgme" if build.with? "gpgme"
 
-    if build.with? 'debug'
+    if build.with? "debug"
       args << "--enable-debug"
     else
       args << "--disable-debug"
@@ -96,6 +102,6 @@ class Mutt < Formula
     system "make"
     system "make", "install"
 
-    (share/'doc/mutt').install resource('html') if build.head?
+    (share/"doc/mutt").install resource("html") if build.head?
   end
 end