GNU bug report logs - #79322
file name transforms inconsistencies

Previous Next

Full log

View this message in rfc822 format

From: Gabriel do Nascimento Ribeiro <gabriel376 <at> hotmail.com>
To: 79322 <at> debbugs.gnu.org
Subject: bug#79322: file name transforms inconsistencies
Date: Wed, 27 Aug 2025 16:00:26 +0000

The user option 'lock-file-name-transforms' docstring (and Info node) mentions
that its syntax is the same of 'auto-save-file-name-transforms', which is not
true since the former does not allow secure-hash as the latter does:

       lock-file-name-transforms is a variable defined in ‘files.el’.

       Its value is nil

       Transforms to apply to buffer file name before making a lock file name.
       This has the same syntax as ‘auto-save-file-name-transforms’,
       but applies to lock file names instead of auto-save file names.

If a user tries to use the same syntax, e.g.:

    (setopt lock-file-name-transforms '((".*"  "~/.lock-files/" sha1)))

it gives the following warning:

    Warning (emacs): Value ‘((".*" "~/.lock-files/" sha1))’ for variable
    ‘lock-file-name-transforms’ does not match its type "(repeat (list (regexp
    :tag Regexp) (string :tag Replacement) (boolean :tag Uniquify)))"

It would be great if both 'lock-file-name-transforms' and
'backup-directory-alist' had support to secure-hash.  If for some reason this is
not possible or desirable, I suggest to update the docstring and Info node of
'lock-file-name-transforms', so it mentions that only supports uniquify t.

Lastly, I suggest to also add uniquify nil to the :type of
'auto-save-file-name-transforms', to make it possible to use it in elisp and
Customize.  For instance, if a user set a hash using Customize, it's not
possible to revert it back to nil.  E.g. using elisp:

         (setopt auto-save-file-name-transforms '((".*"  "~/.auto-saves/")))

         Warning (emacs): Value ‘((".*" "~/.auto-saves/"))’ for variable
         ‘auto-save-file-name-transforms’ does not match its type "(repeat (list
         (regexp :tag Regexp) (string :tag Replacement) (choice (const :tag
         Uniquify t) (const md5) (const sha1) (const sha224) (const sha256)
         (const sha384) (const sha512))))"

         (setopt auto-save-file-name-transforms '((".*"  "~/.auto-saves/" nil)))

         Warning (emacs): Value ‘((".*" "~/.auto-saves/" nil))’ for variable
         ‘auto-save-file-name-transforms’ does not match its type "(repeat (list
         (regexp :tag Regexp) (string :tag Replacement) (choice (const :tag
         Uniquify t) (const md5) (const sha1) (const sha224) (const sha256)
         (const sha384) (const sha512))))"

---
Gabriel

Previous Next

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