From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id wFYsJoB8cWF+qQAAgWs5BA (envelope-from ) for ; Thu, 21 Oct 2021 16:43:12 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id kPnCIYB8cWF0JgAAbx9fmQ (envelope-from ) for ; Thu, 21 Oct 2021 14:43:12 +0000 Received: from mail.notmuchmail.org (nmbug.tethera.net [IPv6:2607:5300:201:3100::1657]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 214DD8ABF for ; Thu, 21 Oct 2021 16:43:12 +0200 (CEST) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 33ECF2902E; Thu, 21 Oct 2021 10:43:08 -0400 (EDT) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id DB60C26D91 for ; Thu, 21 Oct 2021 10:43:00 -0400 (EDT) Received: by fethera.tethera.net (Postfix, from userid 1001) id 907AE5FC42; Thu, 21 Oct 2021 10:43:00 -0400 (EDT) Received: (nullmailer pid 722950 invoked by uid 1000); Thu, 21 Oct 2021 14:42:59 -0000 From: David Bremner To: notmuch@notmuchmail.org, reply+AAANX2IQCBF766VNFFVYGC57PVNY3EVBNHHD3BUDCM@reply.github.com Cc: David Bremner Subject: [PATCH] lib: document n_o_w_config can return NOTMUCH_STATUS_NO_CONFIG Date: Thu, 21 Oct 2021 11:42:36 -0300 Message-Id: <20211021144236.722928-1-david@tethera.net> X-Mailer: git-send-email 2.33.0 MIME-Version: 1.0 Message-ID-Hash: RDHAIRXHVX2HTM6XHY44O7O7XUVPFWHK X-Message-ID-Hash: RDHAIRXHVX2HTM6XHY44O7O7XUVPFWHK X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.1 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1634827392; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=zgsZuBA0GAN6taBe0yK5Clg9ExkJVDbcUyclwcbSEug=; b=N/88rzlKfCB9kc7y/MkUriP00TXpoMEE+qfrdY+iINgy5Vz4xLNIAufmH2duZBm7BXtQc/ yb6uypwlZYp8CqxcK5sDTanNhYIQa0tgF8GHAsX32n0oz6kvcuTVG5R0xKVJNfOHn7CpRw o20L8ryrfAlXiT2qcy5uKJl1GkMyyeBgtkb68/mJvHXs/krAwdXnHcdJktUqzPVuUqyQOA oNG/KwxtDByUqkv3dRBxapmD8ffXA8ajH9nFZ+1evLkH1vmaw/9zVJb8TZAdG8Yz2f6y0s /WfzUBXpXenGoHH58XfoPHfUYFzR9ZnFZsQVYuIsOMHAgFwAmFznTf49TWvfPg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1634827392; a=rsa-sha256; cv=none; b=HiymJOyyDLSCb3l8sZQFL0/DqYYG7FAYzvP6qdeb7dNzrNEt11TZM/iU+1hF6vA2RoiTjE 9JS/nF63Re33P68G0URY9wTBlNt5Ncv0pTXjjuX/p2FsfyUqRtlfSnA+uuzxPpoLXwWQSP CeI7Q4v5ZgqA8CCl3BhruKuNF2R/5m0PYvwALqhZGs0c0KMYyYIktcTwLhEchVGHrkcG7z TrX7gEat41ofU5jJ4/NL+rE1inVFXQeBy8fHld2jcO7t2Uig18I8NFnhclmm9FXh6ME6Zy zE2nx4DTlRBOWs1DRrMYHnkJl4om+MsUI904UUe33beKT+DwFWSbug5R9b9HgA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2607:5300:201:3100::1657 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.16 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2607:5300:201:3100::1657 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 214DD8ABF X-Spam-Score: -1.16 X-Migadu-Scanner: scn1.migadu.com X-TUID: WbYj+bT/orxG This should be treated as fatal by callers, since we didn't succeed in opening a Xapian database. --- lib/notmuch.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/notmuch.h b/lib/notmuch.h index 074fc682..8d4d14af 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -433,6 +433,8 @@ notmuch_database_open_verbose (const char *path, * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database * argument is NULL. * + * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was found. Fatal. + * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory. * * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the -- 2.33.0