unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: bug-gnu-emacs@gnu.org
Subject: Re: doc string of insert-default-directory is unclear
Date: Sat, 09 Feb 2008 15:24:32 +0200	[thread overview]
Message-ID: <usl02qn3j.fsf@gnu.org> (raw)
In-Reply-To: <001301c86604$8c9e5c30$2c49908d@us.oracle.com> (drew.adams@oracle.com)

> From: "Drew Adams" <drew.adams@oracle.com>
> Date: Sat, 2 Feb 2008 17:31:49 -0800
> 
> Don't ask me why it's unclear to me, if it's clear to you. In that
> case, just take it that at least one user finds this unclear.
>  
> In previous releases, the doc string said only what its first line
> says. The rest was presumably added in Emacs 22 to clarify the meaning
> and use.

Not just clarify, to document its different semantics.

> Please consider rephrasing the entire doc string. A good starting
> point could be to explain the significance of the initial contents
> being non-empty.

I took a shot at this.  The new doc string is this:

    *Non-nil means when reading a filename start with default dir in minibuffer.

    When the initial minibuffer contents show a name of a file or a directory,
    typing RETURN without editing the initial contents is equivalent to typing
    the default file name.

    If this variable is non-nil, the minibuffer contents are always
    initially non-empty, and typing RETURN without editing will fetch the
    default name, if one is provided.  Note however that this default name
    is not necessarily the same as initial contents inserted in the minibuffer,
    if the initial contents is just the default directory.

    If this variable is nil, the minibuffer often starts out empty.  In
    that case you may have to explicitly fetch the next history element to
    request the default name; typing RETURN without editing will leave
    the minibuffer empty.

    For some commands, exiting with an empty minibuffer has a special meaning,
    such as making the current buffer visit no file in the case of
    `set-visited-file-name'.




  reply	other threads:[~2008-02-09 13:24 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-03  1:31 doc string of insert-default-directory is unclear Drew Adams
2008-02-09 13:24 ` Eli Zaretskii [this message]
2008-02-09 15:59   ` Drew Adams
2008-02-09 16:35     ` Eli Zaretskii
2008-02-09 19:17       ` Drew Adams

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=usl02qn3j.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=bug-gnu-emacs@gnu.org \
    --cc=drew.adams@oracle.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).