bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Philip Kaludercic]

When writing change logs in log-edit-mode, I have auto-fill-mode enabled
because 1. I find it convenient and 2. it derives from text mode.  It
has been pointed out to me that this leads to indentation issues, where
a change log entry is interpreted to be an unordered list.  So instead
of

--8<---------------cut here---------------start------------->8---
* lisp/vc/diff-mode.el (diff-add-log-current-defuns): Check
vc-root-dir to prepend the project path to the file being modified.
--8<---------------cut here---------------end--------------->8---

the messages is automatically formatted like

--8<---------------cut here---------------start------------->8---
* lisp/vc/diff-mode.el (diff-add-log-current-defuns): Check
  vc-root-dir to prepend the project path to the file being modified.
--8<---------------cut here---------------end--------------->8---

as soon as the line exceeds the fill column.

Note that manually filling the text using M-q does not run into this
issue.


In GNU Emacs 29.0.50 (build 6, x86_64-pc-linux-gnu, GTK+ Version 3.24.30, cairo version 1.16.0)
 of 2022-04-19 built on viero
Repository revision: d168decab4a03cd48b8b96257c36ffa575c720e6
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12011000
System Description: Guix System

Configured using:
 'configure
 PKG_CONFIG_PATH=/home/philip/.guix-profile/lib/pkgconfig:/home/philip/.guix-profile/share/pkgconfig'

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG
JSON LIBOTF LIBXML2 M17N_FLT MODULES NOTIFY INOTIFY PDUMPER PNG RSVG
SECCOMP SOUND SQLITE3 THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM
GTK3 ZLIB

Important settings:
  value of $EMACSLOADPATH: 
  value of $LANG: en_US.utf8
  locale-coding-system: utf-8-unix

Major mode: ELisp/l

Minor modes in effect:
  bug-reference-prog-mode: t
  outline-minor-mode: t
  corfu-mode: t
  flymake-mode: t
  yas-minor-mode: t
  flyspell-mode: t
  shell-dirtrack-mode: t
  recentf-mode: t
  repeat-mode: t
  display-battery-mode: t
  display-time-mode: t
  diff-hl-flydiff-mode: t
  diff-hl-mode: t
  winner-mode: t
  windmove-mode: t
  electric-pair-mode: t
  save-place-mode: t
  savehist-mode: t
  xterm-mouse-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  show-paren-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tab-bar-mode: t
  file-name-shadow-mode: t
  context-menu-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  line-number-mode: t
  transient-mark-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  temp-buffer-resize-mode: t
  auto-save-visited-mode: t

Load-path shadows:
/home/philip/Source/sp-tutor/sp-tutor hides /home/philip/.config/emacs/site-lisp/sp-tutor/sp-tutor
/home/philip/Source/sp-tutor/waffel hides /home/philip/.config/emacs/site-lisp/sp-tutor/waffel
/home/philip/.config/emacs/site-lisp/modus-themes/modus-vivendi-theme hides /home/philip/.config/emacs/elpa/modus-themes-2.3.0/modus-vivendi-theme
/home/philip/.config/emacs/site-lisp/modus-themes/modus-operandi-theme hides /home/philip/.config/emacs/elpa/modus-themes-2.3.0/modus-operandi-theme
/home/philip/.config/emacs/site-lisp/modus-themes/modus-themes hides /home/philip/.config/emacs/elpa/modus-themes-2.3.0/modus-themes
/home/philip/.config/emacs/elpa/transient-0.3.7/transient hides /home/philip/Source/emacs/lisp/transient
~/.config/emacs/site-lisp/autoload hides /home/philip/Source/emacs/lisp/emacs-lisp/autoload

