From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jim Porter Newsgroups: gmane.emacs.bugs Subject: bug#68963: 30.0.50; [PATCH] Split Eshell built-in command documentation into subsections Date: Wed, 7 Feb 2024 18:05:07 -0800 Message-ID: References: <7c6e1a19-8657-f72a-4372-c1caa34bc4c5@gmail.com> <86mssdymon.fsf@gnu.org> <7ba997dc-80ed-1915-0953-e013fa8a7162@gmail.com> <86eddozb72.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="------------PeoOT01plyx8j2lpzGBIgrF7" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="21903"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 68963@debbugs.gnu.org To: Stefan Kangas , Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Feb 08 03:06:16 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 1rXtnr-0005XA-GE for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 08 Feb 2024 03:06:15 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rXtnS-0000L9-CZ; Wed, 07 Feb 2024 21:05:50 -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 1rXtnQ-0000Ij-Gv for bug-gnu-emacs@gnu.org; Wed, 07 Feb 2024 21:05: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 1rXtnQ-00039C-8k for bug-gnu-emacs@gnu.org; Wed, 07 Feb 2024 21:05:48 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rXtne-0001bd-Ac for bug-gnu-emacs@gnu.org; Wed, 07 Feb 2024 21:06:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jim Porter Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 08 Feb 2024 02:06: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.17073579316129 (code B ref 68963); Thu, 08 Feb 2024 02:06:02 +0000 Original-Received: (at 68963) by debbugs.gnu.org; 8 Feb 2024 02:05:31 +0000 Original-Received: from localhost ([127.0.0.1]:58717 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXtn8-0001an-TZ for submit@debbugs.gnu.org; Wed, 07 Feb 2024 21:05:31 -0500 Original-Received: from mail-pl1-x62b.google.com ([2607:f8b0:4864:20::62b]:54297) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXtn7-0001aY-0y for 68963@debbugs.gnu.org; Wed, 07 Feb 2024 21:05:29 -0500 Original-Received: by mail-pl1-x62b.google.com with SMTP id d9443c01a7336-1d51ba18e1bso12114335ad.0 for <68963@debbugs.gnu.org>; Wed, 07 Feb 2024 18:05:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1707357909; x=1707962709; darn=debbugs.gnu.org; h=in-reply-to:from:references:cc:to:content-language:subject :mime-version:date:message-id:from:to:cc:subject:date:message-id :reply-to; bh=xA/P6xq6Wfn+TrJnTHptFMoNkcFoINr2pgjm1MZhbwo=; b=BDXERp6unkUWaLecbhLjFwRRIP5utiq+O5mCBmntyFyxAR2J7g45OtK/wjtnYfdvew PyLWa5C/w+aj94N/0Ag2/Jyfo4vVRWBI9ik00kss28YIXzVTUzitNB8Dg1Xcwqz/qolu R4oagykAKVPfkaiG/8v5ipldtbS/6Id8Ti+o7nKyyKyawRugISRRQ3WVsp+qDp7+ZffL KVpGyUKWU6d/suPCGmA5fSkpVk3DE14X5gQIX7kjoevLs+pmcposNGmjm74hYQO6VsDp mCDx/1NVnBm7t0gdVFUrm7p8b8h1GGLP2xR+CwkRMyE4p+n8u5klF5j8kNc0oshLr7tV oddg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707357909; x=1707962709; h=in-reply-to:from:references:cc:to:content-language:subject :mime-version:date:message-id:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=xA/P6xq6Wfn+TrJnTHptFMoNkcFoINr2pgjm1MZhbwo=; b=alMvfPWHzVTzwaR0ao40+ICNOQ9Rmf6mWfpCAI6DpTaGvLYWicqAX28kw2WjWGb3ta 60jAh6Kyy2V3zaMAThCHBD6D9uWGiJtM1sRYeqnZTddB2b2BwDKnxFfB7fUsPK+elLyp f/zZZGxJ15ysiNIQLJE3C8IfHAvC7EEC4N8ivDBZeNtyvlaC2XtB7x1KNdBfMjfgFTZ8 ROi8RBUdmVaHseOAY5BRUGVXurL4tbx+A6x7LuQVgjx9105FXZ5GsBRJXNxX9/PfCFo8 v2ETtdcQu/slAPfZjzn7P9AVucFfs0+jiEkiGVcNUlpyVpPbZqL+yPjoWByUyROMd1Dk eZMw== X-Gm-Message-State: AOJu0YxpnPpRFZceI+SHp6ZmKS+ZxJUvfH1CQ5Q2icOD2ak8k43qvBWa BkKdUFe+H2xlixFt7NUnwryRDUiqZpCMStenwx4dkEU4ZhZu7QymgCLkHGkg X-Google-Smtp-Source: AGHT+IE+XEykm3we7QHgNtr0P58yieTc4tjzuqJQGa7xDfBGy72xgPoK7nu3BzrQ9pMCxCWSqvqODA== X-Received: by 2002:a17:903:24c:b0:1d9:a647:5566 with SMTP id j12-20020a170903024c00b001d9a6475566mr8053532plh.4.1707357908954; Wed, 07 Feb 2024 18:05:08 -0800 (PST) X-Forwarded-Encrypted: i=1; AJvYcCWYp4RZRUwXNGvG3SU8wlfBZ+NlgQtHf3ReglRuFc0tERpglVQJ/TTfSl09VW/x2K8Eeacvtvu7B6kqALU= Original-Received: from [192.168.1.2] (076-168-148-233.res.spectrum.com. [76.168.148.233]) by smtp.googlemail.com with ESMTPSA id jd20-20020a170903261400b001d9630e3396sm2161614plb.193.2024.02.07.18.05.07 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 07 Feb 2024 18:05:08 -0800 (PST) Content-Language: en-US In-Reply-To: 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:279591 Archived-At: This is a multi-part message in MIME format. --------------PeoOT01plyx8j2lpzGBIgrF7 Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit 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. > 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. 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. --------------PeoOT01plyx8j2lpzGBIgrF7 Content-Type: text/plain; charset=UTF-8; name="0001-Put-the-list-of-built-in-Eshell-commands-in-its-own-.patch" Content-Disposition: attachment; filename*0="0001-Put-the-list-of-built-in-Eshell-commands-in-its-own-.pa"; filename*1="tch" Content-Transfer-Encoding: base64 RnJvbSA0ZDc0ZmM5ZDUwMGJjYzFiMmFjMzUwYjVkZjNlZGI3YjE2NzFkM2NjIE1vbiBTZXAg MTcgMDA6MDA6MDAgMjAwMQpGcm9tOiBKaW0gUG9ydGVyIDxqcG9ydGVyYnVnc0BnbWFpbC5j b20+CkRhdGU6IFdlZCwgNyBGZWIgMjAyNCAxNzo1ODozMSAtMDgwMApTdWJqZWN0OiBbUEFU Q0hdIFB1dCB0aGUgbGlzdCBvZiBidWlsdC1pbiBFc2hlbGwgY29tbWFuZHMgaW4gaXRzIG93 biBtYW51YWwKIG5vZGUKCiogZG9jL21pc2MvZXNoZWxsLnRleGkgKEJ1aWx0LWlucyk6IEZp eCBjYXBpdGFsaXphdGlvbiBvZiBub2RlIHRvIGJlCm1vcmUgY29uc2lzdGVudCB3aXRoIHRo ZSByZXN0IG9mIHRoZSBtYW51YWwuICBGaXggYSBjcm9zcyByZWZlcmVuY2UuCkxpc3QgY2hp bGQgbm9kZXMuCihMaXN0IG9mIEJ1aWx0LWlucyk6IE5ldyBzZWN0aW9uIGFuZCBub2RlLgoo RGVmaW5pbmcgTmV3IEJ1aWx0LWlucyk6IE1ha2UgdGhpcyBhIG5vZGUuICBGaXggY2FwaXRh bGl6YXRpb24uCi0tLQogZG9jL21pc2MvZXNoZWxsLnRleGkgfCAxNiArKysrKysrKysrKysr LS0tCiAxIGZpbGUgY2hhbmdlZCwgMTMgaW5zZXJ0aW9ucygrKSwgMyBkZWxldGlvbnMoLSkK CmRpZmYgLS1naXQgYS9kb2MvbWlzYy9lc2hlbGwudGV4aSBiL2RvYy9taXNjL2VzaGVsbC50 ZXhpCmluZGV4IDVkM2U1YzdkYmQ2Li45ZTVlZWE2Y2I2MSAxMDA2NDQKLS0tIGEvZG9jL21p c2MvZXNoZWxsLnRleGkKKysrIGIvZG9jL21pc2MvZXNoZWxsLnRleGkKQEAgLTQxNiw3ICs0 MTYsNyBAQCBBcmd1bWVudHMKIEBlbmQgdGFibGUKIAogQG5vZGUgQnVpbHQtaW5zCi1Ac2Vj dGlvbiBCdWlsdC1pbiBjb21tYW5kcworQHNlY3Rpb24gQnVpbHQtaW4gQ29tbWFuZHMKIEVz aGVsbCBwcm92aWRlcyBhIG51bWJlciBvZiBidWlsdC1pbiBjb21tYW5kcywgbWFueSBvZiB0 aGVtCiBpbXBsZW1lbnRpbmcgY29tbW9uIGNvbW1hbmQtbGluZSB1dGlsaXRpZXMsIGJ1dCBl bmhhbmNlZCBmb3IgRXNoZWxsLgogKFRoZXNlIGJ1aWx0LWluIGNvbW1hbmRzIGFyZSBqdXN0 IG9yZGluYXJ5IExpc3AgZnVuY3Rpb25zIHdob3NlIG5hbWVzCkBAIC00NzcsNyArNDc3LDE2 IEBAIEJ1aWx0LWlucwogQGNvbW1hbmR7bG59IGlzIHRoZSBjdXJyZW50IGRpcmVjdG9yeS4K IAogQSBmZXcgY29tbWFuZHMgYXJlIHdyYXBwZXJzIGZvciBtb3JlIG5pY2hlIEVtYWNzIGZl YXR1cmVzLCBhbmQgY2FuIGJlCi1sb2FkZWQgYXMgcGFydCBvZiB0aGUgZXNoZWxsLXh0cmEg bW9kdWxlLiAgQHhyZWZ7RXh0ZW5zaW9uIG1vZHVsZXN9LgorbG9hZGVkIGFzIHBhcnQgb2Yg dGhlIEBjb2Rle2VzaGVsbC14dHJhfSBtb2R1bGUuICBAeHJlZntFeHRyYSBidWlsdC1pbgor Y29tbWFuZHN9LgorCitAbWVudQorKiBMaXN0IG9mIEJ1aWx0LWluczo6CisqIERlZmluaW5n IE5ldyBCdWlsdC1pbnM6OgorQGVuZCBtZW51CisKK0Bub2RlIExpc3Qgb2YgQnVpbHQtaW5z CitAc3Vic2VjdGlvbiBMaXN0IG9mIEJ1aWx0LWluIENvbW1hbmRzCiAKIEB0YWJsZSBAY29k ZQogCkBAIC0xMTk1LDcgKzEyMDQsOCBAQCBCdWlsdC1pbnMKIGFzc29jaWF0ZWQgd2l0aCB0 aGF0IGNvbm5lY3Rpb24uCiBAZW5kIHRhYmxlCiAKLUBzdWJzZWN0aW9uIERlZmluaW5nIG5l dyBidWlsdC1pbiBjb21tYW5kcworQG5vZGUgRGVmaW5pbmcgTmV3IEJ1aWx0LWlucworQHN1 YnNlY3Rpb24gRGVmaW5pbmcgTmV3IEJ1aWx0LWluIENvbW1hbmRzCiBXaGlsZSBFc2hlbGwg Y2FuIHJ1biBMaXNwIGZ1bmN0aW9ucyBkaXJlY3RseSBhcyBjb21tYW5kcywgaXQgbWF5IGJl CiBtb3JlIGNvbnZlbmllbnQgdG8gcHJvdmlkZSBhIHNwZWNpYWwgYnVpbHQtaW4gY29tbWFu ZCBmb3IKIEVzaGVsbC4gIEJ1aWx0LWluIGNvbW1hbmRzIGFyZSBqdXN0IG9yZGluYXJ5IExp c3AgZnVuY3Rpb25zIGRlc2lnbmVkCi0tIAoyLjI1LjEKCg== --------------PeoOT01plyx8j2lpzGBIgrF7--