From: Austin Clements Date: Tue, 5 Aug 2014 01:29:16 +0000 (+2000) Subject: [PATCH] lib: Improve documentation of _notmuch_message_create_for_message_id X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=8647759b68406a27402060810d200334a21de291;p=notmuch-archives.git [PATCH] lib: Improve documentation of _notmuch_message_create_for_message_id --- diff --git a/cb/55a52e8165611befe95eff835a8d38b6889947 b/cb/55a52e8165611befe95eff835a8d38b6889947 new file mode 100644 index 000000000..ef6edd2ad --- /dev/null +++ b/cb/55a52e8165611befe95eff835a8d38b6889947 @@ -0,0 +1,109 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id E68D1431FBC + for ; Mon, 4 Aug 2014 18:29:35 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -2.3 +X-Spam-Level: +X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id u95Uhu29PoSj for ; + Mon, 4 Aug 2014 18:29:29 -0700 (PDT) +Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu + [18.7.68.35]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 6D30B431FAE + for ; Mon, 4 Aug 2014 18:29:29 -0700 (PDT) +X-AuditID: 12074423-f79bf6d000007580-18-53e033770a6d +Received: from mailhub-auth-3.mit.edu ( [18.9.21.43]) + (using TLS with cipher AES256-SHA (256/256 bits)) + (Client did not present a certificate) + by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP + id 70.32.30080.77330E35; Mon, 4 Aug 2014 21:29:27 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s751TP3a013118; + Mon, 4 Aug 2014 21:29:25 -0400 +Received: from drake.dyndns.org + (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com + [216.15.114.40]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s751TNGC000592 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Mon, 4 Aug 2014 21:29:25 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1XETZ5-00011k-EF; Mon, 04 Aug 2014 21:29:23 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH] lib: Improve documentation of + _notmuch_message_create_for_message_id +Date: Mon, 4 Aug 2014 21:29:16 -0400 +Message-Id: <1407202156-3909-1-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 2.0.0 +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFprFIsWRmVeSWpSXmKPExsUixCmqrVtu/CDYYOIjHYvrN2cyOzB6PFt1 + izmAMYrLJiU1J7MstUjfLoErY+ns+8wFE7grGtvaWRsYz3J0MXJySAiYSNw9+5MNwhaTuHBv + PZgtJDCbSWLncf4uRi4gewOjxP3+dywQzm0miafX2xghnLmMEtveL2YCaWET0JDYtn85I4gt + IiAtsfPubNYuRg4OZgE1iT9dKiBhYYFQidaf78BKWARUJVrXTmABsXkF7CVmPpzGBHGFnETD + jU9sExh5FzAyrGKUTcmt0s1NzMwpTk3WLU5OzMtLLdI108vNLNFLTSndxAgKAnYX5R2Mfw4q + HWIU4GBU4uEVULsfLMSaWFZcmXuIUZKDSUmUN1TvQbAQX1J+SmVGYnFGfFFpTmrxIUYJDmYl + Ed58QaAcb0piZVVqUT5MSpqDRUmc9621VbCQQHpiSWp2ampBahFMVoaDQ0mC97AhUKNgUWp6 + akVaZk4JQpqJgxNkOA/QcDYjkOHFBYm5xZnpEPlTjIpS4rweIM0CIImM0jy4XliUvmIUB3pF + mJcbpJ0HGOFw3a+ABjMBDTbTuQ8yuCQRISXVwBi7/ampmNlB7rNX3t0u2/JtXdU0tqzWTdc8 + pz7aONNw94m7j4rfXv214lS20KvDB08cn+PM+uR3raGj8FbOf56275/uvV+z52dG85HXrHcd + Tjn9c390uL702CHGLRfTZstH9Fxbe7Zz5n819Zmz5bjlXziGHA2u8n3/5naJ/4mo3d0Lc+QT + b+uIKbEUZyQaajEXFScCAFjCvOStAgAA +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 05 Aug 2014 01:29:36 -0000 + +Clarify the state of the returned message when +_notmuch_message_create_for_message_id returns +NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND. +--- + lib/message.cc | 8 +++++--- + 1 file changed, 5 insertions(+), 3 deletions(-) + +diff --git a/lib/message.cc b/lib/message.cc +index 8b17843..f8b346f 100644 +--- a/lib/message.cc ++++ b/lib/message.cc +@@ -193,14 +193,16 @@ _notmuch_message_create (const void *talloc_owner, + * There is already a document with message ID 'message_id' in the + * database. The returned message can be used to query/modify the + * document. ++ * + * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND: + * + * No document with 'message_id' exists in the database. The + * returned message contains a newly created document (not yet + * added to the database) and a document ID that is known not to +- * exist in the database. The caller can modify the message, and a +- * call to _notmuch_message_sync will add * the document to the +- * database. ++ * exist in the database. This message is "blank"; that is, it ++ * contains only a message ID and no other metadata. The caller ++ * can modify the message, and a call to _notmuch_message_sync ++ * will add the document to the database. + * + * If an error occurs, this function will return NULL and *status + * will be set as appropriate. (The status pointer argument must +-- +2.0.0 +