branch: elpa/magit
commit 07b561648da12061be70d1800b7b1cf00cc5c16b
Author: Jonas Bernoulli <[email protected]>
Commit: Jonas Bernoulli <[email protected]>
magit-log-heading-re: Improve comments
In particular mention that we intentionally keep a fix related to a
Git release we no longer support, so I don't have to think about this
every time I look for obsolete kludges.
---
lisp/magit-log.el | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/lisp/magit-log.el b/lisp/magit-log.el
index 6247ee53577..3e5b4fc9af2 100644
--- a/lisp/magit-log.el
+++ b/lisp/magit-log.el
@@ -1313,17 +1313,18 @@ Do not add this to a hook variable."
:parent magit-commit-section-map)
(defconst magit-log-heading-re
- ;; Note: A form feed instead of a null byte is used as the delimiter
- ;; because using the latter interferes with the graph prefix when
- ;; ++header is used.
+ ;; Use a form feed instead of a null byte as the delimiter because using
+ ;; the latter interferes with the graph prefix when ++header is used.
(concat "^"
"\\(?4:[-_/|\\*o<>. ]*\\)" ; graph
"\\(?1:[0-9a-fA-F]+\\)? " ; hash
"\\(?3:[^ \n]+\\)? " ; refs
"\\(?7:[BGUXYREN]\\)? " ; gpg
"\\(?5:[^ \n]*\\) " ; author
- ;; Note: Date is optional because, prior to Git v2.19.0,
- ;; `git rebase -i --root` corrupts the root's author date.
+ ;; Prior to Git v2.19.0, "git rebase -i --root" corrupted the
+ ;; root's author date. Keep date optional because even though
+ ;; we no longer support such old releases, the roots they create
+ ;; may live on.
"\\(?6:[^ \n]*\\) " ; date
"\\(?12:[^ \n]+\\)? " ; trailers
"\\(?2:.*\\)$")) ; msg
