Getting rid of org-install.el

Getting rid of org-install.el

[Stefan Kangas]

[-- Attachment #1: Type: text/plain, Size: 592 bytes --]

org-install.el has been obsolete for more than 10 years.

To finally get rid of this file, I put it to you that all we need to do is:

1. Move it in emacs.git from lisp/org/org-install.el to
lisp/obsolete/org-install.el
2. Delete the file from org-mode.git

This means that all users (of old and new versions) will have a bundled
org-install.el so that requiring it still works, but on Emacs 29 or later
you will get the usual obsoletion warnings.  The file would finally be
removed from emacs.git in another decade or so according to current Emacs
maintenance practices.

What do you think?

[-- Attachment #2: Type: text/html, Size: 740 bytes --]

Re: Getting rid of org-install.el

[Ihor Radchenko]

Stefan Kangas <stefan@marxist.se> writes:

> org-install.el has been obsolete for more than 10 years.
> ...
> 2. Delete the file from org-mode.git
> ...
> What do you think?

Sounds good to me.

Best,
Ihor

Re: Getting rid of org-install.el

[Stefan Kangas]

[-- Attachment #1: Type: text/plain, Size: 157 bytes --]

Ihor Radchenko <yantar92@gmail.com> writes:

> > 2. Delete the file from org-mode.git
> > ...
> > What do you think?
>
> Sounds good to me.

Patch attached.

[-- Attachment #2: 0001-lisp-org-install.el-Delete-file.patch --]
[-- Type: text/x-patch, Size: 1065 bytes --]

From d609398f5a42a0157c309ead3e38be8ea78456f8 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Wed, 29 Jun 2022 05:36:47 +0200
Subject: [PATCH] * lisp/org-install.el: Delete file.

See: <https://lists.gnu.org/r/emacs-orgmode/2022-06/msg00822.html>
---
 lisp/org-install.el | 17 -----------------
 1 file changed, 17 deletions(-)
 delete mode 100644 lisp/org-install.el

diff --git a/lisp/org-install.el b/lisp/org-install.el
deleted file mode 100644
index d521d819d..000000000
--- a/lisp/org-install.el
+++ /dev/null
@@ -1,17 +0,0 @@
-;;; org-install.el --- backward compatibility file for obsolete configuration  -*- lexical-binding: t -*-
-;;
-;;; Code:
-;;
-;; The file org-install is obsolete.
-;;
-;; It is provided here so that (require 'org-install) does not
-;; trigger an error for users with obsolete Emacs configuration.
-;; You can safely remove (require 'org-install) from your config."
-\f
-(provide 'org-install)
-\f
-;; Local Variables:
-;; no-byte-compile: t
-;; coding: utf-8
-;; End:
-;;; org-install.el ends here
-- 
2.30.2

Re: Getting rid of org-install.el

[Ihor Radchenko]

Stefan Kangas <stefan@marxist.se> writes:

> Ihor Radchenko <yantar92@gmail.com> writes:
>
>> > 2. Delete the file from org-mode.git
>> > ...
>> > What do you think?
>>
>> Sounds good to me.
>
> Patch attached.

Applied onto main via ea05f4343.
I removed the dot after the commit message.

Best,
Ihor

Re: Getting rid of org-install.el

[Kyle Meyer]

Stefan Kangas writes:

> org-install.el has been obsolete for more than 10 years.
>
> To finally get rid of this file, I put it to you that all we need to do is:
>
> 1. Move it in emacs.git from lisp/org/org-install.el to
> lisp/obsolete/org-install.el
> 2. Delete the file from org-mode.git

In my view it'd be better to drop the first item.  Org has removed
plenty of obsolete features in its time, but searching the emacs.git
history, I can't find a case where an Org-related file has been in
lisp/obsolete/.  I'd vote against setting that precedent, as I don't
want to introduce any more discrepancies between the Org files in
org-mode.git and emacs.git than necessary.

Re: Getting rid of org-install.el

[Stefan Kangas]

Kyle Meyer <kyle@kyleam.com> writes:

> In my view it'd be better to drop the first item.  Org has removed
> plenty of obsolete features in its time, but searching the emacs.git
> history, I can't find a case where an Org-related file has been in
> lisp/obsolete/.  I'd vote against setting that precedent, as I don't
> want to introduce any more discrepancies between the Org files in
> org-mode.git and emacs.git than necessary.

Fine by me, though I don't think it's a very strong precedent; it
could be a one-off.

If we do it your way, does someone need to remember to delete the file
manually when the time comes to move the emacs.git master branch to
the latest Org release?  Or will that be done automagically?

Re: Getting rid of org-install.el

[Kyle Meyer]

Stefan Kangas writes:

> If we do it your way, does someone need to remember to delete the file
> manually when the time comes to move the emacs.git master branch to
> the latest Org release?  Or will that be done automagically?

My script for syncing the Org tree to the Emacs's does

  rm "$emacsrepo"/lisp/org/*.el
  cp "$orgrepo"/lisp/*.el "$emacsrepo"/lisp/org/

so that deletions/renames on Org's side are propagated.

Those aren't too frequent, but of course still need to be accounted for:

  $ git rev-parse HEAD
  6dc785288d3514af4071f210dac0a18c14a6c45b

  $ git log --since=2015 --format='%cs %s' --diff-filter=D --no-renames \
    bugfix -- 'lisp/*.el'
  2021-09-28 lisp/ob-stan.el: Delete
  2021-09-26 Move some ob-*el files to the new org-contrib repo
  2019-03-10 Prefix link-related libraries filenames with "ol"
  2018-10-03 org-keys: Extract key bindings into their own library
  2017-08-18 Remove ob-scala.el