cb/55a52e8165611befe95eff835a8d38b6889947

   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 E68D1431FBC\r
   6         for <notmuch@notmuchmail.org>; Mon,  4 Aug 2014 18:29:35 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -2.3\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_MED=-2.3] 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 u95Uhu29PoSj for <notmuch@notmuchmail.org>;\r
  16         Mon,  4 Aug 2014 18:29:29 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu\r
  18         [18.7.68.35])\r
  19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 6D30B431FAE\r
  22         for <notmuch@notmuchmail.org>; Mon,  4 Aug 2014 18:29:29 -0700 (PDT)\r
  23 X-AuditID: 12074423-f79bf6d000007580-18-53e033770a6d\r
  24 Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
  25         (using TLS with cipher AES256-SHA (256/256 bits))\r
  26         (Client did not present a certificate)\r
  27         by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP\r
  28         id 70.32.30080.77330E35; Mon,  4 Aug 2014 21:29:27 -0400 (EDT)\r
  29 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  30         by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s751TP3a013118; \r
  31         Mon, 4 Aug 2014 21:29:25 -0400\r
  32 Received: from drake.dyndns.org\r
  33         (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
  34         [216.15.114.40]) (authenticated bits=0)\r
  35         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  36         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s751TNGC000592\r
  37         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  38         Mon, 4 Aug 2014 21:29:25 -0400\r
  39 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  40         (envelope-from <amdragon@mit.edu>)\r
  41         id 1XETZ5-00011k-EF; Mon, 04 Aug 2014 21:29:23 -0400\r
  42 From: Austin Clements <amdragon@MIT.EDU>\r
  43 To: notmuch@notmuchmail.org\r
  44 Subject: [PATCH] lib: Improve documentation of\r
  45         _notmuch_message_create_for_message_id\r
  46 Date: Mon,  4 Aug 2014 21:29:16 -0400\r
  47 Message-Id: <1407202156-3909-1-git-send-email-amdragon@mit.edu>\r
  48 X-Mailer: git-send-email 2.0.0\r
  49 X-Brightmail-Tracker:\r
  50  H4sIAAAAAAAAA+NgFprFIsWRmVeSWpSXmKPExsUixCmqrVtu/CDYYOIjHYvrN2cyOzB6PFt1\r
  51         izmAMYrLJiU1J7MstUjfLoErY+ns+8wFE7grGtvaWRsYz3J0MXJySAiYSNw9+5MNwhaTuHBv\r
  52         PZgtJDCbSWLncf4uRi4gewOjxP3+dywQzm0miafX2xghnLmMEtveL2YCaWET0JDYtn85I4gt\r
  53         IiAtsfPubNYuRg4OZgE1iT9dKiBhYYFQidaf78BKWARUJVrXTmABsXkF7CVmPpzGBHGFnETD\r
  54         jU9sExh5FzAyrGKUTcmt0s1NzMwpTk3WLU5OzMtLLdI108vNLNFLTSndxAgKAnYX5R2Mfw4q\r
  55         HWIU4GBU4uEVULsfLMSaWFZcmXuIUZKDSUmUN1TvQbAQX1J+SmVGYnFGfFFpTmrxIUYJDmYl\r
  56         Ed58QaAcb0piZVVqUT5MSpqDRUmc9621VbCQQHpiSWp2ampBahFMVoaDQ0mC97AhUKNgUWp6\r
  57         akVaZk4JQpqJgxNkOA/QcDYjkOHFBYm5xZnpEPlTjIpS4rweIM0CIImM0jy4XliUvmIUB3pF\r
  58         mJcbpJ0HGOFw3a+ABjMBDTbTuQ8yuCQRISXVwBi7/ampmNlB7rNX3t0u2/JtXdU0tqzWTdc8\r
  59         pz7aONNw94m7j4rfXv214lS20KvDB08cn+PM+uR3raGj8FbOf56275/uvV+z52dG85HXrHcd\r
  60         Tjn9c390uL702CHGLRfTZstH9Fxbe7Zz5n819Zmz5bjlXziGHA2u8n3/5naJ/4mo3d0Lc+QT\r
  61         b+uIKbEUZyQaajEXFScCAFjCvOStAgAA\r
  62 X-BeenThere: notmuch@notmuchmail.org\r
  63 X-Mailman-Version: 2.1.13\r
  64 Precedence: list\r
  65 List-Id: "Use and development of the notmuch mail system."\r
  66         <notmuch.notmuchmail.org>\r
  67 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  68         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  69 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  70 List-Post: <mailto:notmuch@notmuchmail.org>\r
  71 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  72 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  73         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  74 X-List-Received-Date: Tue, 05 Aug 2014 01:29:36 -0000\r
  75 \r
  76 Clarify the state of the returned message when\r
  77 _notmuch_message_create_for_message_id returns\r
  78 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.\r
  79 ---\r
  80  lib/message.cc | 8 +++++---\r
  81  1 file changed, 5 insertions(+), 3 deletions(-)\r
  82 \r
  83 diff --git a/lib/message.cc b/lib/message.cc\r
  84 index 8b17843..f8b346f 100644\r
  85 --- a/lib/message.cc\r
  86 +++ b/lib/message.cc\r
  87 @@ -193,14 +193,16 @@ _notmuch_message_create (const void *talloc_owner,\r
  88   *     There is already a document with message ID 'message_id' in the\r
  89   *     database. The returned message can be used to query/modify the\r
  90   *     document.\r
  91 + *\r
  92   *   NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:\r
  93   *\r
  94   *     No document with 'message_id' exists in the database. The\r
  95   *     returned message contains a newly created document (not yet\r
  96   *     added to the database) and a document ID that is known not to\r
  97 - *     exist in the database. The caller can modify the message, and a\r
  98 - *     call to _notmuch_message_sync will add * the document to the\r
  99 - *     database.\r
 100 + *     exist in the database.  This message is "blank"; that is, it\r
 101 + *     contains only a message ID and no other metadata. The caller\r
 102 + *     can modify the message, and a call to _notmuch_message_sync\r
 103 + *     will add the document to the database.\r
 104   *\r
 105   * If an error occurs, this function will return NULL and *status\r
 106   * will be set as appropriate. (The status pointer argument must\r
 107 -- \r
 108 2.0.0\r
 109 \r