Features:
(view shell-command+ log-edit add-log tramp-archive tramp-gvfs vc-mtn
vc-bzr vc-src vc-sccs vc-svn vc-cvs vc-rcs dired-aux gnus-dired
smerge-mode whitespace char-fold bug-reference find-func find-file
shadow avy emacsbug shortdoc macros kmacro mailalias smtpmail
autocrypt-message ecomplete misearch multi-isearch vc-backup log-view
pcvs-util vc-fossil copyright time-stamp ietf-drums-date sort smiley
gnus-cite mail-extr textsec uni-scripts idna-mapping ucs-normalize
uni-confusable textsec-check gnus-async gnus-bcklg qp gnus-ml
autocrypt-gnus autocrypt nndraft nnmh utf-7 nnfolder epa-file
network-stream nsm gnus-agent gnus-srvr gnus-score score-mode nnvirtual
gnus-msg gnus-art mm-uu mml2015 mm-view mml-smime smime gnutls dig nntp
gnus-cache gnus-sum shr pixel-fill kinsoku url-file url-dired svg dom
gnus-group gnus-undo gnus-start gnus-dbus gnus-cloud nnimap nnmail
mail-source utf7 netrc nnoo gnus-spec gnus-int gnus-range message
yank-media rmc puny rfc822 mml mml-sec epa epg rfc6068 epg-config
mm-decode mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils
mailheader gnus-win noutline outline corfu checkdoc flymake-proc flymake
project warnings thingatpt yasnippet-snippets yasnippet cl-extra
flyspell ispell auth-source-pass tramp-cache tramp-sh tramp
tramp-loaddefs trampver tramp-integration cus-edit pp files-x
tramp-compat shell pcomplete parse-time iso8601 ls-lisp recentf
tree-widget repeat format-spec battery dbus xml dired-x dired
dired-loaddefs time sendmail rfc2047 rfc2045 ietf-drums gnus nnheader
gnus-util time-date mail-utils range mm-util mail-prsvr wid-edit
help-at-pt diff-hl-flydiff diff diff-hl face-remap vc-hg vc-git vc-dir
ewoc vc vc-dispatcher diff-mode derived easy-mmode hippie-exp winner
windmove rx elec-pair saveplace savehist xt-mouse modus-operandi-theme
modus-themes pcase rot13 disp-table cus-load setup compile
text-property-search comint ansi-color autoload lisp-mnt tex-site
geiser-impl help-fns radix-tree help-mode geiser-custom geiser-base ring
slime-autoloads info package browse-url url url-proxy url-privacy
url-expand url-methods url-history url-cookie url-domsuf url-util
mailcap url-handlers url-parse auth-source cl-seq eieio eieio-core
cl-macs eieio-loaddefs password-cache json map url-vars seq gv subr-x
byte-opt bytecomp byte-compile cconv cl-loaddefs cl-lib iso-transl
tooltip eldoc paren electric uniquify ediff-hook vc-hooks
lisp-float-type elisp-mode mwheel term/x-win x-win term/common-win x-dnd
tool-bar dnd fontset image regexp-opt fringe tabulated-list replace
newcomment text-mode lisp-mode prog-mode register page tab-bar menu-bar
rfn-eshadow isearch easymenu timer select scroll-bar mouse jit-lock
font-lock syntax font-core term/tty-colors frame minibuffer nadvice
simple cl-generic cham georgian utf-8-lang misc-lang vietnamese tibetan
thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek romanian
slovak czech european ethiopic indian cyrillic chinese composite
emoji-zwj charscript charprop case-table epa-hook jka-cmpr-hook help
abbrev obarray oclosure cl-preloaded button loaddefs faces cus-face
macroexp files window text-properties overlay sha1 md5 base64 format env
code-pages mule custom widget keymap hashtable-print-readable backquote
threads dbusbind inotify dynamic-setting system-font-setting
font-render-setting cairo move-toolbar gtk x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 532263 72950)
 (symbols 48 28732 62)
 (strings 32 114166 8346)
 (string-bytes 1 3305981)
 (vectors 16 74182)
 (vector-slots 8 1715184 82388)
 (floats 8 449 710)
 (intervals 56 3104 610)
 (buffers 992 40))

