; Improve doc strings of options related to numbered backups

* lisp/files.el (version-control, dired-kept-versions)
(delete-old-versions, kept-old-versions, kept-new-versions): Doc
fixes.
This commit is contained in:
Eli Zaretskii 2024-09-19 08:20:04 +03:00
parent f0daa2f215
commit 0f0f21b7f2

View file

@ -299,12 +299,12 @@ See also `backup-by-copying' and `backup-by-copying-when-linked'."
:version "23.1") :version "23.1")
(defcustom version-control nil (defcustom version-control nil
"Control use of version numbers for backup files. "Control use of version-numbered backup files.
When t, make numeric backup versions unconditionally. When t, make numbered backup files unconditionally.
When nil, make them for files that have some already. When nil, make them for files that already have numbered backups.
The value `never' means do not make them." The value `never' means never make numbered backups."
:type '(choice (const :tag "Never" never) :type '(choice (const :tag "Never" never)
(const :tag "If existing" nil) (const :tag "If numbered backups exist" nil)
(other :tag "Always" t)) (other :tag "Always" t))
:safe #'version-control-safe-local-p :safe #'version-control-safe-local-p
:group 'backup) :group 'backup)
@ -314,28 +314,36 @@ The value `never' means do not make them."
(or (booleanp x) (equal x 'never))) (or (booleanp x) (equal x 'never)))
(defcustom dired-kept-versions 2 (defcustom dired-kept-versions 2
"When cleaning directory, number of versions to keep." "When cleaning directory, number of versions of numbered backups to keep.
See `version-control', `kept-old-versions' and `kept-new-versions' for
more about keeping and deleting old versioned (a.k.a. \"numbered\")
backup files."
:type 'natnum :type 'natnum
:group 'backup :group 'backup
:group 'dired) :group 'dired)
(defcustom delete-old-versions nil (defcustom delete-old-versions nil
"If t, delete excess backup versions silently. "If t, delete excess numbered backup files silently.
If nil, ask confirmation. Any other value prevents any trimming." If nil, ask confirmation. Any other value prevents any trimming.
See `version-control', `kept-old-versions', `kept-new-versions'
and `dired-kept-versions' for more about keeping and deleting old
versioned (a.k.a. \"numbered\") backup files."
:type '(choice (const :tag "Delete" t) :type '(choice (const :tag "Delete" t)
(const :tag "Ask" nil) (const :tag "Ask" nil)
(other :tag "Leave" other)) (other :tag "Leave" other))
:group 'backup) :group 'backup)
(defcustom kept-old-versions 2 (defcustom kept-old-versions 2
"Number of oldest versions to keep when a new numbered backup is made." "Number of oldest versions to keep when a new numbered backup is made.
See `version-control' for how Emacs decides when to make numbered backups."
:type 'natnum :type 'natnum
:safe #'natnump :safe #'natnump
:group 'backup) :group 'backup)
(defcustom kept-new-versions 2 (defcustom kept-new-versions 2
"Number of newest versions to keep when a new numbered backup is made. "Number of newest versions to keep when a new numbered backup is made.
Includes the new backup. Must be greater than 0." Includes the new backup. Must be greater than 0.
See `version-control' for how Emacs decides when to make numbered backups."
:type 'natnum :type 'natnum
:safe #'natnump :safe #'natnump
:group 'backup) :group 'backup)