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#60587: Patch for adding links to symbols' help documentation Date: Sat, 14 Jan 2023 09:12:42 +0200 Message-ID: <83sfgd8u8l.fsf@gnu.org> References: <86y1qgr1bf.fsf@duenenhof-wilhelm.de> <86tu13qydg.fsf@duenenhof-wilhelm.de> <83h6x2u74b.fsf@gnu.org> <867cxqui0w.fsf@duenenhof-wilhelm.de> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35950"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 60587@debbugs.gnu.org, monnier@iro.umontreal.ca To: "H. Dieter Wilhelm" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jan 14 08:13:19 2023 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 1pGaj9-0009DI-3d for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 14 Jan 2023 08:13:19 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pGaiu-0005cN-F9; Sat, 14 Jan 2023 02:13:04 -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 1pGais-0005b1-VU for bug-gnu-emacs@gnu.org; Sat, 14 Jan 2023 02:13:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pGais-0004BA-M0 for bug-gnu-emacs@gnu.org; Sat, 14 Jan 2023 02:13:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pGais-0007dA-Bs for bug-gnu-emacs@gnu.org; Sat, 14 Jan 2023 02:13: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: Sat, 14 Jan 2023 07:13:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60587 X-GNU-PR-Package: emacs Original-Received: via spool by 60587-submit@debbugs.gnu.org id=B60587.167368037229316 (code B ref 60587); Sat, 14 Jan 2023 07:13:02 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 14 Jan 2023 07:12:52 +0000 Original-Received: from localhost ([127.0.0.1]:53088 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pGaii-0007cl-5x for submit@debbugs.gnu.org; Sat, 14 Jan 2023 02:12:52 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:33308) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pGaig-0007cY-EN for 60587@debbugs.gnu.org; Sat, 14 Jan 2023 02:12:50 -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 1pGaia-00049j-3d; Sat, 14 Jan 2023 02:12:45 -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=/FpdTe1cFmZsKEEjFdt+gz898IFKnU6TfN0p+sROG5s=; b=aUVbE1NiMwEh CJub4+kPnHXwwliokTU0HLnmUD2aIVIBlSrzGN/zeIwX+Oj7mn+4/0OY03t3KMoIzlSCpbZEFkKnB f4XZMfijhq1sfvfXAiO3hVefm9nWwy33xETZUBAwnTlP30BKElJ2+UJrmgrtTBCIAOE7mAadqzRNO RHs2MleviFbqpVSfjqzXuusbnTS+69HSQihVhOPDY8CDAbLgGZkf//FErnuMMf5aLUlZB88MUeTof YNMAOLk3PL1frGFKRwNaxcYl0B06Zc62lX8WupAmv0PB8rZrSYgPpHLn3+eEVAvrlME6pFYseEoVt 8HpKn5EKVlcHzAYKX/mYmw==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pGaiX-00083q-Lh; Sat, 14 Jan 2023 02:12:43 -0500 In-Reply-To: <867cxqui0w.fsf@duenenhof-wilhelm.de> (dieter@duenenhof-wilhelm.de) 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:253323 Archived-At: > From: "H. Dieter Wilhelm" > Cc: Stefan Monnier , 60587@debbugs.gnu.org > Date: Sat, 14 Jan 2023 00:33:19 +0100 > > Eli Zaretskii writes: > > >> +(require 'button) > >> +(require 'cl-lib) > >> +(require 'help-mode) ;redundant? > > > > If this is added to an existing file, there should be a ^L and some > > heading-style command before it. > > I had a look at the usage of ^L in info.el but I can't discern any rule > or consistency. The number of lines between its page delimiters are > over 900 and below 20. I assume you want me to use ^L to separate a > different topic within info.el? Yes. This has nothing to do with the size of each topic's code. > > Can this be rewritten so as to avoid the need for error-prone updates > > of the sub-expression numbers every time Info-xref-symbol-regexp is > > modified? > > What do you think about the following approach? Something like that, yes. However, ... > (defcustom info-symbol-context > '(( variable . "variable\\|option") > ;; defining symbol as variable > ( function . "function\\|command\\|call") > ;; defining symbol as function > ( face . "face") > ;; defining symbol as face > ( ignore . "symbol\\|program\\|property") > ;; ignore symbols following this context type > ( definition . "source \\(?:code \\)?\\(?:of\\|for\\)")) > ;; function definitions in files > "Help." > :type 'list > :version "30.1" > :group 'info) I'm not sure this should be a defcustom. Do we really expect users to want to customize this? for what reason(s)?