[PATCH 0/3] manual: Point to range-diff and related projects

[PATCH 0/3] manual: Point to range-diff and related projects

[Kyle Meyer]

Increase the odds that someone who stumbles across the piem manual
discovers something useful...

  [1/3] manual: contributing: Remove some unnecessary bits
  [2/3] manual: contributing: Mention range-diff
  [3/3] manual: Add a "Related projects and tools" section

 piem.texi | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 57 insertions(+), 5 deletions(-)


base-commit: 0a3de9e528c010e3f8ff113eaca28f10ad0528ca
-- 
2.30.0

[PATCH 1/3] manual: contributing: Remove some unnecessary bits

[Kyle Meyer]

Cut off part of a sentence that adds no additional information, and
discard a footnote.
---
 piem.texi | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/piem.texi b/piem.texi
index 070adf4..ecd17e6 100644
--- a/piem.texi
+++ b/piem.texi
@@ -449,11 +449,9 @@ Contributing
 plain-text email to @email{piem@@inbox.kyleam.com}.  Messages that
 include this address are public and available as public-inbox archives
 at @url{https://inbox.kyleam.com/piem}.  Note that this is not a mailing
-list, and there are no subcribers.  Updates can be followed through one
-of public-inbox's pull methods (@pxref{public-inbox}).  This means it is
-particularly important to @emph{not} drop participants when replying
-@footnote{@dots{} and in this author's opinion, doing so is a bad
-practice anyway.}.
+list.  Updates can be followed through one of public-inbox's pull
+methods (@pxref{public-inbox}).  This means it is particularly important
+to @emph{not} drop participants when replying.
 
 You can, unsurprisingly, use piem to work on piem by adding an entry
 like this to @code{piem-inboxes}.
-- 
2.30.0

[PATCH 2/3] manual: contributing: Mention range-diff

[Kyle Meyer]

---
 piem.texi | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/piem.texi b/piem.texi
index ecd17e6..bb5c684 100644
--- a/piem.texi
+++ b/piem.texi
@@ -483,6 +483,13 @@ Contributing
 In general, prefer to keep iterations of a patch series in the same
 thread, labeling rerolls with an appropriate version.
 
+@item Consider adding a range-diff to the cover letter of rerolls.
+
+For a multi-patch series, @code{git range-diff} can often provide a nice
+overview of the changes between the previous and last iteration.  Note
+that @code{git format-patch} has a @code{--range-diff} convenience
+option.
+
 @end itemize
 
 \f
-- 
2.30.0

[PATCH 3/3] manual: Add a "Related projects and tools" section

[Kyle Meyer]

---
 piem.texi | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/piem.texi b/piem.texi
index bb5c684..e7b4b32 100644
--- a/piem.texi
+++ b/piem.texi
@@ -50,6 +50,7 @@ Top
 * Applying patches::
 * Injecting messages into a Maildir directory::
 * Contributing::
+* Related projects and tools::
 
 Appendices
 * GNU Free Documentation License::  The license for this documentation.
@@ -492,6 +493,52 @@ Contributing
 
 @end itemize
 
+\f
+@node Related projects and tools
+@chapter Related projects and tools
+
+Here's a (short and incomplete) list of tools that you, as someone that
+cared to look at piem's manual, may be interested in---things that
+either have some connection to public-inbox or to using an email-based
+development workflow in Emacs.  Corrections and additions are welcome.
+
+@itemize
+
+@item
+git-email provides an Emacs interface for preparing and sending patches.
+
+@url{https://sr.ht/~yoctocell/git-email/}
+
+@cindex magit
+@item
+@code{git range-diff} is a built-in Git command for comparing iterations
+of a patch series.  If you use Magit, the
+@url{https://github.com/magit/magit-tbdiff,magit-tbdiff} extension
+provides an interface for @code{git range-diff}.
+
+@url{https://kernel.org/pub/software/scm/git/docs/git-range-diff.html}
+
+@item
+grokmirror enables efficient replication of large Git repository
+collections.  The HTTP interface for public-inbox exposes a
+grokmirror-compatible manifest.js.gz endpoint.
+
+@url{https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git}
+
+@cindex mailscripts
+@item
+mailscripts, mentioned earlier in the manual (@pxref{Applying patches
+without a public-inbox archive}), is a ``collection of scripts for
+manipulating e-mail on Debian'', including b4-inspired patch extraction
+and an Emacs interface for some of the functionality.
+
+@url{https://git.spwhitton.name/mailscripts/}
+
+@end itemize
+
+A list of more public-inbox-related tools is at
+@url{https://public-inbox.org/clients.txt}.
+
 \f
 @node GNU Free Documentation License
 @chapter GNU Free Documentation License
-- 
2.30.0