From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id cOFBNaaNTGLraQAAgWs5BA (envelope-from ) for ; Tue, 05 Apr 2022 20:42:46 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id 8LU7MqaNTGIaIQAAauVa8A (envelope-from ) for ; Tue, 05 Apr 2022 20:42:46 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id DAD54171B6 for ; Tue, 5 Apr 2022 20:42:45 +0200 (CEST) Received: from localhost ([::1]:42732 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nbo8b-0003Dr-2M for larch@yhetil.org; Tue, 05 Apr 2022 14:42:45 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:41598) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nbo7s-0003Dh-OG for emacs-orgmode@gnu.org; Tue, 05 Apr 2022 14:42:00 -0400 Received: from sanpietro.red-bean.com ([45.79.25.59]:56874) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nbo7q-0001iT-EI for emacs-orgmode@gnu.org; Tue, 05 Apr 2022 14:42:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=red-bean.com; s=202005newsp; h=Content-Type:MIME-Version:Message-ID: In-Reply-To:Date:Reply-To:References:Subject:Cc:To:From:Sender: Content-Transfer-Encoding:Content-ID:Content-Description; bh=mLfdMnvkhT3vIVxGsT5qPTnN1Ypse/imqpj0A3XkglY=; t=1649184115; x=1650393715; b=fGMg5VK7P9nZmukgGVHdnY05w3erGyw77765BFV/6juCK+V36+pwZSznCaQiW/F01wex2DLJgjO U68hsVmni0EWD2CT0I/lPxnnIavYXr7S8eQfqaGzVIb+/YlEQKiM5YJ2v/SzWhk/b+MyC+ACYfG9o DuiJ0ackV9CDJZ+Z5eT3gbO8kKvd3IywaDDIk09fOn3NubmaD3XNmA3AYctCdvFujProdovvZiLlE Y0bGA9evWCayiH0mGNY4M8pTHzgiR4JnUQ+P6/c8+8d1NWS8HFX0FXdYBF713D2+y+zzYmvyvx6pZ v+LnC7yFn8OvacFQs7XiPaqHkMuhXdH5tBlA==; Received: from [12.106.183.66] (port=63954 helo=hummy) by sanpietro.red-bean.com with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1nbo7l-002uhp-NQ; Tue, 05 Apr 2022 18:41:54 +0000 From: Karl Fogel To: Ihor Radchenko Subject: Re: Removing obsolete function `org-truely-invisible-p'. References: <87czmcccrp.fsf@red-bean.com> <87h7b5rm6f.fsf@localhost> <87fsmx8x62.fsf@red-bean.com> <87v8vpf4fl.fsf@localhost> <8735iskegy.fsf@red-bean.com> <87ee2cf45u.fsf@localhost> Date: Tue, 05 Apr 2022 13:41:53 -0500 In-Reply-To: <87ee2cf45u.fsf@localhost> (Ihor Radchenko's message of "Tue, 05 Apr 2022 14:14:05 +0800") Message-ID: <87czhvv0cu.fsf@red-bean.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=45.79.25.59; envelope-from=kfogel@red-bean.com; helo=sanpietro.red-bean.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Karl Fogel Cc: Org Mode Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1649184166; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=mLfdMnvkhT3vIVxGsT5qPTnN1Ypse/imqpj0A3XkglY=; b=J3Pf+EWbJ6aRqMlBEx5e/QGR2L566iJRnnExdC//4XLMSkKAL84md4Em41FtvVcUD74JbU x4QvQS00gvI4XSKvNNFLuwRIprgu/afE6Kw+rrD0nC/SK5utrmf1xRPHS7mxmxkZRemoq+ xggdrXofwWUsk9KRCpKV+vwmTP38clkVlyq3gpf7B/CS5T9BL6J49JnjS5UW0AIUegY81u fhX4r03SRs2YqKyCju9gvLqxqnbwUOj7Mxn9xI2RGe6LC/sYFSV4cOMXOplmhQywiz8qg+ l+Dm6yGVZAKBBxrol1MxSdnPCR4br43cJSOTg+xx8v+OApjrX3dhs0G3EG/u9A== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1649184166; a=rsa-sha256; cv=none; b=SCGj2DstpB7VIk4JHfQ0BDY7ephmetMBG9tyrN9IOsfJLNglkHwXWgSzAeSEiecCT+P12P vXlZBqYaCGVi9ovCeNiZ3S2NXMuiz91eSFA8ESK6bxHKsrZsG8GHcuX1WMsPYRAragARyw UvV3E5JpRWiWpH9tTTQ7Ir9PJTCfrswQ2D8HrGury2VlPCyxEpKxbsF59e2l1/OPlORwWQ 6G6wMhWIxHR5Hqa0iX3yEQunJDq9azDWGQVQPDe/gYlAZXc1TdN+iNgVKw/MUs7QPmWSKP ts5gowcTmEtmA/p/6vINDDNDBPyhc518Xv+ypkITVAc/tCoizfL+8ll43M4R0A== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=red-bean.com header.s=202005newsp header.b=fGMg5VK7; dmarc=fail reason="SPF not aligned (relaxed)" header.from=red-bean.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: 5.33 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=red-bean.com header.s=202005newsp header.b=fGMg5VK7; dmarc=fail reason="SPF not aligned (relaxed)" header.from=red-bean.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: DAD54171B6 X-Spam-Score: 5.33 X-Migadu-Scanner: scn0.migadu.com X-TUID: zrItU+TZXP1L --=-=-= Content-Type: text/plain; format=flowed On 05 Apr 2022, Ihor Radchenko wrote: >Sorry for not being clear. I was referring to the commit message >- it is >what you commonly see in git log. > >Having something like > >>>> commit-hash Mark function obsolete & fix spelling of its name > >in git log is confusing because it is unclear what the commit is >changing. If you look at >https://git.savannah.gnu.org/cgit/emacs/org-mode.git/log/ >then you can see that we generally follow certain style of the >commit messages: changed-file-or-library: What is changed >Also see >https://orgmode.org/worg/org-contribute.html#commit-messages Oh, it was clear you were referring to the commit message -- what I now realize is that you were referring to the first line of the commit message (the summary line). Unfortunately, the 'CONTRIBUTE' file at the top level of the Org Mode source tree gives incomplete guidance on commit messages (it just says to follow what Emacs does, so I did that). I didn't realize that https://orgmode.org/worg/org-contribute.html#commit-messages has further, slightly different guidance. Thanks. I'm happy to adhere to the local standards, once I figure out what they are :-). >I think we have a misunderstanding here. Unused functions are not >necessarily obsolete. For example, we have org-list-to-texinfo, >which is >not used anywhere in the codebase, but could be useful for >developers. > >org-compat.el contains functions that are planned for removal in >future >(and obsolete for the time being), obsolete function/variable >names, and >compatibility functions. > >As I mentioned in my previous email, I am slightly reluctant to >remove >org-truely-invisible-p. It means that it should remain available >and no >plans to remove it should be made (unless there are multiple >devs/users >who prefer removal). Hence, the function should stay in >org-macs.el. >org-macs.el is meant to store general-purpose functions that can >be >useful for development of the whole Org mode ecosystem. > >If we decide that org-truely-invisible-p stays in org-macs, we >should >fix the issue with its name. Renaming requires creating obsolete >function name alias in org-compat.el to make sure that nothing >gets >broken unexpectedly for people who use org-truely-invisible-p >with its >current name. > >Hope I clarified my logic. You did! >FYI, I do not know an easy way to search mailing list archives by >Message-ID. Message-ID itself does not even provide information >which >mailing list it is referring to (maybe it is e.g. Emacs devel). >That's why I prefer links - they can often be found using >archive.org if >nothing. > >On the other hand, extra information would not heart. In addition >to >link. Makes sense, yup. Actually, I usually include the link -- I just didn't think of it in this case because I rarely visit the Org Mode mailing list archives (unlike the Emacs Devel archives, which I often do visit, and therefore my commits in Emacs always include the link when referring to a mailing list post). A revised patch is attached. Now it's so simple that I think the commit message doesn't need to point to the mailing list discussion anyway. Review welcome. Best regards, -Karl --=-=-= Content-Type: text/plain Content-Disposition: attachment; filename=0001-lisp-org-macs.el-Fix-spelling-of-org-truly-invisible.patch >From 2cef1fdbe2b2aa40a2bb081eab4b2e2808000670 Mon Sep 17 00:00:00 2001 From: Karl Fogel Date: Thu, 31 Mar 2022 19:02:38 -0500 Subject: [PATCH] lisp/org-macs.el: Fix spelling of `org-truly-invisible-p' * lisp/org-macs.el (org-truly-invisible-p): Fix spelling of name. * lisp/org-compat.el (org-truely-invisible-p): Add compatibility alias for the old name. --- lisp/org-compat.el | 4 ++++ lisp/org-macs.el | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git lisp/org-compat.el lisp/org-compat.el index 38d330de6..00716ae13 100644 --- lisp/org-compat.el +++ lisp/org-compat.el @@ -752,6 +752,10 @@ context. See the individual commands for more information." (define-obsolete-function-alias 'org-get-last-sibling 'org-get-previous-sibling "9.4") +(define-obsolete-function-alias 'org-truely-invisible-p + 'org-truly-invisible-p "9.6" + "Compatibility alias for legacy misspelling of `org-truly-invisible-p'.") + ;;;; Obsolete link types (eval-after-load 'ol diff --git lisp/org-macs.el lisp/org-macs.el index b39af9103..a09115e7c 100644 --- lisp/org-macs.el +++ lisp/org-macs.el @@ -1151,7 +1151,7 @@ fontification." (folding-only (memq value '(org-hide-block outline))) (t value)))) -(defun org-truely-invisible-p () +(defun org-truly-invisible-p () "Check if point is at a character currently not visible. This version does not only check the character property, but also `visible-mode'." -- 2.35.1 --=-=-=--