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 | |
| 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>
| -rw-r--r-- | Documentation/piem.texi | 10 | ||||
| -rw-r--r-- | piem.el | 6 |
2 files changed, 10 insertions, 6 deletions
diff --git a/Documentation/piem.texi b/Documentation/piem.texi index 17bb085..3e3ccf9 100644 --- a/Documentation/piem.texi +++ b/Documentation/piem.texi @@ -159,11 +159,11 @@ name at the end of the @code{:url} value. Specifying either @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 @@ -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 |