aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2020-11-09 20:31:30 -0500
committerKyle Meyer <kyle@kyleam.com>2020-11-09 20:50:32 -0500
commitdfd4cc5c6b27969922c15a812b29a9a45d0a5711 (patch)
treebddddc45981cb6e3218fc00dbe233937748c159b
parent46e09f957fbad8a772286c3e799156202422e093 (diff)
downloadorgmode-backport-notes-dfd4cc5c6b27969922c15a812b29a9a45d0a5711.tar.gz
orgmode-backports.org: Rework information about commands
When this text was originally written, the commands in org-maint.el didn't exist. Now that they do, just point to them.
-rw-r--r--orgmode-backports.org23
1 files changed, 14 insertions, 9 deletions
diff --git a/orgmode-backports.org b/orgmode-backports.org
index a10a762..a38f51c 100644
--- a/orgmode-backports.org
+++ b/orgmode-backports.org
@@ -14,33 +14,38 @@ format
author
author date
+The ~org-maint-insert-emacs-commit-info~ command in org-maint.el can
+be used to insert the original commit message plus the above block of
+information.
+
Note that, as [[https://orgmode.org/list/87d19h8sr5.fsf@kyleam.com][discussed on the list]], "backport" isn't really the best
term for this, but it probably makes sense to continue using it in the
commit messages at this point.
* Commands
-** Format patch
+org-maint.el defines the following commands
-: git format-patch -oorg-patches <commit>^..<commit> -- lisp/org
+- ~org-maint-check-for-new~
-** Apply in Org repo with
+ Check for new commits from Emacs to port to the Org repo.
-: git apply -p3 --directory=lisp/ <patch>
+ This should be called with point at the top of a subheading of
+ "Backport list" (e.g., the [[*master branch][master branch]] heading).
-~git am~ can be used with the same arguments.
+- ~org-maint-apply-emacs-commit~
-** Format for commit information
+ Apply an Emacs commit to the Org repo.
-: git show -s --format="%H%n%s%n%an%n%cd" <commit>
+- ~org-maint-insert-emacs-commit-info~
** Applying failed patch
-When 'git am' fails, the patch can be partially applied with
+When ~git am~ fails, the patch can be partially applied with
: git apply --directory=lisp/ --reject -p3 .git/rebase-apply/0001
-and then after resolving run
+After resolving the conflict, run
: git am --continue