diff options
| author | Kyle Meyer <kyle@kyleam.com> | 2021-06-10 14:59:42 -0400 |
|---|---|---|
| committer | Kyle Meyer <kyle@kyleam.com> | 2021-06-11 13:36:54 -0400 |
| commit | 61952fe189a2a1e97b7156eaee831a5a1915dd57 (patch) | |
| tree | da32f4c590aa357a2f02f8b7d7e86f137591035e /piem.el | |
| parent | 8e5d8aead8ffb2a9f30bf0b779a65d87fd9ad9e6 (diff) | |
| download | piem-61952fe189a2a1e97b7156eaee831a5a1915dd57.tar.gz | |
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>
Diffstat (limited to 'piem.el')
| -rw-r--r-- | piem.el | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -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 |