--- Begin Message ---
Subject: |
30.0.50; [PATCH] Split Eshell built-in command documentation into subsections |
Date: |
Tue, 6 Feb 2024 16:02:32 -0800 |
Currently, the Eshell manual lists all the built-in commands in one
section, which can make it hard to find the commands related to the
topic you care about. Here's a patch to split this into subsections of
various (loosely-defined) topics.
I welcome any suggestions about the division or the name of the
subsections. For example, I split them into "Commands for Directories"
and "Commands for Files", but an alternate scheme could be "Commands for
Files and Directories" and "Commands for Changing the Current Directory".
Here's how I split the commands up in the patch, so you don't have to
read through a huge diff:
# Commands for Directories
cd, dirs, du, ls, mkdir, popd, pushd, pwd, rmdir
# Commands for Files
cat, cp, diff, ln, mv, rm
# Commands for Searching
grep, agrep, egrep, fgrep, rgrep, glimpse, info, locate, man, occur
# Commands for Variables
env, export, set, setq, unset
# Commands for Using Other Commands
., addpath, alias, compile, jobs, kill, source, time, wait, which
# Miscellaneous Commands
basename, clear, clear-scrollback, date, dirname, echo, eshell-debug,
exit, history, listify, make, printnl, umask, whoami
0001-Split-Eshell-built-in-commands-documentation-into-su.patch
Description: Text document
--- End Message ---
--- Begin Message ---
Subject: |
Re: bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections |
Date: |
Fri, 9 Feb 2024 17:44:59 -0800 |
On 2/8/2024 11:05 PM, Eli Zaretskii wrote:
LGTM, thanks. Yes, index entries should always be before the
corresponding @item's.
Thanks, good to know for sure. Merged to master as de5acc3b0d8, so
closing this now. I'll keep looking for more places to add indexing to
the manual as I go through it.
--- End Message ---