Add some docs for update-projects

jaraco · May 28, 2023 · 2cc08e0 · 2cc08e0
1 parent 655c547
commit 2cc08e0
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/jaraco/develop/update-projects.py b/jaraco/develop/update-projects.py
@@ -1,3 +1,14 @@
+"""
+Mechanized merging of an upstream repo across all projects.
+
+Relies on 'known-merge' tool, which must be configured with
+git thus:
+
+[mergetool "known-merge"]
+cmd = py -m jaraco.develop.merge "$BASE" "$LOCAL" "$REMOTE" "$MERGED"
+trustExitCode = true
+"""
+
 import contextlib
 import subprocess
 import functools