thunderbird-patch-review
Easy-to-use patch review interface for Thunderbird
Contribute: ~marcc/thunderbird-review-plugin@lists.sr.ht
git clone git://mccd.space/thunderbird-patch-review
| Log | Files | Refs | README | LICENSE |
commit b74938caa712b4665d2f3479481c0c0ff3e7f079 parent 3d9a1dfa357025f749fb06649ae62622c7db211b Author: Pi Agent <agent@pi.local> Date: Sat, 18 Jul 2026 17:33:06 +0200 docs: trim the INSTALLATION section to just the install steps Replace the explanatory prose and the numbered temporary/permanent steps with a brief paragraph: package the .xpi, install it from file; note that git(1) is a dependency (for Apply), and the Load Temporary Add-on path for development. Mirrored in README and patch-review.1. Diffstat:
| M | README | | | 41 | ++++++++++++++--------------------------- |
| M | patch-review.1 | | | 43 | ++++++++++--------------------------------- |
2 files changed, 24 insertions(+), 60 deletions(-)
diff --git a/README b/README
@@ -11,7 +11,7 @@ SYNOPSIS
DESCRIPTION
patch-review brings a review interface to git-by-email workflows
(git-send-email(1) style). When the selected messages (or thread) look
- like a patch — a [PATCH] subject tag or a unified diff in the body —
+ like a patch -- a [PATCH] subject tag or a unified diff in the body --
the Review button in the main toolbar becomes active. It opens a
dedicated review tab that shows the whole series: cover letter, per-
patch commit messages, and every file and hunk rendered as a colored
@@ -31,34 +31,21 @@ DESCRIPTION
nothing is lost. Apply series runs git am --3way on the raw patch
messages in the configured repository. On conflict git am --abort is
run and its output reported, leaving the repository untouched. Its
- drop-down offers Modify and apply — apply, then open the touched files
- in your editor — and Download patchset — save the raw series as one
+ drop-down offers Modify and apply -- apply, then open the touched files
+ in your editor -- and Download patchset -- save the raw series as one
mbox file, ready for git am.
INSTALLATION
- Everything ships inside the extension: install it and you are done.
- Apply (git am), the Browse... repo chooser, and Open editor are
- implemented by a small privileged part bundled with the add-on (a
- WebExtension Experiment under extension/api/patchHost/), which is why
- the Add-ons Manager warns that the add-on has full access to
- Thunderbird. Those three features need git(1) in $PATH; nothing else
- has an external dependency.
-
- 1. Extension (temporary, for development)
- In Thunderbird open Tools → Developer Tools → Debug Add-ons,
- choose Load Temporary Add-on..., and pick
- extension/manifest.json. The add-on is dropped on restart, so
- use step 2 for a permanent install.
-
- 2. Extension (permanent)
- Zip the extension/ directory with manifest.json at the archive
- root, then install the .xpi from the Add-ons Manager gear menu
- (Install Add-on From File...). From the project root:
+ Package the extension as an .xpi and install it via the Add-ons Manager
+ gear menu (Install Add-on From File...). From the project root:
(cd extension && zip -qrX ../patch-review.xpi .)
The subshell runs the zip(1) from inside extension/ so the archive
- holds manifest.json at its root, not under extension/.
+ holds manifest.json at its root, not under extension/. git(1) is a
+ dependency (for Apply). For development, instead pick Tools ->
+ Developer Tools -> Debug Add-ons -> Load Temporary Add-on..., and
+ select extension/manifest.json; it is dropped on restart.
CONFIGURATION
Open the extension's preferences:
@@ -122,12 +109,12 @@ SOURCEHUT INTEGRATION
When enabled, the first reply of the review carries an
X-Sourcehut-Patchset-Update header with the chosen status, which
sourcehut applies to the patchset. A status can also be sent without
- any line comments — Send review then sends a single, empty reply to the
- cover letter (or first patch) carrying just the header.
+ any line comments -- Send review then sends a single, empty reply to
+ the cover letter (or first patch) carrying just the header.
REVIEW WORKFLOW
- 1. Select any message of the series — or the whole
- thread — and press Review in the main toolbar.
+ 1. Select any message of the series -- or the whole
+ thread -- and press Review in the main toolbar.
2. The tab collects the sibling patches from the same folder
(same series tag, version, and patch count).
3. Click lines, write comments; Ctrl+Enter saves.
@@ -163,7 +150,7 @@ SEE ALSO
<https://mccd.space/posts/26-07-18/3-patch-review-tool-for-thunderbird>
CONTRIBUTING
- Disclaimer: this plugin was vibe coded — written by an AI agent under
+ Disclaimer: this plugin was vibe coded -- written by an AI agent under
human direction.
Contributions and bug reports go to the mailing list:
diff --git a/patch-review.1 b/patch-review.1
@@ -50,40 +50,9 @@ Its drop-down offers
\(em save the raw series as one mbox file, ready for
.BR "git am" .
.SH INSTALLATION
-Everything ships inside the extension: install it and you are done.
-.B Apply
-.RB ( "git am" ),
-the
-.I "Browse..."
-repo chooser, and
-.I "Open editor"
-are implemented by a small privileged part bundled with the add-on (a
-WebExtension Experiment under
-.IR extension/api/patchHost/ ),
-which is why the Add-ons Manager warns that the add-on has full access to
-Thunderbird.
-Those three features need
-.BR git (1)
-in
-.BR $PATH ;
-nothing else has an external dependency.
-.TP
-1. Extension (temporary, for development)
-In Thunderbird open
-.IR "Tools \(-> Developer Tools \(-> Debug Add\-ons" ,
-choose
-.IR "Load Temporary Add\-on\|.\|.\|." ,
-and pick
-.BR extension/manifest.json .
-The add-on is dropped on restart,
-so use step 2 for a permanent install.
-.TP
-2. Extension (permanent)
-Zip the
-.I extension/
-directory with manifest.json at the archive root, then install the
+Package the extension as an
.B .xpi
-from the Add-ons Manager gear menu
+and install it via the Add-ons Manager gear menu
.RB ( "Install Add-on From File..." ).
From the project root:
.RS
@@ -99,6 +68,14 @@ so the archive holds
.B manifest.json
at its root, not under
.IR extension/ .
+.BR git (1)
+is a dependency (for
+.BR Apply ).
+For development, instead pick
+.IR "Tools \(-> Developer Tools \(-> Debug Add\-ons \(-> Load Temporary Add\-on..." ,
+and select
+.BR extension/manifest.json ;
+it is dropped on restart.
.SH CONFIGURATION
Open the extension's preferences:
.TP