-- 
	Philip Kaludercic

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Date: Wed, 20 Apr 2022 14:30:17 +0000
> 
> 
> When writing change logs in log-edit-mode, I have auto-fill-mode enabled
> because 1. I find it convenient and 2. it derives from text mode.  It
> has been pointed out to me that this leads to indentation issues, where
> a change log entry is interpreted to be an unordered list.  So instead
> of
> 
> --8<---------------cut here---------------start------------->8---
> * lisp/vc/diff-mode.el (diff-add-log-current-defuns): Check
> vc-root-dir to prepend the project path to the file being modified.
> --8<---------------cut here---------------end--------------->8---
> 
> the messages is automatically formatted like
> 
> --8<---------------cut here---------------start------------->8---
> * lisp/vc/diff-mode.el (diff-add-log-current-defuns): Check
>   vc-root-dir to prepend the project path to the file being modified.
> --8<---------------cut here---------------end--------------->8---
> 
> as soon as the line exceeds the fill column.

I always use auto-fill-mode in ChangeLog buffers, and it never does
anything like what you described for me.  Can you show a recipe
starting from "emacs -Q" that shows this problem?

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Philip Kaludercic]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Philip Kaludercic <philipk@posteo.net>
>> Date: Wed, 20 Apr 2022 14:30:17 +0000
>> 
>> 
>> When writing change logs in log-edit-mode, I have auto-fill-mode enabled
>> because 1. I find it convenient and 2. it derives from text mode.  It
>> has been pointed out to me that this leads to indentation issues, where
>> a change log entry is interpreted to be an unordered list.  So instead
>> of
>> 
>> --8<---------------cut here---------------start------------->8---
>> * lisp/vc/diff-mode.el (diff-add-log-current-defuns): Check
>> vc-root-dir to prepend the project path to the file being modified.
>> --8<---------------cut here---------------end--------------->8---
>> 
>> the messages is automatically formatted like
>> 
>> --8<---------------cut here---------------start------------->8---
>> * lisp/vc/diff-mode.el (diff-add-log-current-defuns): Check
>>   vc-root-dir to prepend the project path to the file being modified.
>> --8<---------------cut here---------------end--------------->8---
>> 
>> as soon as the line exceeds the fill column.
>
> I always use auto-fill-mode in ChangeLog buffers, and it never does
> anything like what you described for me.  Can you show a recipe
> starting from "emacs -Q" that shows this problem?

1. Start emacs -Q
2. Open any versioned file
3. Make any modification
4. Prepare a commit using C-x v v
5. Go to the commit body and insert ChangeLog template
6. Ensure that auto-fill-mode is enabled in the buffer
7. Type anything until the fill-column is reached

I did 7. by just repeating the word "word", and after a short while it
auto-filled the line and the text appeared formatted as described above.

-- 
	Philip Kaludercic

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: 55040@debbugs.gnu.org
> Date: Wed, 20 Apr 2022 17:08:20 +0000
> 
> > I always use auto-fill-mode in ChangeLog buffers, and it never does
> > anything like what you described for me.  Can you show a recipe
> > starting from "emacs -Q" that shows this problem?
> 
> 1. Start emacs -Q
> 2. Open any versioned file
> 3. Make any modification
> 4. Prepare a commit using C-x v v
> 5. Go to the commit body and insert ChangeLog template
> 6. Ensure that auto-fill-mode is enabled in the buffer
> 7. Type anything until the fill-column is reached
> 
> I did 7. by just repeating the word "word", and after a short while it
> auto-filled the line and the text appeared formatted as described above.

Can you elaborate on Step 5?  I don't think I understand what I'm
supposed to do there.

