GNU bug report logs - #49306
28.0.50; Info of Eshell/Extension Modules/* is empty

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 49306 in the body.
You can then email your comments to 49306 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: Gabriel <gabriel376 <at> hotmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.0.50; Info of Eshell/Extension Modules/* is empty
Date: Wed, 30 Jun 2021 21:06:29 -0300

Emacs 28 from master branch (HEAD 8ebd8e1fea1d0d925850db97b64bf13a6a1f698b)

1. Open Info (C-h i)
2. Search for Eshell (C-s Eshell)
3. Navigate to 'Extension modules'
4. All child pages are empty:
   * Writing a module
   * Module testing
   * Directory handling
   * Key rebinding:
   * Smart scrolling
   * Terminal emulation

I checked the git history of file 'doc/misc/eshell.texi' and indeed
these sections are empty.

I suggest to either document these sections or remove these entries from
Info to avoid confusion.

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

From: Gabriel <gabriel376 <at> hotmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Re: bug#49306: 28.0.50; Info of Eshell/Extension Modules/* is empty
Date: Wed, 30 Jun 2021 21:20:17 -0300

I just found out on Info 'Eshell/Bugs and Ideas' an entry about
'Documentation incomplete', but this page comes after 'Extension
modules'. Perhaps should we change the order of these pages or be more
explicit that the documentation is incomplete on the blank pages?

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Gabriel <gabriel376 <at> hotmail.com>
Cc: 49306 <at> debbugs.gnu.org
Subject: Re: bug#49306: 28.0.50; Info of Eshell/Extension Modules/* is empty
Date: Sun, 19 Sep 2021 09:36:31 -0700

Gabriel <gabriel376 <at> hotmail.com> writes:

> I just found out on Info 'Eshell/Bugs and Ideas' an entry about
> 'Documentation incomplete', but this page comes after 'Extension
> modules'. Perhaps should we change the order of these pages or be more
> explicit that the documentation is incomplete on the blank pages?

I have added an explicit note on these pages to say that they have not
yet been written.  This change will be in Emacs 28.1.

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

From: Jim Porter <jporterbugs <at> gmail.com>
To: 49306 <at> debbugs.gnu.org
Subject: Re: bug#49306: 28.0.50; Info of Eshell/Extension Modules/* is empty
Date: Thu, 15 Jun 2023 10:12:17 -0700

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

On 6/30/2021 5:20 PM, Gabriel wrote:
> I just found out on Info 'Eshell/Bugs and Ideas' an entry about
> 'Documentation incomplete', but this page comes after 'Extension
> modules'. Perhaps should we change the order of these pages or be more
> explicit that the documentation is incomplete on the blank pages?

Attached are some patches to finish the Eshell documentation, targeting 
Emacs 30 (they could probably be backported to 29 without much work, but 
I've made some other changes to the Eshell manual in 30 already...)

Here are the main notable parts in these patches:

* I moved the documentation for all disabled-by-default commands into 
the Optional Modules section. This way, it's more clearer (IMO) that 
these commands aren't available by default, since all the off-by-default 
features are together.

* I mostly copied the Key Rebinding and Smart Scrolling sections' 
documentation from their corresponding Elisp files. I don't know a ton 
about them (especially not Smart Scrolling), so it would be hard for me 
to write all-new documentation for them. Hopefully what I have here is 
still an improvement.

[0001-doc-misc-eshell.texi-Bugs-and-ideas-Remove-implement.patch (text/plain, attachment)]

[0002-Restructure-Eshell-extension-modules-documentation.patch (text/plain, attachment)]

[0003-Correct-the-Eshell-documentation-about-how-to-write-.patch (text/plain, attachment)]

[0004-Document-optional-Eshell-modules.patch (text/plain, attachment)]

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

From: Jim Porter <jporterbugs <at> gmail.com>
To: 49306-done <at> debbugs.gnu.org
Subject: Re: bug#49306: 28.0.50; Info of Eshell/Extension Modules/* is empty
Date: Sat, 1 Jul 2023 12:28:50 -0700

On 6/15/2023 10:12 AM, Jim Porter wrote:
> Attached are some patches to finish the Eshell documentation, targeting 
> Emacs 30 (they could probably be backported to 29 without much work, but 
> I've made some other changes to the Eshell manual in 30 already...)

I've now pushed these changes to master as 75278855f4a. Closing this 
bug. Of course, if there are any other areas we should add to the Eshell 
documentation, just let me know (probably in a new bug).

Previous Next

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