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: Fri, 09 Feb 2024 09:05:18 +0200 Message-ID: <861q9mw21d.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> <867cjfxwm3.fsf@gnu.org> <1e440e86-1d6f-c52a-8749-4eb28bc51986@gmail.com> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33274"; 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 Fri Feb 09 08:06:00 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 1rYKxT-0008OJ-Tt for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 09 Feb 2024 08:06:00 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rYKxK-0004mj-2c; Fri, 09 Feb 2024 02: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 1rYKxH-0004ky-RT for bug-gnu-emacs@gnu.org; Fri, 09 Feb 2024 02: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 1rYKxH-0007l0-FN for bug-gnu-emacs@gnu.org; Fri, 09 Feb 2024 02:05:47 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rYKxW-0006mH-9E for bug-gnu-emacs@gnu.org; Fri, 09 Feb 2024 02:06: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: Fri, 09 Feb 2024 07: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.170746234226002 (code B ref 68963); Fri, 09 Feb 2024 07:06:02 +0000 Original-Received: (at 68963) by debbugs.gnu.org; 9 Feb 2024 07:05:42 +0000 Original-Received: from localhost ([127.0.0.1]:40560 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rYKxC-0006lJ-0b for submit@debbugs.gnu.org; Fri, 09 Feb 2024 02:05:42 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:57506) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rYKxA-0006kv-GD for 68963@debbugs.gnu.org; Fri, 09 Feb 2024 02:05:40 -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 1rYKwq-0007f0-Ag; Fri, 09 Feb 2024 02:05:20 -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=gHk5ZoGy59qobg8obUvDLKjN3efy3t3Z8dvL02gRjY0=; b=UNPQu2vMKk1E BX0RPvj6tUWPCdQuLT+ZebI8/je1z2vp54uRrTdCUCWTs9xMxAhBN0LLKkZA7b0JRQ9yMzdc6m6Lv +YXH8KZl1Jhe2sOs9uOqaPOSH/KH5hqm6TxEdwNdhyexUF+vMVrzBTpC4/8ITlOlCuaIkSnYt9+q7 8F0UnkOzbF5X1MVVrfUuTF8iYKGZYq95BcWcxjIlPSVxENrm9OrlMRJ3KvrkRaquxNxeUcOcnlgU+ EocZeXDqmNINaj5iGDABllBBnMsrCrSrkD2idz86m7BCYhLpP6xA63AbP24m+MbnUqf2Fpa1Bq7Q3 MW5njTwr8/E1vK+S8gsOPg==; In-Reply-To: <1e440e86-1d6f-c52a-8749-4eb28bc51986@gmail.com> (message from Jim Porter on Thu, 8 Feb 2024 12:30:46 -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:279681 Archived-At: > Date: Thu, 8 Feb 2024 12:30:46 -0800 > Cc: stefankangas@gmail.com, 68963@debbugs.gnu.org > From: Jim Porter > > > 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. > > Attached are some initial improvements to the indexing (patch 0003 in > the series). It would probably be worth adding concept indices to > most/all of the built-in commands, but the few I added here are pretty > straightforward, and I can just poke at this a bit at a time for the > remainder. (Writing documentation isn't the most viscerally exciting > thing to do, so I prefer to spread the work out.) > > I also added patch 0002, which moves the indexing above the "@item"s. > That way, when you navigate to the entry from the index, it shows the > header line listing the supported arguments when viewing the > documentation as HTML. LGTM, thanks. Yes, index entries should always be before the corresponding @item's.