about summary refs log tree commit diff
path: root/src/inc
diff options
context:
space:
mode:
Diffstat (limited to 'src/inc')
-rw-r--r--src/inc/index.htm1
-rw-r--r--src/inc/pyonji.htm25
-rw-r--r--src/inc/pyonji.md26
3 files changed, 52 insertions, 0 deletions
diff --git a/src/inc/index.htm b/src/inc/index.htm
index 470c232..8c35e24 100644
--- a/src/inc/index.htm
+++ b/src/inc/index.htm
@@ -12,6 +12,7 @@
 <li><a href="/site/kamakura.html">kamakura</a></li>
 <li><a href="/site/niigata.html">niigata</a></li>
 <li><a href="/site/nikko.html">nikko</a></li>
+<li><a href="/site/pyonji.html">pyonji</a></li>
 <li><a href="/site/shikoku.html">shikoku</a></li>
 <li><a href="/site/toyama.html">toyama</a></li>
 <li><a href="/site/yamanashi.html">yamanashi</a></li>
diff --git a/src/inc/pyonji.htm b/src/inc/pyonji.htm
new file mode 100644
index 0000000..8bfb2fa
--- /dev/null
+++ b/src/inc/pyonji.htm
@@ -0,0 +1,25 @@
+<!-- Generated file, you may edit and discard src/inc/pyonji.md :) -->
+<span class="date">
+2025-01-08
+</span>
+<p><a href="https://git.sr.ht/~emersion/pyonji">pyonji</a> is a useful
+tool to send patches to mailing lists, to contribute to projects hosted
+on <a href="https://sr.ht/projects">sr.ht</a> for example. It is a
+friendly TUI alternative to using <code>git-send-email</code> directly,
+but there are still some essentials to note:</p>
+<ol type="1">
+<li><p>ensure th <a
+href="https://git-scm.com/docs/git-config/2.22.1#Documentation/git-config.txt-formatsubjectPrefix">to
+address</a> is set (or pass <code>--to</code>)<br />
+<code>git config --local sendemail.to</code></p></li>
+<li><p>use <code>origin/master</code> or <code>HEAD~n</code> for the
+<code>--base</code> option, this determines what is included in the
+patch series</p></li>
+<li><p>when sending to a public-inbox style list, ensure the <a
+href="https://git-scm.com/docs/git-config/2.22.1#Documentation/git-config.txt-formatsubjectPrefix">subject
+prefix</a> is set<br />
+<code>git config --local format.subjectprefix</code></p></li>
+<li><p>when writing the cover letter, note that the first paragraph is
+parsed as the subject of the patch series, see <a
+href="https://git-scm.com/docs/git-format-patch#Documentation/git-format-patch.txt---cover-from-descriptionltmodegt">–cover-from-description</a></p></li>
+</ol>
diff --git a/src/inc/pyonji.md b/src/inc/pyonji.md
new file mode 100644
index 0000000..8f55983
--- /dev/null
+++ b/src/inc/pyonji.md
@@ -0,0 +1,26 @@
+---
+date: 2025-01-08
+---
+
+[pyonji] is a useful tool to send patches to mailing lists, to contribute to
+projects hosted on [sr.ht] for example. It is a friendly TUI alternative to
+using `git-send-email` directly, but there are still some essentials to note:
+
+1. ensure th [to address] is set (or pass `--to`)   
+   `git config --local sendemail.to`
+
+2. use `origin/master` or `HEAD~n` for the `--base` option, this determines what 
+   is included in the patch series
+
+3. when sending to a public-inbox style list, ensure the [subject prefix] is set  
+   `git config --local format.subjectprefix`
+
+4. when writing the cover letter, note that the first paragraph is parsed as the
+   subject of the patch series, see [--cover-from-description]
+
+
+[pyonji]: https://git.sr.ht/~emersion/pyonji
+[sr.ht]: https://sr.ht/projects
+[to address]: https://git-scm.com/docs/git-config/2.22.1#Documentation/git-config.txt-formatsubjectPrefix
+[subject prefix]: https://git-scm.com/docs/git-config/2.22.1#Documentation/git-config.txt-formatsubjectPrefix
+[--cover-from-description]: https://git-scm.com/docs/git-format-patch#Documentation/git-format-patch.txt---cover-from-descriptionltmodegt