org.el: Small docstring clean-up
[org-mode.git] / default.mk
blob27d4879363dc6e6aadca55b048e996b918f7154c
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 local data files go.
17 datadir = $(prefix)/emacs/etc/org
19 # Where info files go.
20 infodir = $(prefix)/info
22 # Define if you only need info documentation, the default includes html and pdf
23 #ORG_MAKE_DOC = info # html pdf
25 # Where to create temporary files for the testsuite
26 # respect TMPDIR if it is already defined in the environment
27 TMPDIR ?= /tmp
28 testdir = $(TMPDIR)/tmp-orgtest
30 # Configuration for testing
31 # add options before standard load-path
32 BTEST_PRE =
33 # add options after standard load path
34 BTEST_POST =
35 # -L <path-to>/ert # needed for Emacs23, Emacs24 has ert built in
36 # -L <path-to>/ess # needed for running R tests
37 # -L <path-to>/htmlize # need at least version 1.34 for source code formatting
38 BTEST_OB_LANGUAGES = awk C fortran maxima lilypond octave python sh
39 # R # requires ESS to be installed and configured
40 # extra packages to require for testing
41 BTEST_EXTRA =
42 # ess-site # load ESS for R tests
43 ##->8-------------------------------------------------------------------
44 ## YOU MAY NEED TO ADAPT THESE DEFINITIONS
45 ##----------------------------------------------------------------------
47 # How to run tests
48 req-ob-lang = --eval '(require '"'"'ob-$(ob-lang))'
49 req-extra = --eval '(require '"'"'$(req))'
50 BTEST = $(BATCH) \
51 $(BTEST_PRE) \
52 --eval '(add-to-list '"'"'load-path "./lisp")' \
53 --eval '(add-to-list '"'"'load-path "./testing")' \
54 $(BTEST_POST) \
55 -l org-install.el \
56 -l testing/org-test.el \
57 $(foreach ob-lang,$(BTEST_OB_LANGUAGES),$(req-ob-lang)) \
58 $(foreach req,$(BTEST_EXTRA),$(req-extra)) \
59 --eval '(setq org-confirm-babel-evaluate nil)' \
60 -f org-test-run-batch-tests
62 # Using emacs in batch mode.
63 # BATCH = $(EMACS) -batch -vanilla # XEmacs
64 BATCH = $(EMACS) -batch -Q
66 # How to generate local.mk
67 MAKE_LOCAL_MK = $(BATCH) \
68 --eval '(add-to-list '"'"'load-path "./lisp")' \
69 --eval '(load "org-compat.el")' \
70 --eval '(load "../UTILITIES/org-fixup.el")' \
71 --eval '(org-make-local-mk)'
73 # Emacs must be started in lisp directory
74 BATCHL = $(BATCH) \
75 --eval '(add-to-list '"'"'load-path ".")'
77 # How to generate org-install.el
78 MAKE_ORG_INSTALL = $(BATCHL) \
79 --eval '(load "org-compat.el")' \
80 --eval '(load "../UTILITIES/org-fixup.el")' \
81 --eval '(org-make-org-install)'
83 # How to generate org-version.el
84 MAKE_ORG_VERSION = $(BATCHL) \
85 --eval '(load "org-compat.el")' \
86 --eval '(load "../UTILITIES/org-fixup.el")' \
87 --eval '(org-make-org-version "$(ORGVERSION)" "$(GITVERSION)" "$(datadir)")'
89 # How to byte-compile the whole source directory
90 ELCDIR = $(BATCHL) \
91 --eval '(batch-byte-recompile-directory 0)'
93 # How to byte-compile a single file
94 ELC = $(BATCHL) \
95 --eval '(batch-byte-compile)'
97 # How to make a pdf file from a texinfo file
98 TEXI2PDF = texi2pdf --batch --clean
100 # How to make a pdf file from a tex file
101 PDFTEX = pdftex
103 # How to create directories with leading path components
104 # MKDIR = mkdir -m 755 -p # try this if you have no install
105 MKDIR = install -m 755 -d
107 # How to create the info files from the texinfo file
108 MAKEINFO = makeinfo
110 # How to create the HTML file
111 TEXI2HTML = makeinfo --html --number-sections
113 # How to find files
114 FIND = find
116 # How to remove files
117 RM = rm -f
119 # How to remove files recursively
120 RMR = rm -fr
122 # How to copy the lisp files and elc files to their destination.
123 # CP = cp -p # try this if you have no install
124 CP = install -m 644 -p
126 # How to obtain administrative privileges
127 # leave blank if you don't need this
128 # SUDO =
129 SUDO = sudo
131 # Name of the program to install info files
132 # INSTALL_INFO = ginstall-info # Debian: avoid harmless warning message
133 INSTALL_INFO = install-info
135 # target method for 'compile'
136 ORGCM = dirall
137 # ORGCM = dirall # 1x slowdown compared to default compilation method
138 # ORGCM = single # 4x one Emacs process per compilation
139 # ORGCM = source # 5x ditto, but remove compiled file immediately
140 # ORGCM = slint1 # 3x possibly elicit more warnings
141 # ORGCM = slint2 # 7x possibly elicit even more warnings