GNU logs - #64055, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#64055: [WIP Patch] Enable editing commit messages - vc-git-modify-change-comment
Resent-From: Morgan Smith <Morgan.J.Smith@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Tue, 13 Jun 2023 23:05:02 +0000
Resent-Message-ID: <handler.64055.B.16866974842385 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 64055 <at> debbugs.gnu.org
From: Morgan Smith <Morgan.J.Smith@HIDDEN>
Date: Tue, 13 Jun 2023 18:59:24 -0400
Message-ID: <DM5PR03MB3163ADD665E6B3B1D8704A2AC555A@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
Content-Type: multipart/mixed; boundary="=-=-="
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: DM5PR03MB3163:EE_|PH7PR03MB7338:EE_
X-MS-Office365-Filtering-Correlation-Id: 9ac522d1-36ec-4750-427f-08db6c61d7ea
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: IIMBKzrS3TggR51pda9yMrucS6Lgjq+eTKgMnMYbBLZMhugw5vi+6BabSJSyzy+x9VjKNfFzlmkjWXMXIsVHwRipc8hVe0rpzP2tcfhP17NRdwBybG9wKNfSr1oqvuv8W4rWkhq7gaB4SfmrUsQy5j0J7u3LJC8lzGQER1uMEav7wgflEZbdkY1ukLGYYOvs8Tq/Q+xxNn+IAUAa0XZsYxO0fkqdT6pvlJXx2AJ22KszNg3UUnskG+izJDNbj2D0nTq/xGk4XsDa25Uog5krpMOGZYQH0xUmH0OBsEo5TzR31XVyfQRsgsuo5uAMbZCR
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: scnczk9JdRp2kAQyAQEFHeRem8GbLkyo2OkJwyTNpvmIwUPLnHnhhXgsdts3/gVhiTmEQF/bJ05XZgmwkbfWf8x/NxUHz3FbrAzSjk8Q26H6JhAcZxDbErR/qM5jJIKL13PhVYFuTZFNDAYpg0yPF451lkRr545EAWxhH0K2Bop7yfepLOCH+CeqrRJ7/3aca6BCgEmrSH8uZQBJ0sMc4bc24FzF853lXQqBQ1Wrjjp3JA6q3JA+wioyHSr4654Of5db7F9A0Q2Sa9urmTOCiUxYpplIpaDSDEzl/NxE0X8OFdH1z5TLEYFC4fqlNpg6lUV4cCSmXRbxz9qQrjw3cLKjXa57FtVrxtw4ND0Ha04TQxiGHMOVQoYldLrVbkzAdUL+p9NniVAXE6ou+Bm3etwISRSQQl2REpvGPV+y+frLOX/6Sg9JdFB4+YfXisvM+K+wWGIYOaiRGr/ePgnVN698UuhPkeWBWjKHUWkU99SUvCRjTiRbjF8OjVml6w6yKVaAhtF6666LJ7SmGOcwAxjxRgaaTx8xf72BS47lfckO78DHlK11PCmiXVZcV7qfigaJtmha0if0fr/4NiKFS988P3uaFJINLbQfknuMfhIitQ2xg8rpzrCikXL4tXzfN4t0rw59Y5k0wmQQkGa5AwFjKeCARb2SzacKJv0gjwZmylVWT3j+ZNKcpoI6vop4Ap6XkDm211FnqD6jbNj/6jQyWNdpY/bp3N/ZLgT+s18yJbGtxx+byxP8e3KLORxJAtTApT4TyfnJ/o9tNuIiL/gg/m/l4udOXyUAgezGRxxCNsSlqcRJEIsj3vqZJcHpjrz7uQ/uMtWH1SZmh8haX+Bj0u7J9OrxcxCg3dOJ6ODKbCxeZMBChDP4GKM30DYcBwFMu3Y6X8kPRett+hnqop76B1eZbdnnWpf+yImn3EA50TEuupZFvAfA9lQTThG75QiHblr3OmgxlowYNNPhR60eWoDINwAoi+yzpkPHKSGOdZenDtTAMlcfCn3Hkb21YLKbDyt+jkAkiNpEbM0WeARtU7b8n3U6mnHkXO/KyXlzp2DFNNvtzYt8G2ZUfmaryqdypBuaFZBDPINHKHT1GS8dWeV8Zl1Y0yx6HFVp43VskpPFEyjtxOHJSwBnxp9+vzkouhOeZ1px1iaYDdJfa/zD8/JcZ371MCNNPeGgP2l2HE7q1WYUXOn2NpwY1P7Bw5n9V7EXjPmYGmCHGyauFzneK67LFc99COs/4Cwq2ME=
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9ac522d1-36ec-4750-427f-08db6c61d7ea
X-MS-Exchange-CrossTenant-AuthSource: DM5PR03MB3163.namprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Jun 2023 22:59:29.8404 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR03MB7338
Received-SPF: pass client-ip=2a01:111:f400:7eaa::819;
 envelope-from=Morgan.J.Smith@HIDDEN;
 helo=NAM11-DM6-obe.outbound.protection.outlook.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001,
 SPF_HELO_PASS=-0.001, SPF_PASS=-0.001,
 T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -1.3 (-)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.3 (--)

