New function `locate-user-emacs-file'.

* subr.el (locate-user-emacs-file): New function.
  (user-emacs-directory): Mention it in docstring.

* completion.el (save-completions-file-name):
* filesets.el (filesets-menu-cache-file):
* image-dired.el (image-dired-dir, image-dired-db-file)
  (image-dired-temp-image-file, image-dired-gallery-dir)
  (image-dired-temp-rotate-image-file):
* savehist.el (savehist-file):
* server.el (server-auth-dir):
* startup.el (auto-save-list-file-prefix):
* thumbs.el (thumbs-thumbsdir):
* tutorial.el (tutorial--saved-dir):
* play/gamegrid.el (gamegrid-user-score-file-directory): Use it.

* url.el (url-configuration-directory): Use `locate-user-emacs-file'.

* NEWS: New function `locate-user-emacs-file'.

2 files changed, 8 insertions, 0 deletions

diff --git a/etc/ChangeLog b/etc/ChangeLog
index 2a1ef635321..4afa26a5141 100644
--- a/etc/ChangeLog
+++ b/etc/ChangeLog
@@ -1,3 +1,7 @@
+2008-10-24  Juanma Barranquero  <lekktu@gmail.com>
+
+        * NEWS: New function `locate-user-emacs-file'.
+
 2008-10-18  Ulrich Mueller  <ulm@gentoo.org>
 
         * MACHINES: Add section for SuperH.
diff --git a/etc/NEWS b/etc/NEWS
index d50b9cc4029..70fc968440e 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1636,6 +1636,10 @@ the match data.
 `serial-process-configure' provide a Lisp interface to the new serial
 port support (see Emacs changes, above).
 
+*** `locate-user-emacs-file' helps packages to select the appropriate
+place to save user-specific files.  It defaults to `user-emacs-directory'
+unless the file already exists at $HOME.
+
 ** Miscellaneous new variables
 
 +++