From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:aacc::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms12 with LMTPS id UNOMBDBhwmAObgAAsNZ9tg (envelope-from ); Thu, 10 Jun 2021 19:00:00 +0000 Received: from out2.migadu.com ([2001:41d0:2:aacc::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id +M3PFCxhwmCGBwAAB5/wlQ (envelope-from ); Thu, 10 Jun 2021 18:59:56 +0000 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kyleam.com; s=key1; t=1623351596; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HzR5fktwcUXKl2Lv+VdQ9QxrYAZ/nmpDNg1tLVkZ54M=; b=JSJV6YmVfDfKLq47seoIFN9mQhpFWym5yj9ze1JrdED2F9Bcr7NgITPeEv/OoMyR0LlzfW 5M0zIDBBqq4OX8euFaNCdLv8PnVA9cyeSc0LekbadUN1P6lM1d6nnNdamekaHNU1Hrl8Qs tbrXVckdBtcX762bJ5QEeNto3iWu9P63eLdnRn1537wKG2wkc3MMnE44X5fS9Mr4Eg/0rY xDWoZmVy44MSBxdPWD88vmYKABM5cREdNkDe7MCtHId7XeobAyeE9F7eysXvg54fPqimCk O0xjojR5Httbym4C+st563tY+4HGxbSYQFOCDs+R/c4OdCJKJ1qmU9Nv38A9IQ== From: Kyle Meyer To: piem@inbox.kyleam.com Subject: [PATCH 3/4] piem-inboxes: Clarify that :coderepo points to a working tree Date: Thu, 10 Jun 2021 14:59:42 -0400 Message-Id: <20210610185943.14155-4-kyle@kyleam.com> In-Reply-To: <20210610185943.14155-1-kyle@kyleam.com> References: <20210610185943.14155-1-kyle@kyleam.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: kyle@kyleam.com X-TUID: 95CqjQF+jEhw The properties of piem-inboxes align with public-inbox-config names to keep things consistent, which is especially important given the upcoming support of reading inboxes from public-inbox's configuration. However, :coderepo, which needs to point to a working tree, doesn't nicely match publicinbox.$inbox.coderepo, which points to another section that in turn must point to a .git directory. I'm still undecided on whether using a different name (e.g., :code-working-tree) would be clearer, but at least document the difference to hopefully avoid some confusion. --- Documentation/piem.texi | 10 +++++----- piem.el | 6 +++++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Documentation/piem.texi b/Documentation/piem.texi index 17bb085a..3e3ccf9e 100644 --- a/Documentation/piem.texi +++ b/Documentation/piem.texi @@ -159,11 +159,11 @@ Registering inboxes @code{:listid} or @code{:address} is important so that a message in a buffer can be mapped to an inbox in @code{piem-inboxes}. -@code{:coderepo} points to a local Git repository that contains code -related to that archive (in the example above, a local clone of -@url{https://git.kernel.org/pub/scm/git/git.git/}). This information is -required to apply patches from an archive to a local code repository -(@pxref{Applying patches}). +@code{:coderepo} points to the working tree of a local Git repository +that contains code related to that archive (in the example above, a +local clone of @url{https://git.kernel.org/pub/scm/git/git.git/}). This +information is required to apply patches from an archive to a local code +repository (@pxref{Applying patches}). @node Enabling integration libraries @section Enabling integration libraries diff --git a/piem.el b/piem.el index 65466150..cf176bdb 100644 --- a/piem.el +++ b/piem.el @@ -76,7 +76,11 @@ (defcustom piem-inboxes nil :listid The email address and List-ID for the inbox. :coderepo - Local path of the code repository associated with the inbox. + Local path to the code repository associated with the inbox. + This value should point to the working tree. Note that this + differs from public-inbox-config's coderepo, which is a link to + another section that must point to the repository's git + directory. :url A URL hosting HTTPS archives. This value must end with a slash. :maildir -- 2.32.0