c1/a34834cb7311fa4b94bf4d1a5e7c1699804845

   1 Return-Path: <cworth@cworth.org>\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 CFD44431FBC;\r
   6         Fri, 20 Nov 2009 15:25:23 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 Received: from olra.theworths.org ([127.0.0.1])\r
   9         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  10         with ESMTP id N3xSODcZdaBw; Fri, 20 Nov 2009 15:25:22 -0800 (PST)\r
  11 Received: from cworth.org (localhost [127.0.0.1])\r
  12         by olra.theworths.org (Postfix) with ESMTP id 83B5C431FAE;\r
  13         Fri, 20 Nov 2009 15:25:22 -0800 (PST)\r
  14 From: Carl Worth <cworth@cworth.org>\r
  15 To: Chris Wilson <chris@chris-wilson.co.uk>, Jan Janak <jan@ryngle.com>\r
  16 In-Reply-To: <1258729976-sup-5984@broadwater.alporthouse.com>\r
  17 References: <f35dbb950911200708m16c6fc14sfd9de097ac06a445@mail.gmail.com>\r
  18         <1258729976-sup-5984@broadwater.alporthouse.com>\r
  19 Date: Sat, 21 Nov 2009 00:25:11 +0100\r
  20 Message-ID: <87ocmwok2w.fsf@yoom.home.cworth.org>\r
  21 MIME-Version: 1.0\r
  22 Content-Type: text/plain; charset=us-ascii\r
  23 Cc: Not Much Mail <notmuch@notmuchmail.org>\r
  24 Subject: Re: [notmuch] Recommended Coding Style?\r
  25 X-BeenThere: notmuch@notmuchmail.org\r
  26 X-Mailman-Version: 2.1.12\r
  27 Precedence: list\r
  28 List-Id: "Use and development of the notmuch mail system."\r
  29         <notmuch.notmuchmail.org>\r
  30 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  31         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  32 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  33 List-Post: <mailto:notmuch@notmuchmail.org>\r
  34 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  35 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  36         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  37 X-List-Received-Date: Fri, 20 Nov 2009 23:25:24 -0000\r
  38 \r
  39 On Fri, 20 Nov 2009 15:15:16 +0000, Chris Wilson <chris@chris-wilson.co.uk> wrote:\r
  40 > Excerpts from Jan Janak's message of Fri Nov 20 15:08:31 +0000 2009:\r
  41 > > Is there any recommended coding style for the C/C++ code in notmuch?\r
  42 > \r
  43 > My prediction is that Carl will go with something close to what he wrote\r
  44 > for Cairo:\r
  45 > \r
  46 >   http://cgit.freedesktop.org/cairo/tree/CODING_STYLE\r
  47 > \r
  48 > He may or may not change to a more kernel style, but he definitely will\r
  49 > not mandate 3-space indents. ;-)\r
  50 \r
  51 I think Chris is right on this.\r
  52 \r
  53 I'll adapt that CODING_STYLE document at some point and bring it into\r
  54 the repository. And I probably will convert the indentation from\r
  55 4-column indents (with mixed spaces and tabs) to 8-column indents (with\r
  56 tabs only).\r
  57 \r
  58 One thing that people might find a bit different are that I like to put\r
  59 a space between a function name and the left parenthesis introducing\r
  60 it's arguments.\r
  61 \r
  62 That is, just as we have a space here:\r
  63 \r
  64         if (condition) {\r
  65                 ...\r
  66         }\r
  67 \r
  68 I like one here as well:\r
  69 \r
  70         foo = some_function (value);\r
  71 \r
  72 Most of the patches coming in have been fine so far. (Some have used\r
  73 tabs only for indentation and I've just silently cleaned those up for\r
  74 now, since I'm considering switching to that style anyway at some\r
  75 point.)\r
  76 \r
  77 One style point I would like to insist on is that commit messages should\r
  78 always have more than the first, single-line summary.\r
  79 \r
  80 The single line summary is good about saying *what* the commit does, but\r
  81 I always want to see at least one sentence about the *why* as well.\r
  82 \r
  83 I'll likely start bouncing patches that don't have that.\r
  84 \r
  85 Thanks for the question, Jan.\r
  86 \r
  87 -Carl\r
  88 \r
  89 \r