bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation


From: Stefan Kangas
Subject: bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections
Date: Wed, 7 Feb 2024 12:22:55 -0800

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Tue, 6 Feb 2024 20:26:08 -0800
>> Cc: 68963@debbugs.gnu.org
>> From: Jim Porter <jporterbugs@gmail.com>
>>
>> The use-case I was imagining for this was a person thinking, "What
>> commands does Eshell have for working with [say] directories?"
>
> But then subdivision into sections has other problems.  For example,
> who says that 'ls' is only "for directories", ln, mv, and rm are only
> "for files", and info is "for searching"?  A person can reasonably
> think about these (and others) differently.  And why "basename" is not
> about files?

FWIW, I tend to agree with Eli: having all built-in commands on one page
also provides some benefit, especially to power users (the likely
audience for eshell) that are already familiar with a standard Unix
shell and just wants to know "what's different about Eshell" or "what
does Eshell provide".

However, I agree that the section is a bit long and unwieldy.  To make
it shorter, how about moving the section "Defining new built-in
commands" to some other part of the manual instead?  For example some
chapter that talks about "Extending Eshell" or similar.

Just my two cents.





reply via email to

[Prev in Thread] Current Thread [Next in Thread]