all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Jim Porter <jporterbugs@gmail.com>
Cc: 71987@debbugs.gnu.org
Subject: bug#71987: 30.0.60; [PATCH] Document Eshell entry points
Date: Mon, 08 Jul 2024 14:16:12 +0300	[thread overview]
Message-ID: <86a5is16df.fsf@gnu.org> (raw)
In-Reply-To: <e97bb7d2-2836-9dbe-3380-ea48ae3b213c@gmail.com> (message from Jim Porter on Sun, 7 Jul 2024 21:29:22 -0700)

> Date: Sun, 7 Jul 2024 21:29:22 -0700
> From: Jim Porter <jporterbugs@gmail.com>
> 
> Recently, I noticed a fairly important thing missing from the Eshell 
> manual: it never actually tells users how to *start* Eshell!

Ouch!

> As there are several ways, I think it would be useful to describe
> all of them.  Patch attached (intended for Emacs 30).

This is fine for emacs-30, thanks.

> +@deffn Command eshell &optional arg
> +Start a new interactive Eshell session, or switch to an already active
> +session.  The exact behavior depends on the value of @var{arg}
> +(interactively, the prefix argument):
> +
> +@table @asis
> +
> +@item @code{nil}
> +Start or switch to the default Eshell session.

This should tell that this is what happens if the user types just
@kbd{M-x eshell @key{RET}}.  I'd probably also say "@code{nil} or
omitted".

Please also think about adding more indexing for these sections.





  reply	other threads:[~2024-07-08 11:16 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-08  4:29 bug#71987: 30.0.60; [PATCH] Document Eshell entry points Jim Porter
2024-07-08 11:16 ` Eli Zaretskii [this message]
2024-07-09  3:47   ` Jim Porter
2024-07-09 11:33     ` Eli Zaretskii
2024-07-09 17:05       ` Jim Porter

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=86a5is16df.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=71987@debbugs.gnu.org \
    --cc=jporterbugs@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.