Thanks.

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Philip Kaludercic]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Philip Kaludercic <philipk@posteo.net>
>> Cc: 55040@debbugs.gnu.org
>> Date: Wed, 20 Apr 2022 17:08:20 +0000
>> 
>> > I always use auto-fill-mode in ChangeLog buffers, and it never does
>> > anything like what you described for me.  Can you show a recipe
>> > starting from "emacs -Q" that shows this problem?
>> 
>> 1. Start emacs -Q
>> 2. Open any versioned file
>> 3. Make any modification
>> 4. Prepare a commit using C-x v v
>> 5. Go to the commit body and insert ChangeLog template
>> 6. Ensure that auto-fill-mode is enabled in the buffer
>> 7. Type anything until the fill-column is reached
>> 
>> I did 7. by just repeating the word "word", and after a short while it
>> auto-filled the line and the text appeared formatted as described above.
>
> Can you elaborate on Step 5?  I don't think I understand what I'm
> supposed to do there.

This should be enough:

* M->           (end-of-buffer)
* C-c C-w       (log-edit-generate-changelog-from-diff)

> Thanks.

-- 
	Philip Kaludercic

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: 55040@debbugs.gnu.org
> Date: Wed, 20 Apr 2022 17:42:02 +0000
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >> 1. Start emacs -Q
> >> 2. Open any versioned file
> >> 3. Make any modification
> >> 4. Prepare a commit using C-x v v
> >> 5. Go to the commit body and insert ChangeLog template
> >> 6. Ensure that auto-fill-mode is enabled in the buffer
> >> 7. Type anything until the fill-column is reached
> >> 
> >> I did 7. by just repeating the word "word", and after a short while it
> >> auto-filled the line and the text appeared formatted as described above.
> >
> > Can you elaborate on Step 5?  I don't think I understand what I'm
> > supposed to do there.
> 
> This should be enough:
> 
> * M->           (end-of-buffer)
> * C-c C-w       (log-edit-generate-changelog-from-diff)

Ah, okay.  I see it now.  I guess it's some difference between
change-log-mode and log-edit-mode wrt filling and indenting.
Something to fix, I think.

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: 55040@debbugs.gnu.org
> Date: Wed, 20 Apr 2022 17:42:02 +0000
> 
> >> 1. Start emacs -Q
> >> 2. Open any versioned file
> >> 3. Make any modification
> >> 4. Prepare a commit using C-x v v
> >> 5. Go to the commit body and insert ChangeLog template
> >> 6. Ensure that auto-fill-mode is enabled in the buffer
> >> 7. Type anything until the fill-column is reached
> >> 
> >> I did 7. by just repeating the word "word", and after a short while it
> >> auto-filled the line and the text appeared formatted as described above.
> >
> > Can you elaborate on Step 5?  I don't think I understand what I'm
> > supposed to do there.
> 
> This should be enough:
> 
> * M->           (end-of-buffer)
> * C-c C-w       (log-edit-generate-changelog-from-diff)

Looks like just turning off adaptive-fill-mode is enough to solve your
problem.

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Philip Kaludercic]

