From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections Date: Thu, 08 Feb 2024 09:07:16 +0200 Message-ID: <867cjfxwm3.fsf@gnu.org> References: <7c6e1a19-8657-f72a-4372-c1caa34bc4c5@gmail.com> <86mssdymon.fsf@gnu.org> <7ba997dc-80ed-1915-0953-e013fa8a7162@gmail.com> <86eddozb72.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35762"; mail-complaints-to="usenet@ciao.gmane.io" Cc: stefankangas@gmail.com, 68963@debbugs.gnu.org To: Jim Porter Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Feb 08 08:08:04 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rXyVv-00093C-Rv for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 08 Feb 2024 08:08:03 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rXyVh-0005NS-NJ; Thu, 08 Feb 2024 02:07:49 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rXyVg-0005Mm-9A for bug-gnu-emacs@gnu.org; Thu, 08 Feb 2024 02:07:48 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rXyVg-0001Wb-0w for bug-gnu-emacs@gnu.org; Thu, 08 Feb 2024 02:07:48 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rXyVu-00021N-6V for bug-gnu-emacs@gnu.org; Thu, 08 Feb 2024 02:08:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 08 Feb 2024 07:08:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68963 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 68963-submit@debbugs.gnu.org id=B68963.17073760597720 (code B ref 68963); Thu, 08 Feb 2024 07:08:02 +0000 Original-Received: (at 68963) by debbugs.gnu.org; 8 Feb 2024 07:07:39 +0000 Original-Received: from localhost ([127.0.0.1]:58856 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXyVX-00020R-G2 for submit@debbugs.gnu.org; Thu, 08 Feb 2024 02:07:39 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56994) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXyVV-00020B-T1 for 68963@debbugs.gnu.org; Thu, 08 Feb 2024 02:07:38 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rXyVC-0001H5-59; Thu, 08 Feb 2024 02:07:18 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=dQHnpQIzlttlxFFsmmmmV94Jk+sp96a3hyZ5zh3G+dY=; b=oAIclNsw+PU0 zZDnFdbEAiRkXjbOX+/HGdxHIc3EyRC8tCVN4DTiLPHZgaOSta0RMQXdxK0Unkc6vlcagrYinabdE F0Ba+KNSg657t+ygulbvvcpXNPLoZUw3ch2ax170mUw57erW7DROQ2grWL5J1mAAH8R+FhXZoK4Sf JhkaJeZbcd1yPEOECdV8JUmFU/Cpe0rK/NHDasZvAo7+hHmpGdttcNO+Ks8TrVCgi7Pj3FzBRcNPG u0Q+3Z6g1XlBJN6/fQM16cYKrmDZKJ22iS2bZfN7E8zPTzvgCqpbkmg17kFobExSX/23KbNDn1N74 5F2myAjwakjo3z9ePCP10g==; In-Reply-To: (message from Jim Porter on Wed, 7 Feb 2024 18:05:07 -0800) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:279603 Archived-At: > Date: Wed, 7 Feb 2024 18:05:07 -0800 > Cc: 68963@debbugs.gnu.org > From: Jim Porter > > On 2/7/2024 12:22 PM, Stefan Kangas wrote: > > Eli Zaretskii writes: > > > >> 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". > > Ok, no problem. It just seemed a bit hard to navigate to me, but I don't > have any issues with keeping all the commands together. I'm not against subdividing that section. My point was that if you want these commands to be easier to find, the subdivision itself is not enough; you need additional measures. > How about the attached patch instead? It just moves the list of commands > to a sub-node, and also makes the "defining new built-ins" a proper > sub-node too. That should keep things a bit easier to navigate, and then > we can add more indexing as needed later. No objections here. But once again: your points about being able to find the commands by categories are well-taken, and adding indexing to make that easier would also be a good change. Thanks.