aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryoctocell <public@yoctocell.xyz>2021-01-03 20:37:59 +0100
committeryoctocell <public@yoctocell.xyz>2021-01-03 20:37:59 +0100
commit7921d1d60a801e81f3428adc2b860b3184e0bc2f (patch)
tree3c3a6201d80b4ea737f8c28f141519badab88c9c
parent272eca1d2e5c3b33d619d3feeddd3e049f7be16a (diff)
Add commentary
-rw-r--r--git-email.el10
1 files changed, 10 insertions, 0 deletions
diff --git a/git-email.el b/git-email.el
index 152b113..703a3f6 100644
--- a/git-email.el
+++ b/git-email.el
@@ -24,6 +24,16 @@
;;; Commentary:
+;; This package integrates with git and email and offers two main functions
+;; - `git-email-send-email' and `git-email-apply-patch'.
+;;
+;; `git-email-send-email' sends an email based on a patch file generated by
+;; 'git format-patch'. It inserts the relevant headers and the diff into the
+;; message buffer.
+;;
+;; `git-email-apply-patch' will apply the patch that you are currently viewing
+;; and it will ask to for the project that the patch belongs to.
+
;;; Code:
(defgroup git-email nil