From unknown Mon Aug 11 18:54:56 2025 X-Loop: help-debbugs@gnu.org Subject: bug#15906: 24.3.50; Rename `highlight-*' functions Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Nov 2013 18:33:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 15906 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 15906@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.138454032412061 (code B ref -1); Fri, 15 Nov 2013 18:33:02 +0000 Received: (at submit) by debbugs.gnu.org; 15 Nov 2013 18:32:04 +0000 Received: from localhost ([127.0.0.1]:56202 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VhOBY-00038T-7R for submit@debbugs.gnu.org; Fri, 15 Nov 2013 13:32:04 -0500 Received: from eggs.gnu.org ([208.118.235.92]:58695) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VhOBV-00037y-Jq for submit@debbugs.gnu.org; Fri, 15 Nov 2013 13:32:02 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VhOBG-00070S-4g for submit@debbugs.gnu.org; Fri, 15 Nov 2013 13:31:56 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-0.0 required=5.0 tests=BAYES_40 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:47298) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VhOBG-00070N-1z for submit@debbugs.gnu.org; Fri, 15 Nov 2013 13:31:46 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:60375) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VhOB7-0004KV-Fn for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2013 13:31:46 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VhOAy-0006q2-SQ for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2013 13:31:37 -0500 Received: from aserp1040.oracle.com ([141.146.126.69]:46609) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VhOAy-0006po-M6 for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2013 13:31:28 -0500 Received: from ucsinet21.oracle.com (ucsinet21.oracle.com [156.151.31.93]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id rAFIVQWG021249 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 15 Nov 2013 18:31:27 GMT Received: from userz7021.oracle.com (userz7021.oracle.com [156.151.31.85]) by ucsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id rAFIVQr4007363 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Fri, 15 Nov 2013 18:31:26 GMT Received: from abhmp0015.oracle.com (abhmp0015.oracle.com [141.146.116.21]) by userz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id rAFIVQeV007351 for ; Fri, 15 Nov 2013 18:31:26 GMT MIME-Version: 1.0 Message-ID: <24a86bb5-f82f-4211-b0a7-dc40ddd60470@default> Date: Fri, 15 Nov 2013 10:31:24 -0800 (PST) From: Drew Adams X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: ucsinet21.oracle.com [156.151.31.93] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -4.0 (----) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -4.0 (----) The prefix `highlight-' should not be used for something as specific as `hi-lock' highlighting or highlighting to show changes. There are lots of different kinds of highlighting in Emacs. And third party libraries provide many more ways. The latter are requested by convention to use a library prefix. Hi Lock is one kind of highlighting, and quite particular. The "lock" part of its name is significant - it differentiates this highlighting from other highlighting, and it should be present in the function names. These are the functions to rename, with suggested renamings: highlight-lines-matching-regexp -> hi-lock-lines-matching-regexp highlight-phrase -> hi-lock-phrase highlight-regexp -> hi-lock-regexp highlight-changes-mode -> hilit-changes-mode highlight-changes-next-change -> hilit-changes-next-change highlight-changes-previous-change -> hilit-changes-previous-change highlight-changes-remove-highlight -> hilit-changes-remove-highlight highlight-changes-rotate-faces -> hilit-changes-rotate-faces highlight-changes-visible-mode -> hilit-changes-visible-mode highlight-compare-buffers -> hilit-compare-buffers highlight-compare-with-file -> hilit-compare-with-file An alternative for the `hilit-' functions would be to use `changes-' as the prefix. The result is clearer and shorter names, and it puts up front what the highlighting is about: showing changes: changes-highlight-mode changes-highlight-next changes-highlight-previous changes-remove-highlight changes-rotate-faces changes-visible-mode changes-compare-buffers changes-compare-with-file (No need for "highlight" at all in half of these names.) In GNU Emacs 24.3.50.1 (i686-pc-mingw32) of 2013-11-12 on LEG570 Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --enable-checking 'CFLAGS=3D-O0 -g3' CPPFLAGS=3D-DGLYPH_DEBUG= =3D1' From unknown Mon Aug 11 18:54:56 2025 X-Loop: help-debbugs@gnu.org Subject: bug#15906: 24.3.50; Rename `highlight-*' functions Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Apr 2016 14:09:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 15906 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Drew Adams Cc: 15906@debbugs.gnu.org Received: via spool by 15906-submit@debbugs.gnu.org id=B15906.146193891931927 (code B ref 15906); Fri, 29 Apr 2016 14:09:02 +0000 Received: (at 15906) by debbugs.gnu.org; 29 Apr 2016 14:08:39 +0000 Received: from localhost ([127.0.0.1]:55349 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1aw95z-0008It-2N for submit@debbugs.gnu.org; Fri, 29 Apr 2016 10:08:39 -0400 Received: from hermes.netfonds.no ([80.91.224.195]:56033) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1aw95x-0008Il-7J for 15906@debbugs.gnu.org; Fri, 29 Apr 2016 10:08:37 -0400 Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1aw95q-0000yW-O9; Fri, 29 Apr 2016 16:08:36 +0200 From: Lars Ingebrigtsen References: <24a86bb5-f82f-4211-b0a7-dc40ddd60470@default> Date: Fri, 29 Apr 2016 16:08:30 +0200 In-Reply-To: <24a86bb5-f82f-4211-b0a7-dc40ddd60470@default> (Drew Adams's message of "Fri, 15 Nov 2013 10:31:24 -0800 (PST)") Message-ID: <87d1p87bj5.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) Drew Adams writes: > The prefix `highlight-' should not be used for something as specific as > `hi-lock' highlighting or highlighting to show changes. There are lots > of different kinds of highlighting in Emacs. And third party libraries > provide many more ways. The latter are requested by convention to use a > library prefix. > > Hi Lock is one kind of highlighting, and quite particular. The "lock" > part of its name is significant - it differentiates this highlighting > from other highlighting, and it should be present in the function names. > > These are the functions to rename, with suggested renamings: > > highlight-lines-matching-regexp -> hi-lock-lines-matching-regexp > highlight-phrase -> hi-lock-phrase > highlight-regexp -> hi-lock-regexp > highlight-changes-mode -> hilit-changes-mode > highlight-changes-next-change -> hilit-changes-next-change > highlight-changes-previous-change -> hilit-changes-previous-change > highlight-changes-remove-highlight -> hilit-changes-remove-highlight > highlight-changes-rotate-faces -> hilit-changes-rotate-faces > highlight-changes-visible-mode -> hilit-changes-visible-mode > highlight-compare-buffers -> hilit-compare-buffers > highlight-compare-with-file -> hilit-compare-with-file It is perhaps unfortunate that hi-lock has taken these prefixes, but changing this at this point would be too much churn for little gain. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no From debbugs-submit-bounces@debbugs.gnu.org Fri Apr 29 10:08:49 2016 Received: (at control) by debbugs.gnu.org; 29 Apr 2016 14:08:49 +0000 Received: from localhost ([127.0.0.1]:55352 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1aw969-0008JG-9y for submit@debbugs.gnu.org; Fri, 29 Apr 2016 10:08:49 -0400 Received: from hermes.netfonds.no ([80.91.224.195]:56040) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1aw968-0008J9-2i for control@debbugs.gnu.org; Fri, 29 Apr 2016 10:08:48 -0400 Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1aw961-0000yi-5E for control@debbugs.gnu.org; Fri, 29 Apr 2016 16:08:47 +0200 Date: Fri, 29 Apr 2016 16:08:40 +0200 Message-Id: <87bn4s7biv.fsf@gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #15906 X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) tags 15906 wontfix close 15906