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

Previous Next

Full log

View this message in rfc822 format

From: Jim Porter <jporterbugs <at> gmail.com>
To: 49306 <at> debbugs.gnu.org
Subject: 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)]

Previous Next

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