From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id MJceAT3fS2LeBgEAgWs5BA (envelope-from ) for ; Tue, 05 Apr 2022 08:18:37 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id ID96NTzfS2IkYgAAG6o9tA (envelope-from ) for ; Tue, 05 Apr 2022 08:18:36 +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 5ADA73D9FC for ; Tue, 5 Apr 2022 08:18:36 +0200 (CEST) Received: from localhost ([::1]:56180 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nbcWQ-00080b-H2 for larch@yhetil.org; Tue, 05 Apr 2022 02:18:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56598) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nbcRk-0007zV-0R for emacs-orgmode@gnu.org; Tue, 05 Apr 2022 02:13:52 -0400 Received: from mail-pf1-x436.google.com ([2607:f8b0:4864:20::436]:33482) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nbcRh-0005xn-6j for emacs-orgmode@gnu.org; Tue, 05 Apr 2022 02:13:42 -0400 Received: by mail-pf1-x436.google.com with SMTP id b13so11223796pfv.0 for ; Mon, 04 Apr 2022 23:13:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:in-reply-to:references:date:message-id :mime-version; bh=Vx9bJFf4siNj9ecIBUOaS6p1lfDvNx9GJXSK38LDhqs=; b=DCx1vYhtlUkGskmNK1yxCuIy4Rm3Znbt5tylBNmvpRKdNWvNqfUpBz/Y4cms1gw+lX pd1r2hpKTErTYOBRrBOlOZnQmf0jmBBXD0d4m8RhalN6fBZrhkKyhbaByCkORG1MKMeL 0mP+UPIICBWNebJ/AZzDLEnKVVO5Kf0gRL9D6bMqAze+9S7C+TRKkxBwT484DzOv8lSx 4XGzBkT8VItw51YqEyx9Fgd5ChtuDtqOJRBMbeUQzU1lOm9eUIGMRGemVjAJFx8k9gjS Xb4scnLYDGUh1CIx9ZS0VNP6Lg6j+S+mDPMqMEp6DnjSEXFG6DoAN3XhVXh7nw2wNHlm +JMg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references:date :message-id:mime-version; bh=Vx9bJFf4siNj9ecIBUOaS6p1lfDvNx9GJXSK38LDhqs=; b=YCJbeDTeAKG1rhxWpx6VEAYa5CLTCe5nw9sTJRYjU+dMgC4grHeDjpFQ5rC9Zwuna5 Ewugp8AZ6S2D2EOIc5338XqHjRpEoPFfPS31OE5BOHHPInF04HGPjJe7PGLM9Ot+WcIx 2m55WnGLQUjoAUDL6FlpvZ4IZmcr5Ol41zQDJMVy/33ue5tnOTHLy324N8PZbgaAggEd l6YkKoGIOBCJl38OifvWCyB6hOYjCA30NIsq3YMU4XAoilNGdaWGFtvBUMzeEnK2qVGT L/R1pGA5v7vZ2LPkUUg/Jw9RVL6TBev+mj4zlAEdwjYIaq902MaY24iFXSuCaijSKvAf EDhg== X-Gm-Message-State: AOAM532zUbCrTkTVrBmc94EPgBQi1Zkhv/CB+WTU5I1xlfSrgK+5dKyK yo4CFR6SZ8S5nrAGD2ooGYM= X-Google-Smtp-Source: ABdhPJzAP6pGPdI1zdUOhiMgabnG+WKxWcbQs7/H2PRXA8T2nz5s/V19q0U5u1ECDZZbsswV+GWrEQ== X-Received: by 2002:a05:6a00:1702:b0:4fd:aae0:84a1 with SMTP id h2-20020a056a00170200b004fdaae084a1mr2121026pfc.12.1649139219404; Mon, 04 Apr 2022 23:13:39 -0700 (PDT) Received: from localhost ([23.106.161.1]) by smtp.gmail.com with ESMTPSA id b13-20020a056a000ccd00b004fadb6f0299sm14423013pfv.191.2022.04.04.23.13.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 04 Apr 2022 23:13:38 -0700 (PDT) From: Ihor Radchenko To: Karl Fogel Subject: Re: Removing obsolete function `org-truely-invisible-p'. In-Reply-To: <8735iskegy.fsf@red-bean.com> References: <87czmcccrp.fsf@red-bean.com> <87h7b5rm6f.fsf@localhost> <87fsmx8x62.fsf@red-bean.com> <87v8vpf4fl.fsf@localhost> <8735iskegy.fsf@red-bean.com> Date: Tue, 05 Apr 2022 14:14:05 +0800 Message-ID: <87ee2cf45u.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=2607:f8b0:4864:20::436; envelope-from=yantar92@gmail.com; helo=mail-pf1-x436.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 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, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=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: , 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=1649139516; h=from:from:sender:sender: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=Vx9bJFf4siNj9ecIBUOaS6p1lfDvNx9GJXSK38LDhqs=; b=LJgP9S/GGsWXqqQ+O4yBmjTboinBMXpEeXvE+wj5hcy/WXk/p7c9+n6whbTAClVxoJnOS2 vArjWzNFsjx8iarWOsKu77tfH97LABpkcPFR1Qh4LjJvD2OtFEgQGMSgDgfHhxMavvxJ1O qf0nsgZrjOUordAA0jWtkoOV+6S1Yu8n1gYXtEE56h5HkBYNTFJiFBcg17rfyBcbTQTXM/ W9EpRAyO/+VAIUPAviv1abqgBeQya7Klsa2iOcF8k9tXafuy1H2O0yCC91TMwKqoo33MXT HFs2hcMdelAJRFX55ICQdDs8rh0R9RA1EC8dRWnd122PzMR+KbidU+ADqTvYSg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1649139516; a=rsa-sha256; cv=none; b=B0sj62HqIFNQoMrZdwY8TyWT8MsEoNpyJbk6fOCUna82CyCeqszrhy1oxaZLVtqVSnrx72 ZL9QPLJ332QV+vp/kf1IYlutKeyn2XSt3+ImkpSXJ+X5nW1Nwxmh0yKklrNHDNzQyGg/Pv Ccq1ubqSSB1idQaEk3CERx7IYRyyyXREkj6F4AxJiZR2+QdLLH0Gr67Y5U/DPDltaXDJYF gI7BJbgsLsdDcwDQIWM57LKGsDbvVrsjaQaq6068aCzIBxvUCIf4Js48vTGI+Rt+OWFCQr 0qO5T3Uc7QbSyntiONqmcxS6AiqLkuk/xEm9NaLK0GSnkhzWf7/YtzHb4xbVmg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=DCx1vYht; dmarc=pass (policy=none) header.from=gmail.com; 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: -7.07 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=DCx1vYht; dmarc=pass (policy=none) header.from=gmail.com; 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: 5ADA73D9FC X-Spam-Score: -7.07 X-Migadu-Scanner: scn0.migadu.com X-TUID: 1EVKgsHDdVLz Karl Fogel writes: >>> Subject: [PATCH] Mark function obsolete & fix spelling of its >>> name >> >>This commit message is a bit confusing. I would mention the >>function >>name: "Mark `org-truely-invisible-p' obsolete and fix spelling of >>its >>name" > > It does mention both names :-). But I'm happy to rewrite in the > style you suggest above; I was just trying to follow the > CONTRIBUTE guidelines. 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 >>It is too much. >>We can either >>1. Obsolete org-truely-invisible-p. Then, there is not much point >> renaming it. >>2. Rename it without obsoletion. Then, there is not much point >>moving >> the function definition to org-compat. > > Hmm. From the prior conversation in this thread, I thought we'd > decided to do both. There are two separate issues here: > > 1) The function is no longer used in Org Mode or Emacs. > > 2) Unrelatedly, the function's name has a misspelling. > > (1) suggests that the function should be moved to 'org-compat.el' > (if I understand correctly what that file is for). > > (2) is usually fixed with a rename and a compatibility alias -- > i.e., this is what we would do for any function, whether used or > unused. > > In your message 87h7b5rm6f.fsf@localhost of 19 Dec 2021, you > wrote: > >>I feel slightly reluctant about removal. If nothing, this >>function can >>be a reminder about visible-mode and keeping it has little >>downside. >>Though if others think that removing would be better, I would >>also be >>fine with it. >> >>Renaming sounds reasonable. Just need to define obsolete alias >>for the >>old name in org-compat.el. > > My patch was based on the above, and on the fact that obsolete > (i.e., unused) functions apparently get moved to org-compat.el, at > least based on what I see already in that file. 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. >>> From: Ihor Radchenko >>> Subject: Re: Removing obsolete function >>> `org-truely-invisible-p'. >>> To: Karl Fogel >>> Cc: Org Mode >>> Date: Sun, 19 Dec 2021 17:14:32 +0800 >>> Message-ID: <87h7b5rm6f.fsf@localhost> >> >>I usually just leave an ML link in such cases: >>https://orgmode.org/list/87h7b5rm6f.fsf@localhost > > As long as the ML link contains the Message-ID, as appears to be > the case here, yeah. Mailing list archives can move, which causes > links to suddenly stop working. But if the Message-ID is in the > link, then (with a little extra work) one can always find the > message in the new archive. > > (The reason I typically include more is to make things as easy as > possible for those who are searching in a local archive using > their regular mailreader. But I can switch to the above way if > you'd prefer.) 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. Best, Ihor