discussion and development of piem
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: piem@inbox.kyleam.com
Cc: zimoun <zimon.toutoune@gmail.com>
Subject: [PATCH 6/6] manual: Document worktree-related options
Date: Sun, 15 Nov 2020 01:15:18 -0500	[thread overview]
Message-ID: <20201115061518.22191-7-kyle@kyleam.com> (raw)
In-Reply-To: <20201115061518.22191-1-kyle@kyleam.com>

 piem.texi | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/piem.texi b/piem.texi
index cf39fe8..5f90055 100644
--- a/piem.texi
+++ b/piem.texi
@@ -251,6 +251,17 @@ Applying patches contained in a message
 be provided as the default completion candidate.  Entering an empty base
 signals to use the current branch of the repository as the base.
+@vindex piem-am-create-worktree
+@vindex piem-am-read-worktree-function
+Rather than applying the patches directly to the associated code
+repository, you can create a dedicated worktree by setting
+@code{piem-am-create-worktree} to a non-nil value.  Giving a prefix
+argument to @code{piem-am} inverts the meaning of
+@code{piem-am-create-worktree}; that is, by default a prefix argument is
+useful if you generally prefer to work within the configured code
+repository but would like to trigger the one-off creation of a worktree
+for a particular call.
 @cindex magit
 @vindex piem-use-magit
 When piem loads, it detects whether Magit is loaded and sets
@@ -320,7 +331,9 @@ Using b4 to apply patches
 ID of the current buffer is not known (i.e. @code{piem-mid} returns
 nil), one is read from the caller.  The caller is also queried for the
 branch name and base, as described for @code{piem-am} (@pxref{Applying
-patches contained in a message}).
+patches contained in a message}).  And, as with @code{piem-am}, a
+worktree can be created by configuring @code{piem-am-create-worktree} to
+a non-nil value or by giving a prefix argument.
 @findex piem-mid-to-thread-functions
 To generate the input thread, first any functions in

  parent reply	other threads:[~2020-11-15  6:16 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-15  6:15 [PATCH 0/6] Support applying patches in a new worktree Kyle Meyer
2020-11-15  6:15 ` [PATCH 1/6] piem-am: Rephrase CODEREPO description Kyle Meyer
2020-11-15  6:15 ` [PATCH 2/6] piem-am: Store "empty string" branch check Kyle Meyer
2020-11-15  6:15 ` [PATCH 3/6] am: Support creating a new worktree Kyle Meyer
2020-11-15  6:15 ` [PATCH 4/6] am: Add option to configure how worktree is read Kyle Meyer
2020-11-15  6:15 ` [PATCH 5/6] am: Allow flipping worktree creation with prefix argument Kyle Meyer
2020-11-15  6:15 ` Kyle Meyer [this message]
2020-11-15 13:31 ` [PATCH 0/6] Support applying patches in a new worktree zimoun
2020-11-15 19:26   ` Kyle Meyer
2020-11-15 22:32     ` Kyle Meyer
2020-11-15 23:47       ` zimoun

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:

  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=20201115061518.22191-7-kyle@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=piem@inbox.kyleam.com \
    --cc=zimon.toutoune@gmail.com \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


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).