From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id 2VFUIjVGGGETXQAAgWs5BA (envelope-from ) for ; Sun, 15 Aug 2021 00:39:49 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id aAdBHTVGGGFNXwAAbx9fmQ (envelope-from ) for ; Sat, 14 Aug 2021 22:39:49 +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) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 72DF817C1F for ; Sun, 15 Aug 2021 00:39:48 +0200 (CEST) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id AE21F1FB94; Sat, 14 Aug 2021 18:39:44 -0400 (EDT) Received: from mail-qk1-x72f.google.com (mail-qk1-x72f.google.com [IPv6:2607:f8b0:4864:20::72f]) by mail.notmuchmail.org (Postfix) with ESMTPS id CA4E91FB90 for ; Sat, 14 Aug 2021 18:39:41 -0400 (EDT) Received: by mail-qk1-x72f.google.com with SMTP id az7so15082391qkb.5 for ; Sat, 14 Aug 2021 15:39:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=austinray-io.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=C/YnxqkP6ZkfD+Q2kpfNila36ZqKlN7BQzc94j2mQnU=; b=bMkTR8IPn8bcqfDXGP30CUOcxzEvGkxdR1fAZ5BCHMBOWXOlki2yJB7ZgP+4cEtCI1 H3RcYktNakMRnovVaIDiy5x4LRkOg5EciQuspcoutzVTzgL0IbHGmYDU2bsGHciWrGyt ecAc2PVjEvE4GWdckgoX7tfz8IJhE/ZjDrcWx1ZDB8K2aF/SBRNsyBSduqroO+e08yd0 BPEFi7fgv9TrosKhhEsDEGvOp0FobsWkBeVwnUNviAuSAK4+A7xF/UsHFvkw///eMnBr PW9QgQIDlUhI2LTIP2z7KRtyoTsIWGuG32gs2kqKOQhiNBkUjmyzoWCuy7CppcY3zOAe 9zsQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=C/YnxqkP6ZkfD+Q2kpfNila36ZqKlN7BQzc94j2mQnU=; b=PKkQQ7l9vKqAExrYmubKZUZaN6QwbkDCVyrrmyAj6F+NeZ1ehW7/78OYVxeSNuDFHt KVTfwIhWo06XWV/d6F7DD7ZR51qelBnlHoeHe819RugIQ3sxFPqpWcmV4fQSho6m3sVb lCku/nnp58MomPyxdNkD983ffqety6U0Zpl9iIBT9+9ZSHABkYZgg31Qb5CIPtKPRLqq D8PQ+Bps+ykKBlJOUycA93m3GRczfTbAt13QET8PkCdlCQN1ZnV3ZwqZ1K9PHEIFWk6g fxcLW9TQ8JZvew/z6N6qMoB5nzo4Rz9wH00DKeAMzfTmhJRXA3mlR/kYqJSNsqIby7SE bYzA== X-Gm-Message-State: AOAM531b0iwj7g01hx+HD1+MPUEfEjdLjlTDcG8fLLfzUnjNO7Be6sp/ cUtkMC+OmsZi2pA5guyyCe3wlvg4fdqCqA== X-Google-Smtp-Source: ABdhPJywkapbu4OWIZBMErQHn9Fj2pRjVrNyHUJ6i5bnlGnoT2Dc58M5XbNcsMas73YhqkqrdMi+mQ== X-Received: by 2002:a05:620a:24c9:: with SMTP id m9mr8925733qkn.421.1628980774568; Sat, 14 Aug 2021 15:39:34 -0700 (PDT) Received: from localhost.localdomain (68-20-11-88.lightspeed.rlghnc.sbcglobal.net. [68.20.11.88]) by smtp.gmail.com with ESMTPSA id b19sm830599qkc.7.2021.08.14.15.39.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 14 Aug 2021 15:39:34 -0700 (PDT) From: Austin Ray To: notmuch@notmuchmail.org Subject: [PATCH v2] lib: correct deprecated db open functions' docs Date: Sat, 14 Aug 2021 18:39:17 -0400 Message-Id: <20210814223917.3496448-1-austin@austinray.io> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Message-ID-Hash: 6TRG5H7W2Z77GWODMUCHSCWXE3XGQMFW X-Message-ID-Hash: 6TRG5H7W2Z77GWODMUCHSCWXE3XGQMFW X-MailFrom: austin@austinray.io 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 CC: Austin Ray 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=1628980789; 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:dkim-signature; bh=tem7kX7ikWnHqTK81i7HumSVaiUaA6l9EPYL3Z/nDfA=; b=k+Sxe3gC73JxQdD50bUUXEVQFdiN1tDzZF6khojmsZj8Gjt881i9PT1vTV/oGC3k64l3Vi GOScrD08Rzqb6EHYSjEG3JmStslteETwl5i2w6xChjX7XjesgDT1EAYC3dni+DTFcqg4wI ugYdUl00iayPIW243YyLFzdDuzYGjD72SPQ4cKuhmRiBQjWEWSU/enDKCLmpTAsrSimwxo iC4hpiYfNUkVduNYYPh8DmV3wRdIdCJsvU6In/xwQFEhrm/pfBTYhwo1Su3HtkEFeV5WXA vyojU+DK1N2o0t/y5e/BgW3RZTyg/d6J3EgIopjpOhrpx4rB13XWHl66pDPELQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1628980789; a=rsa-sha256; cv=none; b=Uc6hHzvTHbnPIz14euP6BTU99dhf+gzei/R3NDFx1S3P3FXx31dlZc9e5Pd1qaD+ZyiAPY vkeWSgBX2gtWnCQk2FBMCGQ8rL3aYrfKx/otXZKLOAnc1qHRU2qb4GZTFpUVISVHDvmP0r 46ikhTkOUflWaXI8Lf4T45AFAqwmqskJjLfAFYZQk2F5IlYaEJOHQ2aVSmHhbOLIgaACnJ cQs9IvpXHAAoSw5dglwIlsyBElC+wrPX/+MxFxBL/cRb2U6kDPghM92IbMbKf3LEX0hWDM 0aHXpd6RgR/ItWqm/OSt3PNhLcBkJV5DxaFndHpGo2YQBUu88HR/g6OImSUODw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=austinray-io.20150623.gappssmtp.com header.s=20150623 header.b=bMkTR8IP; 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-Spam-Score: -0.03 Authentication-Results: aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=austinray-io.20150623.gappssmtp.com header.s=20150623 header.b=bMkTR8IP; 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: 72DF817C1F X-Spam-Score: -0.03 X-Migadu-Scanner: scn0.migadu.com X-TUID: QDFys85jLBp2 Both notmuch_database_open() and notmuch_database_open_verbose()'s documentation state they call notmuch_database_open_with_config() with config_path=NULL; however, their implementations pass an empty string. The empty string is the correct value to maintain their original behavior of not loading the user's configuration so their documentation is incorrect. --- lib/notmuch.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/notmuch.h b/lib/notmuch.h index 3b28bea3..876d35d3 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -316,7 +316,7 @@ typedef enum { /** * Deprecated alias for notmuch_database_open_with_config with - * config_path=error_message=NULL + * config_path="" and error_message=NULL * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32) */ /* NOTMUCH_DEPRECATED(5, 4) */ @@ -326,7 +326,7 @@ notmuch_database_open (const char *path, notmuch_database_t **database); /** * Deprecated alias for notmuch_database_open_with_config with - * config_path=NULL + * config_path="" * * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32) * -- 2.31.1