all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "francisco.colaco\@gmail.com" <francisco.colaco@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: xdg-directories.el
Date: Wed, 07 Sep 2016 17:18:28 +0300	[thread overview]
Message-ID: <83shtbaj4b.fsf@gnu.org> (raw)
In-Reply-To: <CACwYkzzOh6hpBie+yG3KS72LE4kFo_uQAbNiRGNSLh9uEjhYjQ@mail.gmail.com> (francisco.colaco@gmail.com)

> From: "francisco.colaco@gmail.com" <francisco.colaco@gmail.com>
> Date: Tue, 6 Sep 2016 16:24:56 +0100
> 
> I would request that this package (after revision and a possible API change) becomes part of GNU Emacs.  I would also suggest that ~/.config/emacs/init.el (the result of "(locate-user-emacs-config-file "init.el") becomes in vanilla emacs part of the chain to determine user-init-file.

Thanks.  Some comments below.

 . IMO, we need to figure out where this stuff fits into Emacs.  Do
   the XDG places override the traditional Emacs places, or the other
   way around?  Do we even want this, and if so, why?

 . If the XDG places override the traditional ones, an important
   aspect to consider is the transition period: the first Emacs
   version that turns on this feature will need to help users migrate
   from the old places to the new ones.  This requires support code
   that I don't see in your package.

 . The package in its present form "needs work" before it can be
   admitted into Emacs:

   . The few settings that must be preloaded and the minimal support
     code should go to files.el; the rest of the package doesn't have
     to be preloaded, AFAICT.

   . The package currently depends on s.el for a single function; I
     think that dependency should be removed, and standard facilities
     used instead.

   . The usage of shell commands, such as xdg-user-dir, is
     problematic, at least on non-Posix platforms.  I wonder if that
     script is really needed, or how important it is for the overall
     functionality.  AFAICS, the script just accesses some environment
     variables and reads a file, something we could do from Lisp.

   . Symbols (functions, variables) defined by the package should have
     a unique package-specific prefix, in this case probably "xdg-".

   . Maybe it's just me, but I find some of the terminology, and the
     respective variable/function names, confusing, because they clash
     with the long tradition of the Emacs terminology.  For example,
     "user file" has a precise meaning in Emacs, so the purpose of
     xdg-get-user-file is a surprise.  Likewise with "emacs data
     file".  More generally, the naming convention doesn't sound
     consistent: some functions that return file names are called
     locate-SOME-file, but other similar functions are
     xdg-get-SOME-file.

   . The doc strings need various minor fixes, as they include typos
     and copy/paste errors.

   . A minor nit: GNU coding standards frown on using "path" to refer
     to anything but PATH-style directory lists; use "file name" or
     "directory name" instead.

Thanks for working on this.



  parent reply	other threads:[~2016-09-07 14:18 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-06 15:24 xdg-directories.el francisco.colaco
2016-09-06 21:49 ` xdg-directories.el Noam Postavsky
2016-09-06 22:37   ` xdg-directories.el francisco.colaco
2016-09-07  0:35     ` xdg-directories.el Stefan Monnier
2016-09-07 14:18 ` Eli Zaretskii [this message]
2016-09-07 14:59   ` xdg-directories.el francisco.colaco
2016-09-07 15:21     ` xdg-directories.el Stefan Monnier
2016-09-07 15:31     ` xdg-directories.el francisco.colaco
2016-09-07 15:54       ` xdg-directories.el Eli Zaretskii
2016-09-07 16:13         ` xdg-directories.el francisco.colaco
2016-09-07 16:28           ` xdg-directories.el francisco.colaco
2016-09-07 17:32           ` xdg-directories.el Eli Zaretskii
     [not found]             ` <CACwYkzyjV2jsTX3Cb0Us4tz1WsUP=avurw04Kgq8k52oBZRg_Q@mail.gmail.com>
2016-09-07 18:21               ` xdg-directories.el Eli Zaretskii
2016-09-07 16:46         ` xdg-directories.el Stefan Monnier
2016-09-07 17:24           ` xdg-directories.el Eli Zaretskii

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=83shtbaj4b.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=francisco.colaco@gmail.com \
    /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.