From: Stefan Kangas <stefankangas@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>, Jim Porter <jporterbugs@gmail.com>
Cc: 68963@debbugs.gnu.org
Subject: bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections
Date: Wed, 7 Feb 2024 12:22:55 -0800 [thread overview]
Message-ID: <CADwFkm=22nAw8=mNBfHv2k4eAf1_r=72_x=kCbHbTXCSASeJ=Q@mail.gmail.com> (raw)
In-Reply-To: <86eddozb72.fsf@gnu.org>
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.
next prev parent reply other threads:[~2024-02-07 20:22 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-07 0:02 bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections Jim Porter
2024-02-07 3:31 ` Eli Zaretskii
2024-02-07 4:26 ` Jim Porter
2024-02-07 12:54 ` Eli Zaretskii
2024-02-07 20:22 ` Stefan Kangas [this message]
2024-02-08 2:05 ` Jim Porter
2024-02-08 7:07 ` Eli Zaretskii
2024-02-08 20:30 ` Jim Porter
2024-02-09 7:05 ` Eli Zaretskii
2024-02-10 1:44 ` Jim Porter
2024-02-08 21:32 ` Stefan Kangas
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='CADwFkm=22nAw8=mNBfHv2k4eAf1_r=72_x=kCbHbTXCSASeJ=Q@mail.gmail.com' \
--to=stefankangas@gmail.com \
--cc=68963@debbugs.gnu.org \
--cc=eliz@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.