diff options
| author | Kyle Meyer <kyle@kyleam.com> | 2021-05-23 20:50:40 -0400 |
|---|---|---|
| committer | Kyle Meyer <kyle@kyleam.com> | 2021-05-24 20:28:14 -0400 |
| commit | c99e806fd307ef69adc0d3a277385687edfd3454 (patch) | |
| tree | b07b1369db516d9186258fac187297a5f1bcb93d | |
| parent | 3cf9a8213ff78b9226dba0ad0c045c7de41f3c96 (diff) | |
| download | piem-c99e806fd307ef69adc0d3a277385687edfd3454.tar.gz | |
b4: Better describe how piem-b4-am-ready-from-mid gets the thread
piem-b4-am-ready-from-mid's docstring doesn't mention that it tries to
download the thread from a piem-inboxes URL before falling back to
letting b4 handle the download. The manual's description is better,
though it makes it sound like the b4 fallback depends on not finding a
URL in piem-inboxes rather than the download being unsuccessful for
whatever reason. Reword the docstring and manual text to hopefully
make things clearer.
Message-Id: <20210524005040.12668-1-kyle@kyleam.com>
| -rw-r--r-- | Documentation/piem.texi | 10 | ||||
| -rw-r--r-- | piem-b4.el | 13 |
2 files changed, 14 insertions, 9 deletions
diff --git a/Documentation/piem.texi b/Documentation/piem.texi index ca6a97b..f4bbabc 100644 --- a/Documentation/piem.texi +++ b/Documentation/piem.texi @@ -341,11 +341,11 @@ a non-nil value or by giving a prefix argument. To generate the input thread, first any functions in @code{piem-mid-to-thread-functions} are tried. This allows for a thread to be retrieved from a local store (e.g., the Notmuch database). If -that fails, the thread is downloaded from the public-inbox URL -associated with the current buffer. Finally, if an inbox's entry in -@code{piem-inboxes} doesn't specify a URL, @code{b4 am} is called -without a local mbox, letting it download the thread according to its -own configuration. +that fails, try to download the thread from the @code{piem-inboxes} URL +associated with the current buffer, provided the current buffer's +message ID matches the one @code{piem-b4-am-from-mid} was called with. +As a last resort, call @code{b4 am} without a local mbox to let it +download the thread according to its own configuration. @item i @itemx M-x piem-b4-am-ready-from-mid @@ -131,10 +131,15 @@ list of arguments specified via ARGS." (defun piem-b4-am-from-mid (mid &optional args toggle-worktree) "Get the thread for MID, extract an am-ready mbox, and apply it. -Try to get a thread for the Message-Id MID with -`piem-mid-to-thread-functions', falling back to letting b4 -download it. After calling `b4 am' with ARGS to prepare an -am-ready mbox, feed the result to `git am'. +Try to generate a thread for the Message-Id MID with +`piem-mid-to-thread-functions'. If that fails, try to download +the thread from the `piem-inboxes' URL associated with the +current buffer, provided that the current buffer's message ID +matches MID. And if that doesn't work, let `b4 am' download the +thread according to its own configuration. + +After calling `b4 am' with ARGS to prepare an am-ready mbox, feed +the result to `git am'. When prefix argument TOGGLE-WORKTREE is non-nil, invert the meaning of `piem-am-create-worktree'. With the default value, |