all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Gregor Zattler <grfz@gmx.de>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: 57321@debbugs.gnu.org
Subject: 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	[thread overview]
Message-ID: <87y1vga9ai.fsf@no.workgroup> (raw)
In-Reply-To: <877d31cgp1.fsf@gnus.org>

Hi Lars,
* Lars Ingebrigtsen <larsi@gnus.org> [2022-08-22; 01:36]:
> Gregor Zattler <grfz@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





  reply	other threads:[~2022-08-22  9:59 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-21 15:29 bug#57321: 29.0.50; doc string and customization form for variable auto-save-file-name-transforms suboptimal Gregor Zattler
2022-08-21 23:36 ` Lars Ingebrigtsen
2022-08-22  9:59   ` Gregor Zattler [this message]
2022-08-22 10:18     ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87y1vga9ai.fsf@no.workgroup \
    --to=grfz@gmx.de \
    --cc=57321@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.