GNU bug report logs - #71987
30.0.60; [PATCH] Document Eshell entry points

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 71987 in the body.
You can then email your comments to 71987 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Jim Porter <jporterbugs <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 30.0.60; [PATCH] Document Eshell entry points
Date: Sun, 7 Jul 2024 21:29:22 -0700

[Message part 1 (text/plain, inline)]

Recently, I noticed a fairly important thing missing from the Eshell 
manual: it never actually tells users how to *start* Eshell! As there 
are several ways, I think it would be useful to describe all of them. 
Patch attached (intended for Emacs 30).

[0001-Document-Eshell-entry-points.patch (text/plain, attachment)]

Message #8 received at 71987 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jim Porter <jporterbugs <at> gmail.com>
Cc: 71987 <at> debbugs.gnu.org
Subject: Re: bug#71987: 30.0.60; [PATCH] Document Eshell entry points
Date: Mon, 08 Jul 2024 14:16:12 +0300

> Date: Sun, 7 Jul 2024 21:29:22 -0700
> From: Jim Porter <jporterbugs <at> 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.

Message #11 received at 71987 <at> debbugs.gnu.org (full text, mbox):

From: Jim Porter <jporterbugs <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 71987 <at> debbugs.gnu.org
Subject: Re: bug#71987: 30.0.60; [PATCH] Document Eshell entry points
Date: Mon, 8 Jul 2024 20:47:00 -0700

[Message part 1 (text/plain, inline)]

On 7/8/2024 4:16 AM, Eli Zaretskii wrote:
> 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.

Done both of these (see attached).

[0001-Document-Eshell-entry-points.patch (text/plain, attachment)]

Message #14 received at 71987 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jim Porter <jporterbugs <at> gmail.com>
Cc: 71987 <at> debbugs.gnu.org
Subject: Re: bug#71987: 30.0.60; [PATCH] Document Eshell entry points
Date: Tue, 09 Jul 2024 14:33:30 +0300

> Date: Mon, 8 Jul 2024 20:47:00 -0700
> Cc: 71987 <at> debbugs.gnu.org
> From: Jim Porter <jporterbugs <at> gmail.com>
> 
> On 7/8/2024 4:16 AM, Eli Zaretskii wrote:
> > 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.
> 
> Done both of these (see attached).

LGTM, thanks.

Message #19 received at 71987-done <at> debbugs.gnu.org (full text, mbox):

From: Jim Porter <jporterbugs <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 71987-done <at> debbugs.gnu.org
Subject: Re: bug#71987: 30.0.60; [PATCH] Document Eshell entry points
Date: Tue, 9 Jul 2024 10:05:21 -0700

On 7/9/2024 4:33 AM, Eli Zaretskii wrote:
> LGTM, thanks.

Thanks. Pushed to the release branch as 37475c9af7a. Closing this bug now.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.