GNU bug report logs - #55039
[PATCH] Use VC-relative file names in ChangeLog entries

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 55039 in the body.
You can then email your comments to 55039 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 20 Apr 2022 14:19:39 +0000

[Message part 1 (text/plain, inline)]

Tags: patch


By default C-c C-w (log-edit-generate-changelog-from-diff) just uses the
file name when generating a changelog message.  As it has been requested
to use the project relative path name when writing changelog messages,
it seems to make sense to generate these automatically as well.

Alternatively, this could also be configured using a directory local
variable that would be set for emacs.git.


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'

[0001-Use-VC-relative-file-names-in-ChangeLog-entries.patch (text/patch, attachment)]

[Message part 3 (text/plain, inline)]

-- 
	Philip Kaludercic

Message #8 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 20 Apr 2022 19:01:12 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Date: Wed, 20 Apr 2022 14:19:39 +0000
> 
> By default C-c C-w (log-edit-generate-changelog-from-diff) just uses the
> file name when generating a changelog message.  As it has been requested
> to use the project relative path name when writing changelog messages,
> it seems to make sense to generate these automatically as well.
> 
> Alternatively, this could also be configured using a directory local
> variable that would be set for emacs.git.

First, I think this must be customizable, because different projects
have different conventions.

Second, I think the code should DTRT if there's already a ChangeLog
file in the current directory or in one of its parent directories,
because those usually show you the project's conventions.

Message #11 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Richard Stallman <rms <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 21 Apr 2022 23:03:32 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

We used to have a ChangeLog file for each important directory
in Emacs (src, lisp, etc, lib-src, and so on).
I hope we still do, as a single ChangeLog for all of Emacs
would be very long and thus cumbersome.

In these ChangeLog files, we should delete the directory names which
are superfluous.  Thus, when generating src/ChangeLog, we should
delete `src/' from the start of the source file names in the entries.

Do we do that?

Would this patch require changes in that?


-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Message #14 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: rms <at> gnu.org
Cc: philipk <at> posteo.net, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Fri, 22 Apr 2022 08:29:51 +0300

> From: Richard Stallman <rms <at> gnu.org>
> Date: Thu, 21 Apr 2022 23:03:32 -0400
> Cc: 55039 <at> debbugs.gnu.org
> 
> We used to have a ChangeLog file for each important directory
> in Emacs (src, lisp, etc, lib-src, and so on).
> I hope we still do, as a single ChangeLog for all of Emacs
> would be very long and thus cumbersome.

We nowadays have a single ChangeLog for all of Emacs, which is
produced from the Git commit logs.  We start a new ChangeLog from time
to time, to keep the file from growing too much, but that's all.

Message #17 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Richard Stallman <rms <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: philipk <at> posteo.net, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Fri, 22 Apr 2022 23:46:27 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > We nowadays have a single ChangeLog for all of Emacs, which is
  > produced from the Git commit logs.  We start a new ChangeLog from time
  > to time, to keep the file from growing too much, but that's all.

Do you find it inconvenient to put all directories into a single
ChangeLog file?  I would expect it to be inconvenient, but I don't
have actual experience using these files.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Message #20 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: rms <at> gnu.org
Cc: philipk <at> posteo.net, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Sat, 23 Apr 2022 09:17:02 +0300

> From: Richard Stallman <rms <at> gnu.org>
> Cc: philipk <at> posteo.net, 55039 <at> debbugs.gnu.org
> Date: Fri, 22 Apr 2022 23:46:27 -0400
> 
>   > We nowadays have a single ChangeLog for all of Emacs, which is
>   > produced from the Git commit logs.  We start a new ChangeLog from time
>   > to time, to keep the file from growing too much, but that's all.
> 
> Do you find it inconvenient to put all directories into a single
> ChangeLog file?

No, not really.  We do that now for a long time, so I'm used to it
nowadays.

Message #23 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Philip Kaludercic <philipk <at> posteo.net>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 13:13:01 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

> First, I think this must be customizable, because different projects
> have different conventions.

This was several months ago -- Philip, did you do any further work in
this direction?

> Second, I think the code should DTRT if there's already a ChangeLog
> file in the current directory or in one of its parent directories,
> because those usually show you the project's conventions.

This would be a separate issue, though?  (And I agree that it would be
nice to have, but it doesn't sound trivial to implement.)

Message #28 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: philipk <at> posteo.net, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 14:24:16 +0300

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Cc: Philip Kaludercic <philipk <at> posteo.net>,  55039 <at> debbugs.gnu.org
> Date: Tue, 06 Sep 2022 13:13:01 +0200
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > Second, I think the code should DTRT if there's already a ChangeLog
> > file in the current directory or in one of its parent directories,
> > because those usually show you the project's conventions.
> 
> This would be a separate issue, though?  (And I agree that it would be
> nice to have, but it doesn't sound trivial to implement.)

The proposed feature isn't optional, it unconditionally changes the
behavior.  AFAIU, it will change the way file names are mentioned in
log messages regardless of anything.  Does it sound right to you?

IOW, providing a new feature in response to a request is fine, but why
immediately make it the default, and why force it on everyone without
any fire escape?

So if we are not going to teach this feature to look at exiting
ChangeLog files, at the very l;east this feature should be optional,
perhaps off by default.

And btw, this only changes the behavior of one command, but AFAIK
there are other commands that produce ChangeLog-style entries -- what
about them?

Message #31 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: philipk <at> posteo.net, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 13:30:17 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

>> This would be a separate issue, though?  (And I agree that it would be
>> nice to have, but it doesn't sound trivial to implement.)
>
> The proposed feature isn't optional, it unconditionally changes the
> behavior.  AFAIU, it will change the way file names are mentioned in
> log messages regardless of anything.  Does it sound right to you?

No, I agreed with you that the proposed patch needs work.  I just
pointed out that your second paragraph was a separate issue, because the
code doesn't heed existing ChangeLog files anyway.

Message #34 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 12:45:00 +0000

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Eli Zaretskii <eliz <at> gnu.org> writes:
>
>> First, I think this must be customizable, because different projects
>> have different conventions.
>
> This was several months ago -- Philip, did you do any further work in
> this direction?

No I hadn't, but I can take tackle it again as this shouldn't be that
difficult.

>> Second, I think the code should DTRT if there's already a ChangeLog
>> file in the current directory or in one of its parent directories,
>> because those usually show you the project's conventions.
>
> This would be a separate issue, though?  (And I agree that it would be
> nice to have, but it doesn't sound trivial to implement.)

Message #37 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 14:34:58 +0000

[Message part 1 (text/plain, inline)]

Philip Kaludercic <philipk <at> posteo.net> writes:

> Lars Ingebrigtsen <larsi <at> gnus.org> writes:
>
>> Eli Zaretskii <eliz <at> gnu.org> writes:
>>
>>> First, I think this must be customizable, because different projects
>>> have different conventions.
>>
>> This was several months ago -- Philip, did you do any further work in
>> this direction?
>
> No I hadn't, but I can take tackle it again as this shouldn't be that
> difficult.

Something like this should be enough, at least functionality wise,
right?

[Message part 2 (text/plain, inline)]

diff --git a/lisp/vc/diff-mode.el b/lisp/vc/diff-mode.el
index 322d4abd31..1f0eec0d66 100644
--- a/lisp/vc/diff-mode.el
+++ b/lisp/vc/diff-mode.el
@@ -2336,6 +2336,12 @@ diff-undo
   (let ((inhibit-read-only t))
     (undo arg)))
 
+(defcustom diff-relative-names-in-changelog nil
+  "Use relative file names when generating ChangeLog messages."
+  :type 'boolean
+  :safe #'booleanp
+  :version "29.1")
+
 (defun diff-add-log-current-defuns ()
   "Return an alist of defun names for the current diff.
 The elements of the alist are of the form (FILE . (DEFUN...)),
@@ -2374,9 +2380,11 @@ diff-add-log-current-defuns
           (re-search-forward diff-hunk-header-re nil t)
         (setq hunk-end (save-excursion (diff-end-of-hunk)))
         (pcase-let* ((filename (substring-no-properties
-                                (file-relative-name
-                                   (diff-find-file-name)
-                                   (vc-root-dir))))
+                                (if diff-relative-names-in-changelog
+                                    (file-relative-name
+                                     (diff-find-file-name)
+                                     (vc-root-dir))
+                                  (diff-find-file-name))))
                      (=lines 0)
                      (+lines 0)
                      (-lines 0)

[Message part 3 (text/plain, inline)]

Assuming nobody objects to the name of the option, should this be
documented in NEWS and/or in the Manual?  Also, as the entire point of
the patch was that emacs.git is using relative path names, should a
.dir-locals.el variable be set to ensure this is done?

Message #40 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 16:39:29 +0200

Philip Kaludercic <philipk <at> posteo.net> writes:

> Something like this should be enough, at least functionality wise,
> right?

Looks good to me.

> Assuming nobody objects to the name of the option, should this be
> documented in NEWS and/or in the Manual?  Also, as the entire point of
> the patch was that emacs.git is using relative path names, 

Should be in NEWS and mentioned in the `diff-add-log-current-defuns' doc
string, I think.  I don't know whether it's necessary to document it in
the manual.

