From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id sELgBBM3519vJgAA0tVLHw (envelope-from ) for ; Sat, 26 Dec 2020 13:13:55 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id 2Ou4ABM3519mXgAAB5/wlQ (envelope-from ) for ; Sat, 26 Dec 2020 13:13:55 +0000 Received: from mail.notmuchmail.org (nmbug.tethera.net [144.217.243.247]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (2048 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 8DA9794036A for ; Sat, 26 Dec 2020 13:13:54 +0000 (UTC) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 3D5CC29CE4; Sat, 26 Dec 2020 08:13:46 -0500 (EST) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 44685270F1 for ; Sat, 26 Dec 2020 08:13:44 -0500 (EST) Received: by fethera.tethera.net (Postfix, from userid 1001) id 52DB85FC36; Sat, 26 Dec 2020 08:13:42 -0500 (EST) Received: (nullmailer pid 1216418 invoked by uid 1000); Sat, 26 Dec 2020 13:13:40 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: Re: [PATCH 03/24] lib: add stub for notmuch_database_open_with_config In-Reply-To: <20201225004228.647328-4-david@tethera.net> References: <20201225004228.647328-1-david@tethera.net> <20201225004228.647328-4-david@tethera.net> Date: Sat, 26 Dec 2020 09:13:40 -0400 Message-ID: <87eejc90cb.fsf@tethera.net> MIME-Version: 1.0 Message-ID-Hash: R64AFG27LR4XF7I2F6BE4K6HUODH5KXU X-Message-ID-Hash: R64AFG27LR4XF7I2F6BE4K6HUODH5KXU X-MailFrom: david@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 X-Migadu-Spam-Score: -0.56 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 144.217.243.247 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 8DA9794036A X-Spam-Score: -0.56 X-Migadu-Scanner: scn0.migadu.com X-TUID: FL7wq26m8jIu David Bremner writes: > +/** > + * Open an existing notmuch database located at 'database_path', using > + * configuration in 'config_path'. > + * > + * @param[in] database_path > + * @parblock > + * Path to existing database. > + * > + * A notmuch database is a Xapian database containing appropriate > + * metadata. > * > * The database should have been created at some time in the past, > * (not necessarily by this process), by calling > - * notmuch_database_create with 'path'. By default the database should be > - * opened for reading only. In order to write to the database you need to > - * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode. > + * notmuch_database_create. > + * > + * If 'database_path' is NULL, use the location specified > + * > + * - in the environment variable NOTMUCH_DATABASE, if non-empty Added: * - in a configuration file, located as described under 'config_path' * > + * > + * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults > + * to "$HOME/.local/share" and PROFILE as as discussed in > + * 'profile' > + *