discussion and development of piem
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
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	[thread overview]
Message-ID: <20210610185943.14155-4-kyle@kyleam.com> (raw)
In-Reply-To: <20210610185943.14155-1-kyle@kyleam.com>

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


  parent reply	other threads:[~2021-06-10 19:00 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-10 18:59 [PATCH 0/4] Support reading inboxes from ~/.public-inbox/config Kyle Meyer
2021-06-10 18:59 ` [PATCH 1/4] piem-inbox-coderepo-maybe-read: Avoid confusing "inbox" references Kyle Meyer
2021-06-10 18:59 ` [PATCH 2/4] piem-inbox-coderepo*: Always return coderepo as a directory Kyle Meyer
2021-06-10 18:59 ` Kyle Meyer [this message]
2021-06-10 18:59 ` [PATCH 4/4] Support reading inboxes from ~/.public-inbox/config Kyle Meyer
2021-06-10 19:32   ` Xinglu Chen
2021-06-10 21:00     ` Kyle Meyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://git.kyleam.com/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210610185943.14155-4-kyle@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=piem@inbox.kyleam.com \
    --subject='Re: [PATCH 3/4] piem-inboxes: Clarify that :coderepo points to a working tree' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.kyleam.com/piem/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).