From: Christian Brauner <brauner@kernel.org>
To: "Kernel.org Tools" <tools@kernel.org>
Cc: "Christian Brauner (Amutable)" <brauner@kernel.org>,
Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Subject: [PATCH b4 v2 17/44] edit_in_editor: work in the tree the caller names
Date: Fri, 31 Jul 2026 23:58:58 +0200 [thread overview]
Message-ID: <20260731-work-b4-editor-branch-guard-v2-17-243fd19d322d@kernel.org> (raw)
In-Reply-To: <20260731-work-b4-editor-branch-guard-v2-0-243fd19d322d@kernel.org>
The scratch file, the branch lookup and the core.editor lookup all
came from the process cwd. The review TUI scopes every other git call
to session['topdir']; this was the one place where the tree was
implied rather than named. Add a topdir argument and have the review
TUI pass the one it already tracks.
Signed-off-by: Christian Brauner (Amutable) <brauner@kernel.org>
---
src/b4/__init__.py | 26 ++++++++++++++++++--------
src/b4/review_tui/_review_app.py | 12 +++++++++---
src/tests/test_tui_review.py | 2 +-
3 files changed, 28 insertions(+), 12 deletions(-)
diff --git a/src/b4/__init__.py b/src/b4/__init__.py
index 3d22c89..a22c28d 100644
--- a/src/b4/__init__.py
+++ b/src/b4/__init__.py
@@ -6176,10 +6176,17 @@ def edit_in_editor(
bdata: bytes,
filehint: str = 'COMMIT_EDITMSG',
*,
+ topdir: Optional[str] = None,
guard_branch: bool = False,
) -> bytes:
"""Open the user's editor on bdata and return what they saved.
+ topdir is the working tree the edit belongs to: the scratch file is
+ created there, and it is the tree HEAD is read from. It defaults to the
+ working tree of the current directory, which is only right for callers
+ that operate on the process cwd -- anything driving a specific worktree
+ (the TUIs) must pass it explicitly.
+
guard_branch opts into a collision check, and only callers that store
the result into whatever branch HEAD happens to point at may set it
(b4 prep keeps the cover letter in the current branch's tracking commit,
@@ -6191,12 +6198,16 @@ def edit_in_editor(
where their data lands, so refusing the edit would throw away the user's
work to prevent a collision that cannot happen.
"""
- # Read before the edit and compare after, so this can never end up
- # comparing two different points in time. A detached HEAD reads as None
- # and still guards: None is not a branch we started on, so checking one
- # out mid-edit is caught like any other switch.
- read_branch = git_get_current_branch() if guard_branch else None
- corecfg = get_config_from_git(r'core\..*')
+ if topdir is None:
+ topdir = git_get_toplevel()
+ # Read before the edit and compare after, both in topdir, so this can
+ # never end up comparing two different repositories' HEADs. A detached
+ # HEAD reads as None and still guards: None is not a branch we started
+ # on, so checking one out mid-edit is caught like any other switch.
+ read_branch = git_get_current_branch(topdir) if guard_branch else None
+ # core.editor comes from the same tree as everything else here, so a
+ # repository-local setting is the one belonging to the edited branch.
+ corecfg = get_config_from_git(r'core\..*', gitdir=topdir)
editor = (
os.environ.get('GIT_EDITOR')
or corecfg.get('editor')
@@ -6206,7 +6217,6 @@ def edit_in_editor(
)
logger.debug('editor=%s', editor)
- topdir = git_get_toplevel()
if topdir is not None:
p = Path(topdir)
else:
@@ -6233,7 +6243,7 @@ def edit_in_editor(
bdata = bdata.replace(b'\r\n', b'\n').replace(b'\r', b'\n')
if guard_branch:
- write_branch = git_get_current_branch()
+ write_branch = git_get_current_branch(topdir)
if write_branch != read_branch:
with tempfile.NamedTemporaryFile(
mode='wb',
diff --git a/src/b4/review_tui/_review_app.py b/src/b4/review_tui/_review_app.py
index 8139518..74f6aa0 100644
--- a/src/b4/review_tui/_review_app.py
+++ b/src/b4/review_tui/_review_app.py
@@ -1329,7 +1329,9 @@ class ReviewApp(LoreNodeShutdownMixin, CheckRunnerMixin, App[None]):
with self.suspend():
result = b4.edit_in_editor(
- editor_text.encode(), filehint='reply.b4-review.eml'
+ editor_text.encode(),
+ filehint='reply.b4-review.eml',
+ topdir=self._topdir,
)
if not result:
@@ -1449,7 +1451,9 @@ class ReviewApp(LoreNodeShutdownMixin, CheckRunnerMixin, App[None]):
"""Launch $EDITOR for the maintainer's note on *target*."""
editor_text = existing + self._NOTE_FOOTER
with self.suspend():
- result = b4.edit_in_editor(editor_text.encode(), filehint='note.txt')
+ result = b4.edit_in_editor(
+ editor_text.encode(), filehint='note.txt', topdir=self._topdir
+ )
if not result:
self.notify('Editor returned no content')
@@ -1713,7 +1717,9 @@ class ReviewApp(LoreNodeShutdownMixin, CheckRunnerMixin, App[None]):
editor_text = f'On {orig_date}, {orig_author} wrote:\n{quoted}\n\n'
with self.suspend():
- result = b4.edit_in_editor(editor_text.encode(), filehint='reply.eml')
+ result = b4.edit_in_editor(
+ editor_text.encode(), filehint='reply.eml', topdir=self._topdir
+ )
reply_text = result.decode(errors='replace')
if reply_text == editor_text:
self.notify('No changes made')
diff --git a/src/tests/test_tui_review.py b/src/tests/test_tui_review.py
index 7387bd2..b19e3f9 100644
--- a/src/tests/test_tui_review.py
+++ b/src/tests/test_tui_review.py
@@ -260,7 +260,7 @@ class TestReplyVerbatim:
)
seen: List[str] = []
- def fake_editor(data: bytes, filehint: str = '') -> bytes:
+ def fake_editor(data: bytes, filehint: str = '', **kwargs: Any) -> bytes:
seen.append(data.decode())
return buffer.encode()
--
2.53.0
next prev parent reply other threads:[~2026-07-31 21:59 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-31 21:58 [PATCH b4 v2 00/44] Stop the editor branch guard from eating review replies Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 01/44] review-tui: mark all outgoing mail as read, not just " Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 02/44] tests: cover the shared outgoing-seen helper Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 03/44] review: close the messages database when auto-marking fails Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 04/44] review: use the same busy timeout for both review databases Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 05/44] review: drop the unused return value from set_flags_bulk() Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 06/44] review: don't let archiving a series raise Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 07/44] tests: cover an unwritable series archive Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 08/44] review-tui: keep post-send bookkeeping out of the send error path Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 09/44] tests: cover the thank-you send's post-send bookkeeping Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 10/44] review-tui: say which way a take did not reach 'accepted' Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 11/44] tests: cover the take statuses in the thank-and-archive chain Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 12/44] review-tui: use the shared helper to delete a review branch Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 13/44] ty: check reachability in the repository the commit landed in Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 14/44] tests: cover the publish check using the repository it is given Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 15/44] edit_in_editor: make the branch guard opt-in Christian Brauner
2026-07-31 21:58 ` [PATCH b4 v2 16/44] tests: cover the opt-in branch guard in edit_in_editor Christian Brauner
2026-07-31 21:58 ` Christian Brauner [this message]
2026-07-31 21:58 ` [PATCH b4 v2 18/44] tests: cover edit_in_editor working in the caller's tree Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 19/44] ty: edit the thank-you review in the tree it was pointed at Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 20/44] tests: cover the ty review editing in the named tree Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 21/44] tui: route editor launches through one non-fatal helper Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 22/44] tests: cover an editor failure leaving the review TUI standing Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 23/44] review-tui: only put back a branch b4 checked out itself Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 24/44] tests: cover the review TUI's branch-restore guard Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 25/44] review-tui: put HEAD back where it was when it was not on a branch Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 26/44] tests: cover the restore from a detached HEAD Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 27/44] tests: pin the default branch in the queue-delivery fixture Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 28/44] ty: an unknown remote tip is undetermined, not unpublished Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 29/44] review-tui: keep post-send bookkeeping out of the review send error path Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 30/44] tests: cover the review send's post-send bookkeeping Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 31/44] review: close the tracking database when archiving fails Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 32/44] review: clean up a review branch that cannot be finished Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 33/44] tests: cover create_review_branch cleaning up a half-built branch Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 34/44] review-tui: put the branch back after a revision upgrade Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 35/44] tests: cover the revision upgrade's branch handling Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 36/44] review-tui: restore the original branch however the tracking loop ends Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 37/44] review-tui: do not let a failed tracking load skip the branch restore Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 38/44] tests: cover the tracking TUI restoring the branch on the way out Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 39/44] review-tui: close the tracking database when the status sync fails Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 40/44] tests: cover the status sync closing its database Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 41/44] review-tui: catch the exit a failed checkout reports itself with Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 42/44] tests: cover a failed checkout leaving the tracking list standing Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 43/44] review-tui: put the user back when the branch they are on is deleted Christian Brauner
2026-07-31 21:59 ` [PATCH b4 v2 44/44] tests: cover the branch delete leaving the worktree on a branch Christian Brauner
2026-08-03 14:59 ` [PATCH b4 v2 00/44] Stop the editor branch guard from eating review replies Konstantin Ryabitsev
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260731-work-b4-editor-branch-guard-v2-17-243fd19d322d@kernel.org \
--to=brauner@kernel.org \
--cc=konstantin@linuxfoundation.org \
--cc=tools@kernel.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox