8d/e9c26a6e85f7c1d380a9d1bd3929cf07fb853c

   1 Return-Path: <amdragon@mit.edu>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 12056429E30\r
   6         for <notmuch@notmuchmail.org>; Sat, 14 Jan 2012 10:08:59 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id w7MXGue5u+q7 for <notmuch@notmuchmail.org>;\r
  16         Sat, 14 Jan 2012 10:08:58 -0800 (PST)\r
  17 Received: from dmz-mailsec-scanner-5.mit.edu (DMZ-MAILSEC-SCANNER-5.MIT.EDU\r
  18         [18.7.68.34])\r
  19         by olra.theworths.org (Postfix) with ESMTP id 60A82429E29\r
  20         for <notmuch@notmuchmail.org>; Sat, 14 Jan 2012 10:08:58 -0800 (PST)\r
  21 X-AuditID: 12074422-b7fd66d0000008f9-9b-4f11c4b80e59\r
  22 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  23         by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
  24         id 16.5B.02297.8B4C11F4; Sat, 14 Jan 2012 13:08:56 -0500 (EST)\r
  25 Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
  26         by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id q0EI8kaH030804; \r
  27         Sat, 14 Jan 2012 13:08:47 -0500\r
  28 Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
  29         (authenticated bits=0)\r
  30         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  31         by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q0EI8Ujk015278\r
  32         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  33         Sat, 14 Jan 2012 13:08:45 -0500 (EST)\r
  34 Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
  35         (envelope-from <amdragon@mit.edu>)\r
  36         id 1Rm81k-0001wk-3C; Sat, 14 Jan 2012 13:08:28 -0500\r
  37 Date: Sat, 14 Jan 2012 13:08:28 -0500\r
  38 From: Austin Clements <amdragon@MIT.EDU>\r
  39 To: Pieter Praet <pieter@praet.org>\r
  40 Subject: Re: [PATCH] emacs: logically group def{custom,face}s\r
  41 Message-ID: <20120114180828.GD1801@mit.edu>\r
  42 References: <87ty3ypsgp.fsf@praet.org>\r
  43         <1326531898-17356-1-git-send-email-pieter@praet.org>\r
  44 MIME-Version: 1.0\r
  45 Content-Type: text/plain; charset=us-ascii\r
  46 Content-Disposition: inline\r
  47 In-Reply-To: <1326531898-17356-1-git-send-email-pieter@praet.org>\r
  48 User-Agent: Mutt/1.5.21 (2010-09-15)\r
  49 X-Brightmail-Tracker:\r
  50  H4sIAAAAAAAAA+NgFuplleLIzCtJLcpLzFFi42IR4hRV1t1xRNDf4PAUfosbrd2MFtdvzmS2\r
  51         +P36BrMDs8ezVbeYPTr2XWb12HLoPXMAcxSXTUpqTmZZapG+XQJXRk/jO7aCY9IVV3Y5NjC+\r
  52         Fe1i5OSQEDCRuPhtKROELSZx4d56ti5GLg4hgX2MEvOuLWSHcDYwSsx8cgbKOckk8XE5SAuI\r
  53         s4RRouvgWWaQfhYBVYmdE9axgNhsAhoS2/YvZwSxRQSUJU4/+ckOYjML+ErM/fQDrF5YwFai\r
  54         bf0ksHpeAW2J5sZdYHEhgViJV7v6WCHighInZz5hgejVkrjx7yXQYg4gW1pi+T8OkDCngKPE\r
  55         +olbwMaLCqhITDm5jW0Co9AsJN2zkHTPQuhewMi8ilE2JbdKNzcxM6c4NVm3ODkxLy+1SNdU\r
  56         LzezRC81pXQTIyjU2V2UdjD+PKh0iFGAg1GJh7cwR8BfiDWxrLgy9xCjJAeTkijv+cOC/kJ8\r
  57         SfkplRmJxRnxRaU5qcWHGCU4mJVEeO8tBsrxpiRWVqUW5cOkpDlYlMR51bXe+QkJpCeWpGan\r
  58         phakFsFkZTg4lCR47YExLSRYlJqeWpGWmVOCkGbi4AQZzgM03Bikhre4IDG3ODMdIn+KUVFK\r
  59         nFcUJCEAksgozYPrhaWiV4ziQK8I80qAVPEA0xhc9yugwUxAg8tS+EAGlyQipKQaGM3XnbF9\r
  60         YlpxIcZt8qR7fu08t/qL+Uvf2Mixmj2wk1RYlxcdaPTY92rUomO3L363e3muJ8C/LGD9dhu3\r
  61         kutTy7T5LH0vPXLcl9rn5TSPY8Fd1R8qO2ecFjM95H81ySaGaYlrJceOj+m94fufztCvjLD8\r
  62         Xpk/43XRl1Obq1nnZBlGnWeddYLrtBJLcUaioRZzUXEiAPBH7UYgAwAA\r
  63 Cc: Notmuch Mail <notmuch@notmuchmail.org>\r
  64 X-BeenThere: notmuch@notmuchmail.org\r
  65 X-Mailman-Version: 2.1.13\r
  66 Precedence: list\r
  67 List-Id: "Use and development of the notmuch mail system."\r
  68         <notmuch.notmuchmail.org>\r
  69 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  70         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  71 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  72 List-Post: <mailto:notmuch@notmuchmail.org>\r
  73 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  74 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  75         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  76 X-List-Received-Date: Sat, 14 Jan 2012 18:08:59 -0000\r
  77 \r
  78 Quoth Pieter Praet on Jan 14 at 10:04 am:\r
  79 > To allow for expansion whilst keeping everything tidy and organized,\r
  80 > move all defcustom/defface variables to the following subgroups,\r
  81 > defined in notmuch-lib.el:\r
  82 > \r
  83 > - Hello\r
  84 > - Search\r
  85 > - Show\r
  86 > - Send\r
  87 > - Crypto\r
  88 > - Hooks\r
  89 > - External Commands\r
  90 > - Appearance\r
  91 > \r
  92 > As an added benefit, defcustom keyword args are now consistently\r
  93 > in order of appearance @ defcustom's docstring (OCD much?).\r
  94 \r
  95 Thanks for doing this.  I recently went into customize-group notmuch\r
  96 and was overwhelmed by the pile of options presented.\r
  97 \r
  98 > diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
  99 > index 0f856bf..f6f48e9 100644\r
 100 > --- a/emacs/notmuch-lib.el\r
 101 > +++ b/emacs/notmuch-lib.el\r
 102 > @@ -28,17 +28,58 @@\r
 103 >    "Notmuch mail reader for Emacs."\r
 104 >    :group 'mail)\r
 105 >  \r
 106 \r
 107 Group docstrings aren't generally of the form "Options concerning\r
 108 ..."; they just jump into what they concern.  E.g.,\r
 109 \r
 110 Convenience : Convenience features for faster editing.\r
 111 \r
 112 Calendar Hooks : Calendar hooks.\r
 113 \r
 114 Also, all but one of the tags you give the groups would be\r
 115 automatically derived by Emacs, so you can remove those.\r
 116 \r
 117 > +(defgroup notmuch-hello nil\r
 118 > +  "Options concerning `notmuch-hello-mode'."\r
 119 > +  :tag "Notmuch Hello"\r
 120 > +  :group 'notmuch)\r
 121 \r
 122 Perhaps "Overview of saved searches, tags, etc."\r
 123 \r
 124 > +\r
 125 > +(defgroup notmuch-search nil\r
 126 > +  "Options concerning `notmuch-search-mode'."\r
 127 > +  :tag "Notmuch Search"\r
 128 > +  :group 'notmuch)\r
 129 \r
 130 "Searching and sorting mail"?\r
 131 \r
 132 > +\r
 133 > +(defgroup notmuch-show nil\r
 134 > +  "Options concerning `notmuch-show-mode'."\r
 135 > +  :tag "Notmuch Show"\r
 136 > +  :group 'notmuch)\r
 137 \r
 138 "Showing messages and threads"?\r
 139 \r
 140 > +\r
 141 > +(defgroup notmuch-send nil\r
 142 > +  "Options concerning the sending of messages."\r
 143 > +  :tag "Notmuch Send"\r
 144 > +  :group 'notmuch)\r
 145 \r
 146 "Sending messages from Notmuch"?\r
 147 \r
 148 We should probably link to the 'message group, perhaps by adding\r
 149   :link '(custom-group-link message)\r
 150 here or maybe to the notmuch group itself.  Unfortunately, I don't\r
 151 think you can actually add a group to another group after it's been\r
 152 defined (though I could be wrong).\r
 153 \r
 154 > +\r
 155 > +(defgroup notmuch-crypto nil\r
 156 > +  "Options concerning the processing and fontification of\r
 157 > +cryptographic MIME parts in `notmuch-show-mode'."\r
 158 > +  :tag "Notmuch Crypto"\r
 159 > +  :group 'notmuch)\r
 160 \r
 161 "Processing and display of cryptographic MIME parts"?  (You also don't\r
 162 want the docstring to be too long, given how it's displayed.)\r
 163 \r
 164 > +\r
 165 > +(defgroup notmuch-hooks nil\r
 166 > +  "Run custom code on well-defined occasions."\r
 167 > +  :tag "Notmuch Hooks"\r
 168 > +  :group 'notmuch)\r
 169 > +\r
 170 > +(defgroup notmuch-external nil\r
 171 > +  "Run more custom code on different well-defined occasions."\r
 172 > +  :tag "Notmuch External Commands"\r
 173 > +  :group 'notmuch)\r
 174 \r
 175 Oof!  It's okay to be a little redundant in the docstring.  Core Emacs\r
 176 options do it.  "External commands"?\r
 177 \r
 178 > +\r
 179 > +(defgroup notmuch-appearance nil\r
 180 > +  "Options concerning how Notmuch looks."\r
 181 > +  :tag "Notmuch Appearance"\r
 182 > +  :group 'notmuch)\r
 183 \r
 184 "How Notmuch looks"?\r
 185 \r
 186 I worry that notmuch-appearance is a catch-all that most options\r
 187 arguably fit in to.  In particular, some notmuch-show options are also\r
 188 in this group and some aren't and it's not clear to me what the rule\r
 189 is.\r
 190 \r
 191 Perhaps this should be notmuch-faces and limited to just faces (and\r
 192 maybe options that aren't technically faces but that affect face\r
 193 selection)?  Then the grouping rule would be obvious, like it is for\r
 194 all of the other groups.\r