--=-=-=
Content-Type: text/plain

Hello!


--=-=-=
Content-Type: text/x-patch
Content-Disposition: attachment;
 filename=0001-enable-editing-log-comments.patch

From dfff1a074dbcc244a1d6b40694b559c12c331a8f Mon Sep 17 00:00:00 2001
From: Morgan Smith <Morgan.J.Smith@HIDDEN>
Date: Tue, 13 Jun 2023 18:33:56 -0400
Subject: [PATCH] enable editing log comments

---
 lisp/vc/log-view.el      | 11 ++++++++---
 lisp/vc/vc-dispatcher.el |  4 +++-
 lisp/vc/vc-git.el        | 26 +++++++++++++++++++++++++-
 lisp/vc/vc.el            | 10 ----------
 4 files changed, 36 insertions(+), 15 deletions(-)

diff --git a/lisp/vc/log-view.el b/lisp/vc/log-view.el
index e6eb6a5b973..86911eeb02c 100644
--- a/lisp/vc/log-view.el
+++ b/lisp/vc/log-view.el
@@ -522,9 +522,11 @@ log-view-find-revision
 (defun log-view-extract-comment ()
   "Parse comment from around the current point in the log."
   (save-excursion
-    (let (st en (backend (vc-backend (log-view-current-file))))
+    (let (st en (backend log-view-vc-backend))
+      (unless (get-text-property (car (log-view-current-entry)) 'log-view-entry-expanded)
+        (log-view-toggle-entry-display))
       (log-view-end-of-defun)
-      (cond ((eq backend 'SVN)
+      (cond ((memq backend '(SVN Git))
 	     (forward-line -1)))
       (setq en (point))
       (or (log-view-current-entry nil t)
@@ -533,7 +535,10 @@ log-view-extract-comment
 	     (forward-line 2))
 	    ((eq backend 'Hg)
 	     (forward-line 4)
-	     (re-search-forward "summary: *" nil t)))
+	     (re-search-forward "summary: *" nil t))
+            ((eq backend 'Git)
+             (re-search-forward "^$" nil t)
+             (forward-line 1)))
       (setq st (point))
       (buffer-substring st en))))
 
diff --git a/lisp/vc/vc-dispatcher.el b/lisp/vc/vc-dispatcher.el
index fd5f655a0f6..4351a71977e 100644
--- a/lisp/vc/vc-dispatcher.el
+++ b/lisp/vc/vc-dispatcher.el
@@ -827,7 +827,9 @@ vc-dispatcher-browsing
   "Are we in a directory browser buffer?"
   (or (derived-mode-p 'vc-dir-mode)
       (derived-mode-p 'dired-mode)
-      (derived-mode-p 'diff-mode)))
+      (derived-mode-p 'diff-mode)
+      (derived-mode-p 'log-view-mode)
+      ))
 
 ;; These are unused.
 ;; (defun vc-dispatcher-in-fileset-p (fileset)
diff --git a/lisp/vc/vc-git.el b/lisp/vc/vc-git.el
index a3469b71386..18d6f1f47dc 100644
--- a/lisp/vc/vc-git.el
+++ b/lisp/vc/vc-git.el
@@ -1384,6 +1384,24 @@ vc-git-clone
     (vc-git--out-ok "clone" remote directory))
   directory)
 
+(defun vc-git-modify-change-comment (_files rev comment)
+  "Modify the change comments on REV to COMMENT."
+  ;; This is very similar to using to "git commit --fixup=amend"
+  ;; command but it is more precise as it does the rebase matching
+  ;; with the hash instead of the subject line.  Also we can't use
+  ;; --fixup non-interactively (it doesn't support -m or -F) so this
+  ;; is much easier.
+  (vc-git-command nil 0 nil "commit"
+                  "--allow-empty"
+                  "-m" (concat "amend! " rev "\n\n" comment))
+  ;; We should really be able to do this "non-interactively" but we
+  ;; can't so we set GIT_SEQUENCE_EDITOR
+  (let ((process-environment
+         (cons
+          "GIT_SEQUENCE_EDITOR=:"
+          process-environment)))
+    (vc-git-command nil 0 nil "rebase" "--autosquash" "-i" (concat rev "~1"))))
+
 ;;; HISTORY FUNCTIONS
 
 (autoload 'vc-setup-buffer "vc-dispatcher")
@@ -1576,7 +1594,13 @@ vc-git-expanded-log-entry
     (apply #'vc-git-command t nil nil
            `("log"
              ,revision
-             "-1"  "--no-color" ,@(ensure-list vc-git-log-switches)
+             "-1"  "--no-color"
+             ;; The same as the default "medium" format but it doesn't
+             ;; put spaces at the beginning of the body.  This is so
+             ;; we can grab this as the initial value when calling
+             ;; log-view-modify-change-comment
+             "--pretty=format:commit %H%nAuthor: %an %ae%nDate:   %ad%n%n%B"
+             ,@(ensure-list vc-git-log-switches)
              "--"))
     (goto-char (point-min))
     (unless (eobp)
diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index a93d85caedb..92a0ef74d56 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -699,16 +699,6 @@
 ;; - The git backend supports amending, but in a different
 ;;   way (press `C-c C-e' in log-edit buffer, when making a new commit).
 ;;
-;; - Second, `log-view-modify-change-comment' doesn't seem to support
-;;   modern backends at all because `log-view-extract-comment'
-;;   unconditionally calls `log-view-current-file'.  This should be easy to
-;;   fix.
-;;
-;; - Third, doing message editing in log-view might be a natural way to go
-;;   about it, but editing any but the last commit (and even it, if it's
-;;   been pushed) is a dangerous operation in Git, which we shouldn't make
-;;   too easy for users to perform.
-;;
 ;;   There should be a check that the given comment is not reachable
 ;;   from any of the "remote" refs?
 ;;
-- 
2.40.1


--=-=-=
Content-Type: text/plain


Please look at this patch.  Ignore the bad commit message for now, I'm
trying to figure out how to edit that :P.

I've spent far too long looking at git documentation and source code.  I
think this is the best way to enable this feature.  In fact I really
don't think there is another way to implement this feature that doesn't
rely on the "autosquash" git feature.

I found the hack located in vc-git-modify-change-comment' of setting
"GIT_SEQUENCE_EDITOR=:" on the internet and I don't understand how it
works.

Also I'm not really sure what the 'vc-dispatcher-browsing' function is
supposed to do but it's getting in my way.  Like are 'diff-mode' buffers
a "directory browser buffer"?  I don't understand the intent here.

Also you'll noticed I deleted some comments in vc.el.  That's mainly to
highlight them so we can talk about them now.  Is there a good way to
stop users from editing remote commits?


I feel like I should probably just keep working on this and get it more
polished and answer some of my own questions before posting here but I'm
getting kind of frustrated with this.  I am many hours deep into this
problem.

Thanks,

Morgan

--=-=-=--

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Morgan Smith <Morgan.J.Smith@HIDDEN>
Subject: bug#64055: Acknowledgement ([WIP Patch] Enable editing commit
 messages - vc-git-modify-change-comment)
Message-ID: <handler.64055.B.16866974842385.ack <at> debbugs.gnu.org>
References: <DM5PR03MB3163ADD665E6B3B1D8704A2AC555A@HIDDEN>
X-Gnu-PR-Message: ack 64055
X-Gnu-PR-Package: emacs
X-Gnu-PR-Keywords: patch
Reply-To: 64055 <at> debbugs.gnu.org
Date: Tue, 13 Jun 2023 23:05:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 64055 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
64055: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D64055
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#64055: [WIP Patch] Enable editing commit messages - vc-git-modify-change-comment
Resent-From: Robert Pluim <rpluim@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 14 Jun 2023 08:01:02 +0000
Resent-Message-ID: <handler.64055.B64055.168672964327401 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Morgan Smith <Morgan.J.Smith@HIDDEN>
Cc: 64055 <at> debbugs.gnu.org
From: Robert Pluim <rpluim@HIDDEN>
In-Reply-To: <DM5PR03MB3163ADD665E6B3B1D8704A2AC555A@HIDDEN>
 (Morgan Smith's message of "Tue, 13 Jun 2023 18:59:24 -0400")
References: <DM5PR03MB3163ADD665E6B3B1D8704A2AC555A@HIDDEN>
Date: Wed, 14 Jun 2023 10:00:32 +0200
Message-ID: <87pm5yo4m7.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

>>>>> On Tue, 13 Jun 2023 18:59:24 -0400, Morgan Smith <Morgan.J.Smith@outl=
ook.com> said:

    Morgan> Please look at this patch.  Ignore the bad commit message for n=
ow, I'm
    Morgan> trying to figure out how to edit that :P.

    Morgan> I've spent far too long looking at git documentation and source=
 code.  I
    Morgan> think this is the best way to enable this feature.  In fact I r=
eally
    Morgan> don't think there is another way to implement this feature that=
 doesn't
    Morgan> rely on the "autosquash" git feature.

Does 'git commit --amend -m' not work?

    Morgan> I found the hack located in vc-git-modify-change-comment' of se=
tting
    Morgan> "GIT_SEQUENCE_EDITOR=3D:" on the internet and I don't understan=
d how it
    Morgan> works.

    Morgan> Also I'm not really sure what the 'vc-dispatcher-browsing' func=
tion is
    Morgan> supposed to do but it's getting in my way.  Like are 'diff-mode=
' buffers
    Morgan> a "directory browser buffer"?  I don't understand the intent he=
re.

    Morgan> Also you'll noticed I deleted some comments in vc.el.  That's m=
ainly to
    Morgan> highlight them so we can talk about them now.  Is there a good =
way to
    Morgan> stop users from editing remote commits?

You can=CA=BCt stop anyone from doing anything on their local system, but I
guess you could check if 'git merge-base' is upstream.

    Morgan> I feel like I should probably just keep working on this and get=
 it more
    Morgan> polished and answer some of my own questions before posting her=
e but I'm
    Morgan> getting kind of frustrated with this.  I am many hours deep int=
o this
    Morgan> problem.

We can be your rubber duck :-)

Robert
--=20

Last modified: Wed, 14 Jun 2023 08:15:01 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.