> should a .dir-locals.el variable be set to ensure this is done?

I think so.

Message #43 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Robert Pluim <rpluim <at> gmail.com>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 16:58:07 +0200

>>>>> On Tue, 06 Sep 2022 14:34:58 +0000, Philip Kaludercic <philipk <at> posteo.net> said:
    Philip>  (defun diff-add-log-current-defuns ()
    Philip>    "Return an alist of defun names for the current diff.
    Philip>  The elements of the alist are of the form (FILE . (DEFUN...)),
    Philip> @@ -2374,9 +2380,11 @@ diff-add-log-current-defuns
    Philip>            (re-search-forward diff-hunk-header-re nil t)
    Philip>          (setq hunk-end (save-excursion (diff-end-of-hunk)))
    Philip>          (pcase-let* ((filename (substring-no-properties
    Philip> -                                (file-relative-name
    Philip> -                                   (diff-find-file-name)
    Philip> -                                   (vc-root-dir))))
    Philip> +                                (if diff-relative-names-in-changelog
    Philip> +                                    (file-relative-name
    Philip> +                                     (diff-find-file-name)
    Philip> +                                     (vc-root-dir))
    Philip> +                                  (diff-find-file-name))))
    Philip>                       (=lines 0)
    Philip>                       (+lines 0)
    Philip>                       (-lines 0)

That doesnʼt look like the code thatʼs currently in master. Is this on
top of your previous patch?

    Philip> Assuming nobody objects to the name of the option, should this be
    Philip> documented in NEWS and/or in the Manual?  Also, as the entire point of
    Philip> the patch was that emacs.git is using relative path names, should a
    Philip> .dir-locals.el variable be set to ensure this is done?

NEWS and .dir-locals.el definitely. I guess you could add to the "Log
Buffer" node in the emacs manual if youʼre feeling inspired 😀

Robert
-- 

Message #46 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Robert Pluim <rpluim <at> gmail.com>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 15:02:53 +0000

Robert Pluim <rpluim <at> gmail.com> writes:

>>>>>> On Tue, 06 Sep 2022 14:34:58 +0000, Philip Kaludercic <philipk <at> posteo.net> said:
>     Philip>  (defun diff-add-log-current-defuns ()
>     Philip>    "Return an alist of defun names for the current diff.
>     Philip>  The elements of the alist are of the form (FILE . (DEFUN...)),
>     Philip> @@ -2374,9 +2380,11 @@ diff-add-log-current-defuns
>     Philip>            (re-search-forward diff-hunk-header-re nil t)
>     Philip>          (setq hunk-end (save-excursion (diff-end-of-hunk)))
>     Philip>          (pcase-let* ((filename (substring-no-properties
>     Philip> -                                (file-relative-name
>     Philip> -                                   (diff-find-file-name)
>     Philip> -                                   (vc-root-dir))))
>     Philip> +                                (if diff-relative-names-in-changelog
>     Philip> +                                    (file-relative-name
>     Philip> +                                     (diff-find-file-name)
>     Philip> +                                     (vc-root-dir))
>     Philip> +                                  (diff-find-file-name))))
>     Philip>                       (=lines 0)
>     Philip>                       (+lines 0)
>     Philip>                       (-lines 0)
>
> That doesnʼt look like the code thatʼs currently in master. Is this on
> top of your previous patch?

No, these changes would be on top of the previous patch, but I'm of
course going to merge them into a single commit.

>     Philip> Assuming nobody objects to the name of the option, should this be
>     Philip> documented in NEWS and/or in the Manual?  Also, as the entire point of
>     Philip> the patch was that emacs.git is using relative path names, should a
>     Philip> .dir-locals.el variable be set to ensure this is done?
>
> NEWS and .dir-locals.el definitely. I guess you could add to the "Log
> Buffer" node in the emacs manual if youʼre feeling inspired 😀

I'll consider it.

> Robert

Message #49 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 18:46:14 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: Eli Zaretskii <eliz <at> gnu.org>,  55039 <at> debbugs.gnu.org
> Date: Tue, 06 Sep 2022 14:34:58 +0000
> 
> +(defcustom diff-relative-names-in-changelog nil
> +  "Use relative file names when generating ChangeLog messages."

The doc string should reference the commands for which this option is
relevant.

> Assuming nobody objects to the name of the option, should this be
> documented in NEWS and/or in the Manual?

I think so, yes, since "C-x 4 A" is in the manual, and this option
will affect it, right?

> Also, as the entire point of
> the patch was that emacs.git is using relative path names, should a
> .dir-locals.el variable be set to ensure this is done?

I guess so, yes.  But what would happen to people who use Emacs
versions before 29?

Message #52 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 19:13:09 +0300

> +(defcustom diff-relative-names-in-changelog nil
> +  "Use relative file names when generating ChangeLog messages."
> +  :type 'boolean
> +  :safe #'booleanp
> +  :version "29.1")
> +
>  (defun diff-add-log-current-defuns ()
>    "Return an alist of defun names for the current diff.
>  The elements of the alist are of the form (FILE . (DEFUN...)),

Couldn't they share the same name prefix, e.g.
diff-add-log-relative-names?

Message #55 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 20:10:41 +0000

[Message part 1 (text/plain, inline)]

Here is an updated patch:

[0001-Add-new-user-option-diff-add-log-relative-names.patch (text/x-diff, attachment)]

Message #58 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Tue, 06 Sep 2022 20:11:57 +0000

Eli Zaretskii <eliz <at> gnu.org> writes:

>> Assuming nobody objects to the name of the option, should this be
>> documented in NEWS and/or in the Manual?
>
> I think so, yes, since "C-x 4 A" is in the manual, and this option
> will affect it, right?

From what I see, it won't be affected.  Do you think it should be?

>> Also, as the entire point of
>> the patch was that emacs.git is using relative path names, should a
>> .dir-locals.el variable be set to ensure this is done?
>
> I guess so, yes.  But what would happen to people who use Emacs
> versions before 29?

It should have no effect.

Message #61 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Robert Pluim <rpluim <at> gmail.com>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 12:08:03 +0200

>>>>> On Tue, 06 Sep 2022 20:10:41 +0000, Philip Kaludercic <philipk <at> posteo.net> said:

    Philip> Here is an updated patch:

    Philip> From f8e4b14198e8a9ccd5e4cbdbe044eb468697c2b8 Mon Sep 17 00:00:00 2001
    Philip> From: Philip Kaludercic <philipk <at> posteo.net>
    Philip> Date: Tue, 6 Sep 2022 22:06:29 +0200
    Philip> Subject: [PATCH] Add new user option 'diff-add-log-relative-names'

    Philip> * .dir-locals.el: Set 'diff-add-log-relative-names' to t
    Philip> * doc/emacs/maintaining.texi (Log Buffer): Mention
    Philip> 'diff-add-log-relative-names'
    Philip> * etc/NEWS: Mention 'diff-add-log-relative-names'
    Philip> * lisp/vc/diff-mode.el (diff-add-log-relative-names): Add new option.
    Philip> (diff-add-log-current-defuns): Use new option.

The name of the option in NEWS is different from whatʼs in the code (I
prefer the one in NEWS).

Robert
-- 

Message #64 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 14:48:23 +0200

Philip Kaludercic <philipk <at> posteo.net> writes:

> Here is an updated patch:

Looks good to me.

Message #67 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 16:27:17 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: Eli Zaretskii <eliz <at> gnu.org>,  55039 <at> debbugs.gnu.org
> Date: Tue, 06 Sep 2022 20:10:41 +0000
> 
> --- a/doc/emacs/maintaining.texi
> +++ b/doc/emacs/maintaining.texi
> @@ -694,7 +694,10 @@ Log Buffer
>  (@code{log-edit-generate-changelog-from-diff}), to generate skeleton
>  ChangeLog entries, listing all changed file and function names based
>  on the diff of the VC fileset.  Consecutive entries left empty will be
> -combined by @kbd{C-q} (@code{fill-paragraph}).
> +combined by @kbd{C-q} (@code{fill-paragraph}).  By default the
> +inserted file names will just be the files without a path.  If
> +@code{diff-add-log-relative-names} is non-nil, a partial path relative
> +to the VC root directory will be inserted instead.

GNU Coding Standards frown on using "path" for anything but PATH-style
directory lists.  Please use "leading directories" or somesuch here,
as that's what you mean.

> +*** New user option 'diff-relative-names-in-changelog'.
> +If non-nil insert file names in ChangeLog skeletons relative to the
             ^
Comma missing there.

> +(defcustom diff-add-log-relative-names nil
> +  "Use relative file names when generating ChangeLog messages."

This doesn't say relative to what.  It also doesn't mention the
commands which are affected.

>  (defun diff-add-log-current-defuns ()
>    "Return an alist of defun names for the current diff.
>  The elements of the alist are of the form (FILE . (DEFUN...)),
> -where DEFUN... is a list of function names found in FILE."
> +where DEFUN... is a list of function names found in FILE.  If
> +`diff-add-log-relative-names' is non-nil, insert file names
> +relative to the VC root directory."

The "insert" part is out of place here, since there's no insertion.

How about

  If `diff-add-log-relative-names' is non-nil, file names in the alist
  are relative to the root directory of the VC repository.

instead?

Message #70 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 15:53:29 +0000

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Philip Kaludercic <philipk <at> posteo.net>
>> Cc: Eli Zaretskii <eliz <at> gnu.org>,  55039 <at> debbugs.gnu.org
>> Date: Tue, 06 Sep 2022 20:10:41 +0000
>> 
>> --- a/doc/emacs/maintaining.texi
>> +++ b/doc/emacs/maintaining.texi
>> @@ -694,7 +694,10 @@ Log Buffer
>>  (@code{log-edit-generate-changelog-from-diff}), to generate skeleton
>>  ChangeLog entries, listing all changed file and function names based
>>  on the diff of the VC fileset.  Consecutive entries left empty will be
>> -combined by @kbd{C-q} (@code{fill-paragraph}).
>> +combined by @kbd{C-q} (@code{fill-paragraph}).  By default the
>> +inserted file names will just be the files without a path.  If
>> +@code{diff-add-log-relative-names} is non-nil, a partial path relative
>> +to the VC root directory will be inserted instead.
>
> GNU Coding Standards frown on using "path" for anything but PATH-style
> directory lists.  Please use "leading directories" or somesuch here,
> as that's what you mean.

I've just remove the changes to the manual from my patch.

>> +*** New user option 'diff-relative-names-in-changelog'.
>> +If non-nil insert file names in ChangeLog skeletons relative to the
>              ^
> Comma missing there.

Done.

>> +(defcustom diff-add-log-relative-names nil
>> +  "Use relative file names when generating ChangeLog messages."
>
> This doesn't say relative to what.  It also doesn't mention the
> commands which are affected.

Added.

>>  (defun diff-add-log-current-defuns ()
>>    "Return an alist of defun names for the current diff.
>>  The elements of the alist are of the form (FILE . (DEFUN...)),
>> -where DEFUN... is a list of function names found in FILE."
>> +where DEFUN... is a list of function names found in FILE.  If
>> +`diff-add-log-relative-names' is non-nil, insert file names
>> +relative to the VC root directory."
>
> The "insert" part is out of place here, since there's no insertion.
>
> How about
>
>   If `diff-add-log-relative-names' is non-nil, file names in the alist
>   are relative to the root directory of the VC repository.
>
> instead?

I like it.

[0001-Add-new-user-option-diff-add-log-use-relative-names.patch (text/x-diff, attachment)]

Message #73 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 21:12:30 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
> Date: Wed, 07 Sep 2022 15:53:29 +0000
> 
> >> --- a/doc/emacs/maintaining.texi
> >> +++ b/doc/emacs/maintaining.texi
> >> @@ -694,7 +694,10 @@ Log Buffer
> >>  (@code{log-edit-generate-changelog-from-diff}), to generate skeleton
> >>  ChangeLog entries, listing all changed file and function names based
> >>  on the diff of the VC fileset.  Consecutive entries left empty will be
> >> -combined by @kbd{C-q} (@code{fill-paragraph}).
> >> +combined by @kbd{C-q} (@code{fill-paragraph}).  By default the
> >> +inserted file names will just be the files without a path.  If
> >> +@code{diff-add-log-relative-names} is non-nil, a partial path relative
> >> +to the VC root directory will be inserted instead.
> >
> > GNU Coding Standards frown on using "path" for anything but PATH-style
> > directory lists.  Please use "leading directories" or somesuch here,
> > as that's what you mean.
> 
> I've just remove the changes to the manual from my patch.

Why?  That was nowhere near what I intended to say with the above
comments, which were minor.

Message #76 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 18:27:18 +0000

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Philip Kaludercic <philipk <at> posteo.net>
>> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
>> Date: Wed, 07 Sep 2022 15:53:29 +0000
>> 
>> >> --- a/doc/emacs/maintaining.texi
>> >> +++ b/doc/emacs/maintaining.texi
>> >> @@ -694,7 +694,10 @@ Log Buffer
>> >>  (@code{log-edit-generate-changelog-from-diff}), to generate skeleton
>> >>  ChangeLog entries, listing all changed file and function names based
>> >>  on the diff of the VC fileset.  Consecutive entries left empty will be
>> >> -combined by @kbd{C-q} (@code{fill-paragraph}).
>> >> +combined by @kbd{C-q} (@code{fill-paragraph}).  By default the
>> >> +inserted file names will just be the files without a path.  If
>> >> +@code{diff-add-log-relative-names} is non-nil, a partial path relative
>> >> +to the VC root directory will be inserted instead.
>> >
>> > GNU Coding Standards frown on using "path" for anything but PATH-style
>> > directory lists.  Please use "leading directories" or somesuch here,
>> > as that's what you mean.
>> 
>> I've just remove the changes to the manual from my patch.
>
> Why?  That was nowhere near what I intended to say with the above
> comments, which were minor.

It wasn't because of your comments, rather I just felt mentioning it was
too clumsy, and a few others said they didn't feel it was necessary to
mention the option in the manual.  But if you think that it should be
added, then I'll try it again and take your comments into account.

Message #79 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 21:46:38 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
> Date: Wed, 07 Sep 2022 18:27:18 +0000
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> >> I've just remove the changes to the manual from my patch.
> >
> > Why?  That was nowhere near what I intended to say with the above
> > comments, which were minor.
> 
> It wasn't because of your comments, rather I just felt mentioning it was
> too clumsy, and a few others said they didn't feel it was necessary to
> mention the option in the manual.  But if you think that it should be
> added, then I'll try it again and take your comments into account.

Yes, I think it should be in the manual.  But if you'd rather leave
that to me, I'm fine with that.

Message #82 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 21:23:38 +0000

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Philip Kaludercic <philipk <at> posteo.net>
>> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
>> Date: Wed, 07 Sep 2022 18:27:18 +0000
>> 
>> Eli Zaretskii <eliz <at> gnu.org> writes:
>> 
>> >> I've just remove the changes to the manual from my patch.
>> >
>> > Why?  That was nowhere near what I intended to say with the above
>> > comments, which were minor.
>> 
>> It wasn't because of your comments, rather I just felt mentioning it was
>> too clumsy, and a few others said they didn't feel it was necessary to
>> mention the option in the manual.  But if you think that it should be
>> added, then I'll try it again and take your comments into account.
>
> Yes, I think it should be in the manual.  But if you'd rather leave
> that to me, I'm fine with that.

Here is my latest attempt (will merge it into the patch):

[Message part 2 (text/plain, inline)]

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 343cc83ce5..f16d0a922e 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -694,7 +694,10 @@ Log Buffer
 (@code{log-edit-generate-changelog-from-diff}), to generate skeleton
 ChangeLog entries, listing all changed file and function names based
 on the diff of the VC fileset.  Consecutive entries left empty will be
-combined by @kbd{C-q} (@code{fill-paragraph}).
+combined by @kbd{C-q} (@code{fill-paragraph}).  By default the
+skeleton will just include the file name, without any leading
+directories.  If you wish to prepend the leading directories up to the
+VC root, customize @code{diff-add-log-use-relative-names}.
 
 @kindex C-c C-a @r{(Log Edit mode)}
 @findex log-edit-insert-changelog

Message #85 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Richard Stallman <rms <at> gnu.org>
To: philipk <at> posteo.net
Cc: 55039 <at> DEBBUGS.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Wed, 07 Sep 2022 22:58:39 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  >   If
  > > +@code{diff-add-log-relative-names} is non-nil, a partial path relative
  > > +to the VC root directory will be inserted instead.

1. Please try to rewrite passive voice sentences using active voice.
Passive voice omits the subject and that tends to reduce clarity.

2. Shouldn't there be @code around `nil' in a Texinfo file?

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Message #88 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 08:38:58 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
> Date: Wed, 07 Sep 2022 21:23:38 +0000
> 
> >> It wasn't because of your comments, rather I just felt mentioning it was
> >> too clumsy, and a few others said they didn't feel it was necessary to
> >> mention the option in the manual.  But if you think that it should be
> >> added, then I'll try it again and take your comments into account.
> >
> > Yes, I think it should be in the manual.  But if you'd rather leave
> > that to me, I'm fine with that.
> 
> Here is my latest attempt (will merge it into the patch):

LGTM, thanks.

Message #91 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Richard Stallman <rms <at> gnu.org>
Cc: 55039 <at> DEBBUGS.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 06:18:48 +0000

Richard Stallman <rms <at> gnu.org> writes:

> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
>
>   >   If
>   > > +@code{diff-add-log-relative-names} is non-nil, a partial path relative
>   > > +to the VC root directory will be inserted instead.
>
> 1. Please try to rewrite passive voice sentences using active voice.
> Passive voice omits the subject and that tends to reduce clarity.
>
> 2. Shouldn't there be @code around `nil' in a Texinfo file?

You are right, but the patch you were commenting on was outdated.

Message #96 received at 55039-done <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 55039-done <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 06:22:13 +0000

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Philip Kaludercic <philipk <at> posteo.net>
>> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
>> Date: Wed, 07 Sep 2022 21:23:38 +0000
>> 
>> >> It wasn't because of your comments, rather I just felt mentioning it was
>> >> too clumsy, and a few others said they didn't feel it was necessary to
>> >> mention the option in the manual.  But if you think that it should be
>> >> added, then I'll try it again and take your comments into account.
>> >
>> > Yes, I think it should be in the manual.  But if you'd rather leave
>> > that to me, I'm fine with that.
>> 
>> Here is my latest attempt (will merge it into the patch):
>
> LGTM, thanks.

Great, I've pushed the commit.

Message #99 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 10:07:00 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
> Date: Tue, 06 Sep 2022 20:11:57 +0000
> 
> >> Also, as the entire point of
> >> the patch was that emacs.git is using relative path names, should a
> >> .dir-locals.el variable be set to ensure this is done?
> >
> > I guess so, yes.  But what would happen to people who use Emacs
> > versions before 29?
> 
> It should have no effect.

Unfortunately, this is not true, at least not the way this was
implemented in our .dir-locals.el.  Now, whenever I visit _any_ file
in the repository, I get this warning pop up:

  The local variables list in d:/gnu/git/emacs/trunk/
  contains values that may not be safe (*).

  Do you want to apply it?  You can type
  y  -- to apply the local variables list.
  n  -- to ignore the local variables list.
  !  -- to apply the local variables list, and permanently mark these
	values (*) as safe (in the future, they will be set automatically.)
  i  -- to ignore the local variables list, and permanently mark these
	values (*) as ignored

      tab-width : 8
      sentence-end-double-space : t
      fill-column : 70
      emacs-lisp-docstring-fill-column : 65
      bug-reference-url-format : "https://debbugs.gnu.org/%s"
    * diff-add-log-use-relative-names : t
      indent-tabs-mode : nil
      electric-quote-comment : nil
      electric-quote-string : nil
      mode : bug-reference-prog

and I _must_ type a response.  If I answer !, Emacs will write to my
init file, which I'm not sure I like; if I type y, I will have to do
that for every file I visit.

This is the nuisance caused by immediately adding newly introduced
variables into file-local or directory-local settings to our
repository.  We should keep this in mind when introducing such stuff.

Message #102 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 08:45:47 +0000

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Philip Kaludercic <philipk <at> posteo.net>
>> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
>> Date: Tue, 06 Sep 2022 20:11:57 +0000
>> 
>> >> Also, as the entire point of
>> >> the patch was that emacs.git is using relative path names, should a
>> >> .dir-locals.el variable be set to ensure this is done?
>> >
>> > I guess so, yes.  But what would happen to people who use Emacs
>> > versions before 29?
>> 
>> It should have no effect.
>
> Unfortunately, this is not true, at least not the way this was
> implemented in our .dir-locals.el.  Now, whenever I visit _any_ file
> in the repository, I get this warning pop up:
>
>   The local variables list in d:/gnu/git/emacs/trunk/
>   contains values that may not be safe (*).
>
>   Do you want to apply it?  You can type
>   y  -- to apply the local variables list.
>   n  -- to ignore the local variables list.
>   !  -- to apply the local variables list, and permanently mark these
> 	values (*) as safe (in the future, they will be set automatically.)
>   i  -- to ignore the local variables list, and permanently mark these
> 	values (*) as ignored
>
>       tab-width : 8
>       sentence-end-double-space : t
>       fill-column : 70
>       emacs-lisp-docstring-fill-column : 65
>       bug-reference-url-format : "https://debbugs.gnu.org/%s"
>     * diff-add-log-use-relative-names : t
>       indent-tabs-mode : nil
>       electric-quote-comment : nil
>       electric-quote-string : nil
>       mode : bug-reference-prog
>
> and I _must_ type a response.  If I answer !, Emacs will write to my
> init file, which I'm not sure I like; if I type y, I will have to do
> that for every file I visit.

I see, should I revert the change?

> This is the nuisance caused by immediately adding newly introduced
> variables into file-local or directory-local settings to our
> repository.  We should keep this in mind when introducing such stuff.

Generally speaking, the ability to set a variable only if the symbol is
bound would be useful for features like these.

Message #105 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: larsi <at> gnus.org, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 12:20:13 +0300

> From: Philip Kaludercic <philipk <at> posteo.net>
> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
> Date: Thu, 08 Sep 2022 08:45:47 +0000
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> >> From: Philip Kaludercic <philipk <at> posteo.net>
> >> Cc: larsi <at> gnus.org,  55039 <at> debbugs.gnu.org
> >> Date: Tue, 06 Sep 2022 20:11:57 +0000
> >> 
> >> >> Also, as the entire point of
> >> >> the patch was that emacs.git is using relative path names, should a
> >> >> .dir-locals.el variable be set to ensure this is done?
> >> >
> >> > I guess so, yes.  But what would happen to people who use Emacs
> >> > versions before 29?
> >> 
> >> It should have no effect.
> >
> > Unfortunately, this is not true, at least not the way this was
> > implemented in our .dir-locals.el.  Now, whenever I visit _any_ file
> > in the repository, I get this warning pop up:
> >
> >   The local variables list in d:/gnu/git/emacs/trunk/
> >   contains values that may not be safe (*).
> >
> >   Do you want to apply it?  You can type
> >   y  -- to apply the local variables list.
> >   n  -- to ignore the local variables list.
> >   !  -- to apply the local variables list, and permanently mark these
> > 	values (*) as safe (in the future, they will be set automatically.)
> >   i  -- to ignore the local variables list, and permanently mark these
> > 	values (*) as ignored
> >
> >       tab-width : 8
> >       sentence-end-double-space : t
> >       fill-column : 70
> >       emacs-lisp-docstring-fill-column : 65
> >       bug-reference-url-format : "https://debbugs.gnu.org/%s"
> >     * diff-add-log-use-relative-names : t
> >       indent-tabs-mode : nil
> >       electric-quote-comment : nil
> >       electric-quote-string : nil
> >       mode : bug-reference-prog
> >
> > and I _must_ type a response.  If I answer !, Emacs will write to my
> > init file, which I'm not sure I like; if I type y, I will have to do
> > that for every file I visit.
> 
> I see, should I revert the change?

Is it possible to make the setting dependent on the Emacs version?

I don't think there's a need to revert, even if we cannot make this
better.  Assuming people want this setting very much, that is.  Just
something to remember for the future: introducing these is not
cost-free.

> > This is the nuisance caused by immediately adding newly introduced
> > variables into file-local or directory-local settings to our
> > repository.  We should keep this in mind when introducing such stuff.
> 
> Generally speaking, the ability to set a variable only if the symbol is
> bound would be useful for features like these.

I don't think that's possible in practice, since many variables are
loaded only when needed.  But if I'm wrong, then yes, it would be good
to have such a capability.

Message #108 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 14:11:35 +0200

Philip Kaludercic <philipk <at> posteo.net> writes:

> Generally speaking, the ability to set a variable only if the symbol is
> bound would be useful for features like these.

Yes, that would be very nice.  But I think introducing something like
that would be difficult...

Introduce a new syntax like

;; Local Variables:
;; foo-bar: t boundp
;; End:

is difficult to make backwards-compatible, but perhaps we can come up
with something that older Emacsen will ignore but newer ones can parse?

We could also introduce a new section for these variables:

;; Boundp Local Variables:
;; foo-bar: t
;; End:

But...  I'm not much fan of that.

Message #111 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Visuwesh <visuweshm <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Philip Kaludercic <philipk <at> posteo.net>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 17:49:19 +0530

[வியாழன் செப்டம்பர் 08, 2022] Lars Ingebrigtsen wrote:

> Philip Kaludercic <philipk <at> posteo.net> writes:
>
>> Generally speaking, the ability to set a variable only if the symbol is
>> bound would be useful for features like these.
>
> Yes, that would be very nice.  But I think introducing something like
> that would be difficult...
>
> Introduce a new syntax like
>
> ;; Local Variables:
> ;; foo-bar: t boundp
> ;; End:
>
> is difficult to make backwards-compatible, but perhaps we can come up
> with something that older Emacsen will ignore but newer ones can parse?

Can we not change where boundp is located?  I.e.,

;; boundp foo-bar: t

?  IMO, this also reads nicely.

Message #114 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Visuwesh <visuweshm <at> gmail.com>
Cc: Philip Kaludercic <philipk <at> posteo.net>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 14:33:44 +0200

Visuwesh <visuweshm <at> gmail.com> writes:

> Can we not change where boundp is located?  I.e.,
>
> ;; boundp foo-bar: t
>
> ?  IMO, this also reads nicely.

But is that backwards-compatible?

Message #117 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org,
 Visuwesh <visuweshm <at> gmail.com>
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 12:43:20 +0000

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Visuwesh <visuweshm <at> gmail.com> writes:
>
>> Can we not change where boundp is located?  I.e.,
>>
>> ;; boundp foo-bar: t
>>
>> ?  IMO, this also reads nicely.
>
> But is that backwards-compatible?
                        ^ typo?

If you meant incompatible, it is any more or less incompatible than
adding the boundp to the end of the line?

Message #120 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org,
 Visuwesh <visuweshm <at> gmail.com>
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 14:44:11 +0200

Philip Kaludercic <philipk <at> posteo.net> writes:

>> But is that backwards-compatible?
>                         ^ typo?

No?

> If you meant incompatible, it is any more or less incompatible than
> adding the boundp to the end of the line?

It was a question -- I wouldn't have asked if I knew what the answer
was.

Message #123 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Robert Pluim <rpluim <at> gmail.com>
To: Visuwesh <visuweshm <at> gmail.com>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Eli Zaretskii <eliz <at> gnu.org>,
 Philip Kaludercic <philipk <at> posteo.net>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 14:52:23 +0200

>>>>> On Thu, 08 Sep 2022 17:49:19 +0530, Visuwesh <visuweshm <at> gmail.com> said:

    Visuwesh> [வியாழன் செப்டம்பர் 08, 2022] Lars Ingebrigtsen wrote:
    >> Philip Kaludercic <philipk <at> posteo.net> writes:
    >> 
    >>> Generally speaking, the ability to set a variable only if the symbol is
    >>> bound would be useful for features like these.
    >> 
    >> Yes, that would be very nice.  But I think introducing something like
    >> that would be difficult...
    >> 
    >> Introduce a new syntax like
    >> 
    >> ;; Local Variables:
    >> ;; foo-bar: t boundp
    >> ;; End:
    >> 
    >> is difficult to make backwards-compatible, but perhaps we can come up
    >> with something that older Emacsen will ignore but newer ones can parse?

    Visuwesh> Can we not change where boundp is located?  I.e.,

    Visuwesh> ;; boundp foo-bar: t

    Visuwesh> ?  IMO, this also reads nicely.

Thereʼs always:

eval: (when (boundp ʼfoo-bar) (setq foo-bar t))

but that causes prompting by default.

Robert
-- 

Message #126 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org,
 Visuwesh <visuweshm <at> gmail.com>
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 12:53:07 +0000

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Philip Kaludercic <philipk <at> posteo.net> writes:
>
>>> But is that backwards-compatible?
>>                         ^ typo?
>
> No?
>
>> If you meant incompatible, it is any more or less incompatible than
>> adding the boundp to the end of the line?
>
> It was a question -- I wouldn't have asked if I knew what the answer
> was.

In that case I am confused, if

;; boundp foo-bar: t

is backwards-compatible it appears preferable.

Message #129 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org,
 Visuwesh <visuweshm <at> gmail.com>
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 14:56:02 +0200

Philip Kaludercic <philipk <at> posteo.net> writes:

> In that case I am confused, if
>
> ;; boundp foo-bar: t
>
> is backwards-compatible it appears preferable.

Now I'm confused!  I'm not sure how you can be confused by a request for
information?

Message #132 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Robert Pluim <rpluim <at> gmail.com>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Visuwesh <visuweshm <at> gmail.com>,
 Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 14:56:56 +0200

>>>>> On Thu, 08 Sep 2022 12:53:07 +0000, Philip Kaludercic <philipk <at> posteo.net> said:

    Philip> Lars Ingebrigtsen <larsi <at> gnus.org> writes:
    >> Philip Kaludercic <philipk <at> posteo.net> writes:
    >> 
    >>>> But is that backwards-compatible?
    >>> ^ typo?
    >> 
    >> No?
    >> 
    >>> If you meant incompatible, it is any more or less incompatible than
    >>> adding the boundp to the end of the line?
    >> 
    >> It was a question -- I wouldn't have asked if I knew what the answer
    >> was.

    Philip> In that case I am confused, if

    Philip> ;; boundp foo-bar: t

    Philip> is backwards-compatible it appears preferable.

File mode specification error: (user-error Malformed local variable line: "boundp foo-bar: t")

Robert
-- 

Message #135 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Robert Pluim <rpluim <at> gmail.com>
Cc: Philip Kaludercic <philipk <at> posteo.net>, Visuwesh <visuweshm <at> gmail.com>,
 Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 15:10:57 +0200

Robert Pluim <rpluim <at> gmail.com> writes:

> File mode specification error: (user-error Malformed local variable
> line: "boundp foo-bar: t")

Thanks.

Message #138 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Visuwesh <visuweshm <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Philip Kaludercic <philipk <at> posteo.net>, Eli Zaretskii <eliz <at> gnu.org>,
 55039 <at> debbugs.gnu.org
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Thu, 08 Sep 2022 18:43:22 +0530

[வியாழன் செப்டம்பர் 08, 2022] Lars Ingebrigtsen wrote:

> Visuwesh <visuweshm <at> gmail.com> writes:
>
>> Can we not change where boundp is located?  I.e.,
>>
>> ;; boundp foo-bar: t
>>
>> ?  IMO, this also reads nicely.
>
> But is that backwards-compatible?

Doesn't seem to be the case unfortunately.  No idea what I was thinking
about when I wrote that.

Message #141 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org,
 Visuwesh <visuweshm <at> gmail.com>
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Sun, 11 Sep 2022 08:16:38 +0000

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Philip Kaludercic <philipk <at> posteo.net> writes:
>
>> In that case I am confused, if
>>
>> ;; boundp foo-bar: t
>>
>> is backwards-compatible it appears preferable.
>
> Now I'm confused!  I'm not sure how you can be confused by a request for
> information?

Never mind, I had misread the thread.  It appears that if
backwards-compatibility is of importance, an additional section would be
necessary.  Perhaps this could also be used as an opportunity to update
how buffer local variables are specified in general.  Are there any
other issues that are known besides this one?

Robert Pluim <rpluim <at> gmail.com> writes:

>>>>>> On Thu, 08 Sep 2022 12:53:07 +0000, Philip Kaludercic <philipk <at> posteo.net> said:
>
>     Philip> Lars Ingebrigtsen <larsi <at> gnus.org> writes:
>     >> Philip Kaludercic <philipk <at> posteo.net> writes:
>     >> 
>     >>>> But is that backwards-compatible?
>     >>> ^ typo?
>     >> 
>     >> No?
>     >> 
>     >>> If you meant incompatible, it is any more or less incompatible than
>     >>> adding the boundp to the end of the line?
>     >> 
>     >> It was a question -- I wouldn't have asked if I knew what the answer
>     >> was.
>
>     Philip> In that case I am confused, if
>
>     Philip> ;; boundp foo-bar: t
>
>     Philip> is backwards-compatible it appears preferable.
>
> File mode specification error: (user-error Malformed local variable line: "boundp foo-bar: t")
>
> Robert

Message #144 received at 55039 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55039 <at> debbugs.gnu.org,
 Visuwesh <visuweshm <at> gmail.com>
Subject: Re: bug#55039: [PATCH] Use VC-relative file names in ChangeLog entries
Date: Sun, 11 Sep 2022 13:08:08 +0200

Philip Kaludercic <philipk <at> posteo.net> writes:

> Perhaps this could also be used as an opportunity to update how buffer
> local variables are specified in general.  Are there any other issues
> that are known besides this one?

There was also discussion about whether to allow some variables to be
set before calling the mode function, and not afterwards.  Major modes
clear local variables, so they have to be set afterwards.  But some
major modes behave differently based on variable settings, so they
should be set first sometimes.

Being able to specify that would also be nice.

Previous Next

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