unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
To: tromey@redhat.com
Cc: joakim@verona.se, emacs-devel@gnu.org
Subject: Re: status of dir-vars or dir-locals inclusion in emacs?
Date: Mon, 03 Sep 2007 14:25:59 -0400	[thread overview]
Message-ID: <E1ISGcZ-00066a-FI@fencepost.gnu.org> (raw)
In-Reply-To: <m3fy1yko15.fsf@fleche.redhat.com> (message from Tom Tromey on Sat, 01 Sep 2007 16:40:22 -0600)

    +  The first approach is to put a special file in the root directory of
    +a project.  When opening a local file, Emacs will search for this file
    +and, if the file exists, Emacs will apply local variable settings from
    +the file to the new buffer.  (This search is skipped for remote
    +files.)

1. Please stick to the present tense all the time in documentation
unless some other tense is mandatory.  So please say "Emacs searches".

Please look for other places in your text where this rule might apply.

2. It took me a couple of seconds to realize why the word "local" is
there and what it means, since in this context "local" usually means
"buffer-local".  I suggest using only the word "remote" and avoiding
use of "local" as its antonym.

3. Please avoid the passive voice, so please write "If the file is
remote, Emacs doesn't do this search, because it would be too slow."

    +  Emacs looks for files named @file{emacs-settings.el},
    +@file{.emacs-settings.el}, or @file{.emacs-settings}, in that order.

...and looks for them in the current directory, its parent, and so on
up the directory hierarchy.

    +  When reading settings from a file like this, Emacs will
    +automatically filter out risky local variables.  This makes it safe
    +for projects to check in appropriate Emacs settings to their version
    +control.

Whether they use version control is irrelevant; you can make the text
simpler by avoiding that tangent.

    +  This example, although incomplete, defines some settings for GNU
    +GCC.

1. In what sense is it imcomplete?

2. "GNU GCC" is redundant.

3. In what sense are these settings "for GCC"?  That is not clear.  I
first interpreted those words as meaning these settings affect use of
GCC.  Do you actually mean that they are used for the source code of
GCC?

4. Why include (tab-width . 8)?  That is the default?

    +  The second approach to project-local settings is to explicitly
    +define a project class using @code{define-project-bindings}, and then
    +to tell Emacs which directory roots correspond to that class, using
    +@code{set-directory-project}.

That needs to give a little more information
or else refer to a place to find more.

    +** project.el is now part of Emacs.  This provides for per-project
    +settings of local variables.
    +

The file name is irrelevant -- please describe the feature, and the
user-interfaces (briefly is enough).

  parent reply	other threads:[~2007-09-03 18:25 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-07-03 13:48 status of dir-vars or dir-locals inclusion in emacs? joakim
2007-07-04  0:25 ` Tom Tromey
2007-07-10 22:01   ` Richard Stallman
2007-07-29 22:59     ` Tom Tromey
2007-07-30 14:45       ` Stefan Monnier
2007-07-30 15:08         ` Tom Tromey
2007-08-03 17:29           ` Vagn Johansen
2007-08-03 22:02             ` Richard Stallman
2007-08-04  7:02               ` David Kastrup
2007-08-05  3:05                 ` Richard Stallman
2007-07-31 17:05       ` Richard Stallman
2007-07-31 18:45         ` Stefan Monnier
2007-09-01 22:40         ` Tom Tromey
2007-09-02 11:56           ` Vagn Johansen
2007-09-03  3:04             ` Richard Stallman
2007-09-03 18:25           ` Richard Stallman [this message]
2007-09-04 21:53             ` Dan Nicolaescu
2007-09-05  3:16               ` Stefan Monnier
2007-09-05 17:32                 ` Dan Nicolaescu
2007-09-05 18:18                   ` Stefan Monnier
2007-09-05 18:04                     ` Tom Tromey
2007-09-05 18:28                   ` David Kastrup
2007-09-05  6:16               ` Richard Stallman
2007-09-05 14:06                 ` Stefan Monnier
2007-09-05 14:36                   ` Davis Herring
2007-09-03 18:26           ` Richard Stallman
2007-07-04 17:04 ` Vagn Johansen
2007-07-05  1:29 ` Richard Stallman

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E1ISGcZ-00066a-FI@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=joakim@verona.se \
    --cc=tromey@redhat.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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).