From 61952fe189a2a1e97b7156eaee831a5a1915dd57 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Thu, 10 Jun 2021 14:59:42 -0400 Subject: piem-inboxes: Clarify that :coderepo points to a working tree 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. Message-Id: <20210610185943.14155-4-kyle@kyleam.com> --- piem.el | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'piem.el') diff --git a/piem.el b/piem.el index 6546615..cf176bd 100644 --- a/piem.el +++ b/piem.el @@ -76,7 +76,11 @@ list that supports the following properties: :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 -- cgit v1.2.3