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

commit 7897796e5d0450d869d899b7e272be10d3a7ccfc
parent c47dfc73eea5d8c26ceffa52053c59a46db23c64
Author: Pi Agent <agent@pi.local>
Date:   Sat, 18 Jul 2026 15:38:23 +0200

docs: clarify the native host install is optional

The README/man page listed the native host as step 1, which read as
if you must run it before installing the extension from the Add-ons
Manager. Reorder so the extension steps come first and the native host
is step 3 (optional): detection, the review tab, commenting, and Send
review work with the extension alone; the host is only needed for Apply
(git am), the Browse... repo chooser, and Open editor after an apply.

Diffstat:
M
README
 | 
28
++++++++++++++++++----------
M
patch-review.1
 | 
50
+++++++++++++++++++++++++++++++++++---------------

2 files changed, 53 insertions(+), 25 deletions(-)
diff --git a/README b/README
@@ -36,18 +36,20 @@ DESCRIPTION
        patchset -- save the raw series as one mbox file, ready for git am.
 
 INSTALLATION
-       1. Native host
-	      Run host/install-host.sh once.  It installs the native messaging
-	      manifest into the per-user Mozilla and Thunderbird locations.
-	      The host itself is strict POSIX sh(1) and needs only POSIX
-	      utilities plus git(1).
-
-       2. Extension (temporary, for development)
+       The extension is what you install from the Add-ons Manager; the
+       native host is separate and optional.  Detection, the review tab,
+       commenting, and Send review work with the extension alone.  The
+       native host is needed only for Apply (git am), the Browse... repo
+       chooser, and Open editor after an apply.  Install both if you want
+       those features.
+
+       1. Extension (temporary, for development)
 	      In Thunderbird open Tools -> Developer Tools -> Debug Add-ons,
 	      choose Load Temporary Add-on..., and pick
-	      extension/manifest.json.
+	      extension/manifest.json.  The add-on is dropped on restart,
+	      so use step 2 for a permanent install.
 
-       3. Extension (permanent)
+       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
@@ -59,7 +61,13 @@ INSTALLATION
 	      archive holds manifest.json at its root, not under
 	      extension/.
 
-       Restart Thunderbird after installing the host so it is picked up.
+       3. Native host (optional)
+	      Run host/install-host.sh once to install the native messaging
+	      manifest into the per-user Mozilla and Thunderbird locations.
+	      The host itself is strict POSIX sh(1) and needs only POSIX
+	      utilities plus git(1).  Restart Thunderbird afterward so it is
+	      picked up.  Without it, Apply / Browse... / Open editor report
+	      that the host is unreachable; everything else still works.
 
 CONFIGURATION
        Open the extension's preferences:
diff --git a/patch-review.1 b/patch-review.1
@@ -50,27 +50,31 @@ Its drop-down offers
 \(em save the raw series as one mbox file, ready for
 .BR "git am" .
 .SH INSTALLATION
+The extension is what you install from the Add-ons Manager; the native
+host is separate and optional.
+Detection, the review tab, commenting, and
+.B "Send review"
+work with the extension alone.
+The native host is needed only for
+.B Apply
+.RB ( git am ),
+the
+.I "Browse..."
+repo chooser, and
+.IR "Open editor " after an apply.
+Install both if you want those features.
 .TP
-1. Native host
-Run
-.B host/install\-host.sh
-once.
-It installs the native messaging manifest into the per-user Mozilla and
-Thunderbird locations.
-The host itself is strict POSIX
-.BR sh (1)
-and needs only POSIX utilities plus
-.BR git (1).
-.TP
-2. Extension (temporary, for development)
+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
-3. Extension (permanent)
+2. Extension (permanent)
 Zip the
 .I extension/
 directory with manifest.json at the archive root, then install the
@@ -91,8 +95,24 @@ so the archive holds
 .B manifest.json
 at its root, not under
 .IR extension/ .
-.PP
-Restart Thunderbird after installing the host so it is picked up.
+.TP
+3. Native host (optional)
+Run
+.B host/install\-host.sh
+once to install the native messaging manifest into the per-user Mozilla
+and Thunderbird locations.
+The host itself is strict POSIX
+.BR sh (1)
+and needs only POSIX utilities plus
+.BR git (1).
+Restart Thunderbird afterward so it is picked up.
+Without it,
+.BR Apply ,
+.IR "Browse..." ,
+and
+.I "Open editor"
+report that the host is unreachable;
+everything else still works.
 .SH CONFIGURATION
 Open the extension's preferences:
 .TP