Hi,
I have been experiencing some inconsistencies with org-mode, which I
have been able to trace own to using native compilation and not knowing
where the files from main were.
Attached is a patch in four parts to make natively compiled orgmode more
consistent.
This is a first step and I would like reactions to it, before submitting
a unified patch.
I hope that splitting it up helps understanding the different parts of
my "solution". Maybe some parts can be cherry picked better this way...
best /PA
From e47289a60f225a0fa6d05efec9d38119d886f4a3 Mon Sep 17 00:00:00 2001
From: "Pedro A. Aranda" <paag...@gmail.com>
Date: Sun, 10 Mar 2024 11:23:09 +0100
Subject: [PATCH 1/4] Add 'native' option to 'make help'
---
Makefile | 1 +
1 file changed, 1 insertion(+)
diff --git a/Makefile b/Makefile
index f476a3ea7..35250eed0 100644
--- a/Makefile
+++ b/Makefile
@@ -27,6 +27,7 @@ help helpall::
$(info make all - ditto)
$(info make compile - build Org ELisp files)
$(info make single - build Org ELisp files, single Emacs per source)
+ $(info make native - build Org natively compiled ELisp)
$(info make autoloads - create org-loaddefs.el to load Org in-place)
$(info make test - build Org ELisp files and run test suite)
$(info make vanilla - run Emacs with this Org-mode and no personal config)
--
2.34.1
From 2d3c6b45d435a6356f198c421d71743d9b09efca Mon Sep 17 00:00:00 2001
From: "Pedro A. Aranda" <paag...@gmail.com>
Date: Sun, 10 Mar 2024 11:26:46 +0100
Subject: [PATCH 2/4] Store .eln files alongside the lisp files
---
mk/default.mk | 1 +
1 file changed, 1 insertion(+)
diff --git a/mk/default.mk b/mk/default.mk
index b75aac345..312dbc6aa 100644
--- a/mk/default.mk
+++ b/mk/default.mk
@@ -158,6 +158,7 @@ ELC = $(BATCHL) \
# How to native-compile a single file
ELN = $(BATCHL) \
+ --eval "(startup-redirect-eln-cache \"$(PWD)/lisp\")" \
--eval '(batch-native-compile)'
# How to make a pdf file from a texinfo file
--
2.34.1
From 34787b58add09decbf31e0e583fd315a207ce88d Mon Sep 17 00:00:00 2001
From: "Pedro A. Aranda" <paag...@gmail.com>
Date: Sun, 10 Mar 2024 11:44:38 +0100
Subject: [PATCH 3/4] A short doc for reproducible native compilations when
developing
---
doc/native-devel.org | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 doc/native-devel.org
diff --git a/doc/native-devel.org b/doc/native-devel.org
new file mode 100644
index 000000000..0cc18a6fe
--- /dev/null
+++ b/doc/native-devel.org
@@ -0,0 +1,33 @@
+#+title: A reproducible natively compiled org-mode
+#+subtitle: Release {{{version}}}
+#+author: The Org Mode Developers
+#+language: en
+
+* Introduction
+
+In order to develop and test ~org-mode~ when your Emacs editor
+supports native compilation, there are two things to take into
+account:
+
+1. you will need to =make native= to generate the =.eln= files. These
+ will be stored under the ~lisp/~ directory of your development
+ ~org-mode~ directory.
+2. Add the following code in your Emacs ~early-init.el~ file:
+
+#+BEGIN_SRC emacs-lisp
+(let ((org-devel-path (expand-file-name "<org-mode development dir>/lisp")))
+ (when (file-directory-p org-devel-path)
+ (when (native-comp-available-p)
+ (let ((first (pop native-comp-eln-load-path)))
+ ;; put in second place
+ (add-to-list 'native-comp-eln-load-path org-devel-path t)
+ (add-to-list 'native-comp-eln-load-path first t)))
+ (add-to-list 'load-path org-devel-path)))
+#+END_SRC
+
+putting the correct path for your org-mode development directory. In
+my case, it is =~/Devel/org-mode=, so the first =let= looks like this:
+
+#+BEGIN_SRC emacs-lisp
+(let ((org-devel-path (expand-file-name "~/Devel/org-mode/lisp")))
+#+END_SRC
--
2.34.1
From 0f10451eef8d826ffb31f70f8a6c2db36ebc16a5 Mon Sep 17 00:00:00 2001
From: "Pedro A. Aranda" <paag...@gmail.com>
Date: Sun, 10 Mar 2024 12:06:28 +0100
Subject: [PATCH 4/4] Add cleaning native compilation
---
lisp/Makefile | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/lisp/Makefile b/lisp/Makefile
index c570d9cfa..1f03539c2 100644
--- a/lisp/Makefile
+++ b/lisp/Makefile
@@ -10,13 +10,16 @@ LISPB := $(LISPA:%el=%elc) org-install.elc
LISPF := $(filter-out $(LISPA),$(sort $(wildcard *.el)))
LISPC := $(filter-out $(LISPB) $(LISPN:%el=%elc),$(LISPF:%el=%elc))
LISPN := $(filter-out $(LISPB) $(LISPN:%el=%eln),$(LISPF:%el=%eln))
+# Should not be empty if lisp/<version>/org-lint<hash>.eln exists
+# like after a make native
+ELNDIR := $(shell find . -name org-lint\*.eln -exec dirname {} \;)
_ORGCM_ := dirall single native source slint1 slint2
-include local.mk
.PHONY: all compile compile-dirty \
$(_ORGCM_) $(_ORGCM_:%=compile-%) \
autoloads \
- install clean cleanauto cleanall cleanelc clean-install
+ install clean cleanauto cleanall cleanelc cleaneln clean-install
# do not clean here, done in toplevel make
all compile compile-dirty:: | autoloads
@@ -41,7 +44,7 @@ single:
@$(info ==================== $@ ====================)
native:
@$(info ==================== $@ ====================)
-source: cleanelc
+source: cleanelc cleaneln
@$(info ==================== $@ ====================)
@$(foreach elc,$(LISPC),$(MAKE) $(elc) && $(RM) $(elc);)
slint1:
@@ -78,6 +81,14 @@ cleanauto clean cleanall::
$(RM) $(LISPA) $(LISPB)
clean cleanall cleanelc::
$(RM) *.elc
+ifeq ($(ELNDIR),)
+cleaneln::
+ @-echo "No previous native compilation "
+else
+clean cleanall cleaneln::
+ @-echo "Removing previous native compilation"
+ @$(RM) -rf $(ELNDIR)
+endif
clean-install:
if [ -d $(DESTDIR)$(lispdir) ] ; then \
--
2.34.1
