GNU bug report logs - #57321
29.0.50; doc string and customization form for variable auto-save-file-name-transforms suboptimal

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 57321 in the body.
You can then email your comments to 57321 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: Gregor Zattler <grfz <at> gmx.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; doc string and customization form for variable
 auto-save-file-name-transforms suboptimal
Date: Sun, 21 Aug 2022 17:29:07 +0200

Dear Emacs developers,

(customize-variable 'auto-save-file-name-transforms)

shows the customization form for this variable accompanied
by a doc string.

According to the doc string the argument UNIQUIFY may have
on of more than two values but the form only gives access to
a toggle switch.

Instead there should be a value menu, IMHO.


The documentation for UNIQUIFY, does not state clearly what
happens if UNIQUIFY is nil and what the perils are.

Where the doc now says "is non-nil" it probably should say
"is t" instead.




Thanks for your attention, Gregor

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Gregor Zattler <grfz <at> gmx.de>
Cc: 57321 <at> debbugs.gnu.org
Subject: Re: bug#57321: 29.0.50; doc string and customization form for
 variable auto-save-file-name-transforms suboptimal
Date: Mon, 22 Aug 2022 01:36:26 +0200

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

Gregor Zattler <grfz <at> gmx.de> writes:

> (customize-variable 'auto-save-file-name-transforms)
>
> shows the customization form for this variable accompanied
> by a doc string.
>
> According to the doc string the argument UNIQUIFY may have
> on of more than two values but the form only gives access to
> a toggle switch.

I'm unable to reproduce this -- with "emacs -Q" in Emacs 29, I get:

[Message part 2 (image/png, inline)]

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

> The documentation for UNIQUIFY, does not state clearly what
> happens if UNIQUIFY is nil and what the perils are.

Well, it doesn't make the names unique, so you could overwrite
a different autosave file, but does that need to be said?

> Where the doc now says "is non-nil" it probably should say
> "is t" instead.

No, all non-nil values (except the ones in secure-hash-algorithms) work
fine.

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

From: Gregor Zattler <grfz <at> gmx.de>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 57321 <at> debbugs.gnu.org
Subject: Re: bug#57321: 29.0.50; doc string and customization form for
 variable auto-save-file-name-transforms suboptimal
Date: Mon, 22 Aug 2022 11:59:17 +0200

Hi Lars,
* Lars Ingebrigtsen <larsi <at> gnus.org> [2022-08-22; 01:36]:
> Gregor Zattler <grfz <at> gmx.de> writes:
>> (customize-variable 'auto-save-file-name-transforms)
>>
>> shows the customization form for this variable accompanied
>> by a doc string.
>>
>> According to the doc string the argument UNIQUIFY may have
>> on of more than two values but the form only gives access to
>> a toggle switch.
>
> I'm unable to reproduce this -- with "emacs -Q" in Emacs 29, I get:
> Hide Auto Save File Name Transforms:
> Repeat:
> [INS] [DEL] List:
>             Regexp: \`/[^/]*:\([^/]*/\)*\([^/]*\)\'
>             Replacement: /tmp/\2
>             Uniquify: [Toggle]  on (non-nil)
> [INS]

You get, what I got.

What I meant was, that one can only toggle the value of
UNIQUIFY from on to off and back, while this argument also
allows for the names of some secure hashes.  Therefore for
the sake of completeness the customization form should
feature a value menu instead of a toggle switch.

>> The documentation for UNIQUIFY, does not state clearly what
>> happens if UNIQUIFY is nil and what the perils are.
>
> Well, it doesn't make the names unique, so you could overwrite
> a different autosave file, but does that need to be said?
>
>> Where the doc now says "is non-nil" it probably should say
>> "is t" instead.
>
> No, all non-nil values (except the ones in secure-hash-algorithms) work
> fine.

The doc string is upside down.  Only after reading the
last part about the secure hashes one knows that "non-nil"
actually means "non-nil except for the names of secure
hashes".

Only when reading the part regarding UNIQUIFY being
"non-nil" one understands that the talk before about
replacing within the regex match actually is about the
directory the auto-saved-files are stored under.



That might not be important, though.  I can easily live
without the doc string being changed, now that I groked it.

Ciao,
--
Gregor

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Gregor Zattler <grfz <at> gmx.de>
Cc: 57321 <at> debbugs.gnu.org
Subject: Re: bug#57321: 29.0.50; doc string and customization form for
 variable auto-save-file-name-transforms suboptimal
Date: Mon, 22 Aug 2022 12:18:25 +0200

Gregor Zattler <grfz <at> gmx.de> writes:

> What I meant was, that one can only toggle the value of
> UNIQUIFY from on to off and back, while this argument also
> allows for the names of some secure hashes.  Therefore for
> the sake of completeness the customization form should
> feature a value menu instead of a toggle switch.

Ah, sorry -- I misunderstood.  I've now fixed the UNIQUIFY defcustom
type.

> The doc string is upside down.  Only after reading the
> last part about the secure hashes one knows that "non-nil"
> actually means "non-nil except for the names of secure
> hashes".

Yes, true.  I've now rephrased it in Emacs 29.

Previous Next

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