aboutsummaryrefslogtreecommitdiff
path: root/org-maint.el
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2022-12-10 02:08:38 -0500
committerKyle Meyer <kyle@kyleam.com>2022-12-10 02:17:02 -0500
commit448a7ff51312d26c1ea9e76385c7e352d9ec12a0 (patch)
treea6ab33e822bbce2d88c72064c29f4ee63982cb7e /org-maint.el
parent09e3b593d3f8c257172420e595e590f7b07ba0b0 (diff)
downloadorgmode-backport-notes-448a7ff51312d26c1ea9e76385c7e352d9ec12a0.tar.gz
org-maint-check-for-new: Rewrite docstring
Diffstat (limited to 'org-maint.el')
-rw-r--r--org-maint.el9
1 files changed, 5 insertions, 4 deletions
diff --git a/org-maint.el b/org-maint.el
index fe411fe..af1f7a1 100644
--- a/org-maint.el
+++ b/org-maint.el
@@ -64,10 +64,11 @@ If APPLY is non-nil, use 'git apply' instead of 'git am'."
(user-error "Next revision item not found"))))
(defun org-maint-check-for-new ()
- "Check for new commits to backport.
-The last commit found is assumed to be the return value of
-`org-maint-rev-from-next-item', and Emacs ref name that should be
-checked is taken from the Org \"ref\" property."
+ "Check for new commits in the Emacs repository to port.
+Determine \"new\" commits by looking for commits that 1) touch
+Org files, 2) are contained in the Emacs reference specified by
+the Org \"ref\" property, and 3) are _not_ included in the
+revision returned by `org-maint-rev-from-next-item'."
(interactive)
(let ((ref (or (org-entry-get (point) "ref")
(user-error "No reference found")))