Merge branch 'maint'
[org-mode.git] / mk / default.mk
blob94ef825aacc946a1d7c531a847e3ea2172a4ddc6
1 ##----------------------------------------------------------------------
2 ## NEVER EDIT THIS FILE, PUT ANY ADAPTATIONS INTO local.mk
3 ##-8<-------------------------------------------------------------------
4 ## CHECK AND ADAPT THE FOLLOWING DEFINITIONS
5 ##----------------------------------------------------------------------
7 # Name of your emacs binary
8 EMACS = emacs
10 # Where local software is found
11 prefix = /usr/share
13 # Where local lisp files go.
14 lispdir= $(prefix)/emacs/site-lisp/org
16 # Where info files go.
17 infodir = $(prefix)/info
19 # Define if you only need info documentation, the default includes html and pdf
20 #ORG_MAKE_DOC = info # html pdf
22 # Define if you want to include some (or all) files from contrib/lisp
23 # just the filename please (no path prefix, no .el suffix), maybe with globbing
24 #ORG_ADD_CONTRIB = org-e-* org-md org-export # e.g. the new exporter
26 # Where to create temporary files for the testsuite
27 # respect TMPDIR if it is already defined in the environment
28 TMPDIR ?= /tmp
29 testdir = $(TMPDIR)/tmp-orgtest
31 # Configuration for testing
32 # add options before standard load-path
33 BTEST_PRE =
34 # add options after standard load path
35 BTEST_POST =
36 # -L <path-to>/ert # needed for Emacs23, Emacs24 has ert built in
37 # -L <path-to>/ess # needed for running R tests
38 # -L <path-to>/htmlize # need at least version 1.34 for source code formatting
39 BTEST_OB_LANGUAGES = awk C fortran maxima lilypond octave python sh
40 # R # requires ESS to be installed and configured
41 # extra packages to require for testing
42 BTEST_EXTRA =
43 # ess-site # load ESS for R tests
44 ##->8-------------------------------------------------------------------
45 ## YOU MAY NEED TO ADAPT THESE DEFINITIONS
46 ##----------------------------------------------------------------------
48 # How to run tests
49 req-ob-lang = --eval '(require '"'"'ob-$(ob-lang))'
50 req-extra = --eval '(require '"'"'$(req))'
51 BTEST = $(BATCH) \
52 $(BTEST_PRE) \
53 --eval '(add-to-list '"'"'load-path "./lisp")' \
54 --eval '(add-to-list '"'"'load-path "./testing")' \
55 $(BTEST_POST) \
56 -l org-loaddefs.el \
57 -l testing/org-test.el \
58 $(foreach ob-lang,$(BTEST_OB_LANGUAGES),$(req-ob-lang)) \
59 $(foreach req,$(BTEST_EXTRA),$(req-extra)) \
60 --eval '(setq org-confirm-babel-evaluate nil)' \
61 -f org-test-run-batch-tests
63 # Using emacs in batch mode.
64 # BATCH = $(EMACS) -batch -vanilla # XEmacs
65 BATCH = $(EMACS) -batch -Q
67 # Emacs must be started in toplevel directory
68 BATCHO = $(BATCH) \
69 --eval '(add-to-list '"'"'load-path "./lisp")'
71 # How to generate local.mk
72 MAKE_LOCAL_MK = $(BATCHO) \
73 --eval '(load "org-compat.el")' \
74 --eval '(load "../mk/org-fixup.el")' \
75 --eval '(org-make-local-mk)'
77 # Emacs must be started in lisp directory
78 BATCHL = $(BATCH) \
79 --eval '(add-to-list '"'"'load-path ".")'
81 # How to generate org-loaddefs.el
82 MAKE_ORG_INSTALL = $(BATCHL) \
83 --eval '(load "org-compat.el")' \
84 --eval '(load "../mk/org-fixup.el")' \
85 --eval '(org-make-org-loaddefs)'
87 # How to generate org-version.el
88 MAKE_ORG_VERSION = $(BATCHL) \
89 --eval '(load "org-compat.el")' \
90 --eval '(load "../mk/org-fixup.el")' \
91 --eval '(org-make-org-version "$(ORGVERSION)" "$(GITVERSION)")'
93 # How to byte-compile the whole source directory
94 ELCDIR = $(BATCHL) \
95 --eval '(batch-byte-recompile-directory 0)'
97 # How to byte-compile a single file
98 ELC = $(BATCHL) \
99 --eval '(batch-byte-compile)'
101 # How to make a pdf file from a texinfo file
102 TEXI2PDF = texi2pdf --batch --clean
104 # How to make a pdf file from a tex file
105 PDFTEX = pdftex
107 # How to create directories with leading path components
108 # MKDIR = mkdir -m 755 -p # try this if you have no install
109 MKDIR = install -m 755 -d
111 # How to create the info files from the texinfo file
112 MAKEINFO = makeinfo
114 # How to create the HTML file
115 TEXI2HTML = makeinfo --html --number-sections
117 # How to find files
118 FIND = find
120 # How to remove files
121 RM = rm -f
123 # How to remove files recursively
124 RMR = rm -fr
126 # How to copy the lisp files and elc files to their destination.
127 # CP = cp -p # try this if you have no install
128 CP = install -m 644 -p
130 # How to obtain administrative privileges
131 # leave blank if you don't need this
132 # SUDO =
133 SUDO = sudo
135 # Name of the program to install info files
136 # INSTALL_INFO = ginstall-info # Debian: avoid harmless warning message
137 INSTALL_INFO = install-info
139 # target method for 'compile'
140 ORGCM = dirall
141 # ORGCM = dirall # 1x slowdown compared to default compilation method
142 # ORGCM = single # 4x one Emacs process per compilation
143 # ORGCM = source # 5x ditto, but remove compiled file immediately
144 # ORGCM = slint1 # 3x possibly elicit more warnings
145 # ORGCM = slint2 # 7x possibly elicit even more warnings