GNU bug report logs - #22625
24.5; Please add index entry for `~ filename suffix' to manual for node `Backup Names'

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 22625 in the body.
You can then email your comments to 22625 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: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.5; Please add index entry for `~ filename suffix' to manual for
 node `Backup Names'
Date: Wed, 10 Feb 2016 15:04:27 -0800 (PST)

Subject line says it all.

See http://emacs.stackexchange.com/q/20216/105.

It's a reasonable question.  A user sees files with `~' at the end of
the name, and wonders what they are.  How to find info about that in the
manual?


In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --host=i686-pc-mingw32'

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 22625-done <at> debbugs.gnu.org
Subject: Re: bug#22625: 24.5;
 Please add index entry for `~ filename suffix' to manual for node
 `Backup Names'
Date: Sat, 13 Feb 2016 15:39:44 +0200

> Date: Wed, 10 Feb 2016 15:04:27 -0800 (PST)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> See http://emacs.stackexchange.com/q/20216/105.
> 
> It's a reasonable question.  A user sees files with `~' at the end of
> the name, and wonders what they are.  How to find info about that in the
> manual?

I added index entries, but I really doubt this will help
discoverability: there are 12 index entries in the manual that include
"~", and the new one I added is the 5th hit...

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

From: Kaushal Modi <kaushal.modi <at> gmail.com>
To: 22625 <at> debbugs.gnu.org
Subject: 24.5; Please add index entry for `~ filename suffix' to manual for
 node `Backup Names'
Date: Sat, 13 Feb 2016 10:24:56 -0500

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

I am not sure I understood the request.

On emacs built from emacs-25 branch (could not verify the same on 24.5), by
doing,

C-h i g (emacs) Backup Names

I get a very good explanation of how the backup files are named.

=====

When Emacs makes a backup file, its name is normally constructed by
appending ‘~’ to the file name being edited; thus, the backup file for
‘eval.c’ would be ‘eval.c~’.

   If access control stops Emacs from writing backup files under the
usual names, it writes the backup file as ‘~/.emacs.d/%backup%~’.  Only
one such file can exist, so only the most recently made such backup is
available.

   Emacs can also make "numbered backup files".  Numbered backup file
names contain ‘.~’, the number, and another ‘~’ after the original file
name.  Thus, the backup files of ‘eval.c’ would be called ‘eval.c.~1~’,
‘eval.c.~2~’, and so on, all the way through names like ‘eval.c.~259~’
and beyond.

[snip]
=====

Should this bug be closed?

--
Kaushal Modi

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Kaushal Modi <kaushal.modi <at> gmail.com>
Cc: 22625 <at> debbugs.gnu.org
Subject: Re: bug#22625: 24.5;
 Please add index entry for `~ filename suffix' to manual for node
 `Backup Names'
Date: Sat, 13 Feb 2016 17:37:36 +0200

> From: Kaushal Modi <kaushal.modi <at> gmail.com>
> Date: Sat, 13 Feb 2016 10:24:56 -0500
> 
> I am not sure I understood the request.
> 
> On emacs built from emacs-25 branch (could not verify the same on 24.5), by doing,
> 
> C-h i g (emacs) Backup Names
> 
> I get a very good explanation of how the backup files are named.

Drew didn't say the text was insufficient, he asked for index
entries.  IOW, how do you find quickly what a tilde at the end of a
file name means?

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: kaushal.modi <at> gmail.com
Cc: 22625 <at> debbugs.gnu.org
Subject: Re: bug#22625: 24.5;
 Please add index entry for `~ filename suffix' to manual for node
 `Backup Names'
Date: Sat, 13 Feb 2016 17:56:56 +0200

> Date: Sat, 13 Feb 2016 17:37:36 +0200
> From: Eli Zaretskii <eliz <at> gnu.org>
> Cc: 22625 <at> debbugs.gnu.org
> 
> Drew didn't say the text was insufficient, he asked for index
> entries.  IOW, how do you find quickly what a tilde at the end of a
> file name means?

Oh, and I already closed the bug.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 22625-done <at> debbugs.gnu.org
Subject: RE: bug#22625: 24.5;	Please add index entry for `~ filename suffix'
 to manual for node	`Backup Names'
Date: Sat, 13 Feb 2016 08:58:17 -0800 (PST)

> I added index entries, but I really doubt this will help
> discoverability: there are 12 index entries in the manual that
> include "~", and the new one I added is the 5th hit...

Thanks, Eli.  I think it will help, nevertheless.  Without this
it is really not easy to ask Emacs what those ~-suffixed files
are.  A user sees them and can wonder what they are.  This will
help.

But I agree with you that when there are multiple index entries
that match a prefix it is cumbersome to notice and get to one
that you might want.  That's a general problem.

Previous Next

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