[-- Attachment #1: Type: text/plain, Size: 1000 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Philip Kaludercic <philipk@posteo.net>
>> Cc: 55040@debbugs.gnu.org
>> Date: Wed, 20 Apr 2022 17:42:02 +0000
>> 
>> >> 1. Start emacs -Q
>> >> 2. Open any versioned file
>> >> 3. Make any modification
>> >> 4. Prepare a commit using C-x v v
>> >> 5. Go to the commit body and insert ChangeLog template
>> >> 6. Ensure that auto-fill-mode is enabled in the buffer
>> >> 7. Type anything until the fill-column is reached
>> >> 
>> >> I did 7. by just repeating the word "word", and after a short while it
>> >> auto-filled the line and the text appeared formatted as described above.
>> >
>> > Can you elaborate on Step 5?  I don't think I understand what I'm
>> > supposed to do there.
>> 
>> This should be enough:
>> 
>> * M->           (end-of-buffer)
>> * C-c C-w       (log-edit-generate-changelog-from-diff)
>
> Looks like just turning off adaptive-fill-mode is enough to solve your
> problem.

Should it be disabled for log-edit-mode in general?


[-- Attachment #2: Type: text/plain, Size: 595 bytes --]

diff --git a/lisp/vc/log-edit.el b/lisp/vc/log-edit.el
index 79dafe60cc..8b92e6aea1 100644
--- a/lisp/vc/log-edit.el
+++ b/lisp/vc/log-edit.el
@@ -504,6 +504,7 @@ log-edit-mode
   (cl-pushnew 'display-line-numbers-disable font-lock-extra-managed-props)
   (setq-local jit-lock-contextually t)  ;For the "first line is summary".
   (setq-local fill-paragraph-function #'log-edit-fill-entry)
+  (setq-local adaptive-fill-mode nil)
   (make-local-variable 'log-edit-comment-ring-index)
   (add-hook 'kill-buffer-hook 'log-edit-remember-comment nil t)
   (hack-dir-local-variables-non-file-buffer))

[-- Attachment #3: Type: text/plain, Size: 24 bytes --]


-- 
	Philip Kaludercic

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: 55040@debbugs.gnu.org
> Date: Wed, 20 Apr 2022 20:59:59 +0000
> 
> > Looks like just turning off adaptive-fill-mode is enough to solve your
> > problem.
> 
> Should it be disabled for log-edit-mode in general?

Maybe.  I'd be interested in hearing opinions of others, since
different projects have different conventions wrt this.

Also, log-edit-mode doesn't turn on auto-fill-mode by default, so
maybe the change you propose should only be in effect if the user does
turn on auto-fill.

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@gnu.org> writes:

>> > Looks like just turning off adaptive-fill-mode is enough to solve your
>> > problem.
>> 
>> Should it be disabled for log-edit-mode in general?
>
> Maybe.  I'd be interested in hearing opinions of others, since
> different projects have different conventions wrt this.
>
> Also, log-edit-mode doesn't turn on auto-fill-mode by default, so
> maybe the change you propose should only be in effect if the user does
> turn on auto-fill.

I think having adaptive-fill-mode switched off would be an improvement
when doing ChangeLog-like commits, but I'm not sure that it's a good
idea in general.

If we could instead make the adaptive filling smarter (and discover that
we're doing a ChangeLog-like paragraph), that would be better, I think?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Eli Zaretskii]

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: Philip Kaludercic <philipk@posteo.net>,  55040@debbugs.gnu.org
> Date: Fri, 22 Apr 2022 16:36:06 +0200
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >> > Looks like just turning off adaptive-fill-mode is enough to solve your
> >> > problem.
> >> 
> >> Should it be disabled for log-edit-mode in general?
> >
> > Maybe.  I'd be interested in hearing opinions of others, since
> > different projects have different conventions wrt this.
> >
> > Also, log-edit-mode doesn't turn on auto-fill-mode by default, so
> > maybe the change you propose should only be in effect if the user does
> > turn on auto-fill.
> 
> I think having adaptive-fill-mode switched off would be an improvement
> when doing ChangeLog-like commits, but I'm not sure that it's a good
> idea in general.
> 
> If we could instead make the adaptive filling smarter (and discover that
> we're doing a ChangeLog-like paragraph), that would be better, I think?

I'm not sure adaptive-fill-mode makes sense in log-edit-mode (since
AFAIU lines are supposed to be flushed to the left margin), but I
don't object to trying to solve this in some other way.

bug#55040: 29.0.50; Auto-indent-mode and Changelog Messages

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@gnu.org> writes:

> I'm not sure adaptive-fill-mode makes sense in log-edit-mode (since
> AFAIU lines are supposed to be flushed to the left margin), but I
> don't object to trying to solve this in some other way.

People put all kinds of text in commit messages, including

  * text in bullet points
    which adaptive-fill-mode
    handles nicely.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no