improve comment in local.mk template
[org-mode.git] / default.mk
blob5ee872f9d952245cff03a3d278bb6216f203eb85
1 ##----------------------------------------------------------------------
2 ## NEVER EDIT THIS FILE, PUT ANY ADAPTATIONS INTO local.mk
3 ##----------------------------------------------------------------------
4 ## CHECK AND ADAPT THE FOLLOWING DEFINITIONS
5 ##-8<-------------------------------------------------------------------
7 # Override default target if desired or define your own default target
8 # oldorg: # have plain "make" do the same things the old Makefile did
10 # Name of your emacs binary
11 EMACS = emacs
13 # Where local software is found
14 prefix = /usr/share
16 # Where local lisp files go.
17 lispdir= $(prefix)/emacs/site-lisp/org
19 # Where local data files go.
20 datadir = $(prefix)/emacs/etc/org
22 # Where info files go.
23 infodir = $(prefix)/info
25 # Define if you only need info documentation, the default includes html and pdf
26 # ORG_MAKE_DOC = info # html pdf
28 # Where to create temporary files for the testsuite
29 TMPDIR ?= /tmp
30 testdir = $(TMPDIR)/tmp-orgtest
32 # Configuration for testing
33 BTEST_PRE = # add options before standard load-path
34 BTEST_POST = # add options after standard load path
35 # -L <path-to>/ert # needed for Emacs23, Emacs24 has ert built in
36 # -L <path-to>/htmlize # need at least version 1.34 for source code formatting
37 BTEST_OB_LANGUAGES = awk C fortran maxima lilypond octave python sh # R
38 # R is not activated by default because it requires ess to be installed and configured
39 BTEST_EXTRA = # extra packages to require for testing
41 ##->8-------------------------------------------------------------------
42 ## YOU MAY NEED TO ADAPT THESE DEFINITIONS
43 ##----------------------------------------------------------------------
45 # How to run tests
46 req-ob-lang = --eval '(require '"'"'ob-$(ob-lang))'
47 req-extra = --eval '(require '"'"'$(req))'
48 BTEST = $(BATCH) \
49 $(BTEST_PRE) \
50 --eval '(add-to-list '"'"'load-path "./lisp")' \
51 --eval '(add-to-list '"'"'load-path "./testing")' \
52 $(BTEST_POST) \
53 -l org-install.el \
54 -l testing/org-test.el \
55 $(foreach ob-lang,$(BTEST_OB_LANGUAGES),$(req-ob-lang)) \
56 $(foreach req,$(BTEST_EXTRA),$(req-extra)) \
57 --eval '(setq org-confirm-babel-evaluate nil)' \
58 -f org-test-run-batch-tests
60 # Using emacs in batch mode.
61 # BATCH = $(EMACS) -batch -vanilla # XEmacs
62 BATCH = $(EMACS) -batch -Q
64 # Emacs must be started in lisp directory
65 BATCHL = $(BATCH) \
66 --eval '(add-to-list '"'"'load-path ".")'
68 # How to generate org-install.el
69 MAKE_ORG_INSTALL = $(BATCHL) \
70 --eval '(load "org-compat.el")' \
71 --eval '(load "../UTILITIES/org-fixup.el")' \
72 --eval '(org-make-org-install)'
74 # How to generate org-version.el
75 MAKE_ORG_VERSION = $(BATCHL) \
76 --eval '(load "org-compat.el")' \
77 --eval '(load "../UTILITIES/org-fixup.el")' \
78 --eval '(org-make-org-version "$(ORGVERSION)" "$(GITVERSION)" "$(datadir)")'
80 # How to byte-compile the whole source directory
81 ELCDIR = $(BATCHL) \
82 --eval '(batch-byte-recompile-directory 0)'
84 # How to make a pdf file from a texinfo file
85 TEXI2PDF = texi2pdf --batch --clean
87 # How to make a pdf file from a tex file
88 PDFTEX = pdftex
90 # How to create directories
91 MKDIR = mkdir -p
93 # How to create the info files from the texinfo file
94 MAKEINFO = makeinfo
96 # How to create the HTML file
97 TEXI2HTML = makeinfo --html --number-sections
99 # How to find files
100 FIND = find
102 # How to remove files
103 RM = rm -f
105 # How to remove files recursively
106 RMR = rm -fr
108 # How to stream edit a file
109 SED = sed
111 # How to copy the lisp files and elc files to their destination.
112 # CP = cp -p # try this if there is no install
113 CP = install -p
115 # How to obtain administrative privileges
116 # SUDO = # leave blank if you don't need this
117 SUDO = sudo
119 # Name of the program to install info files
120 # INSTALL_INFO = ginstall-info # Debian: avoid harmless warning message
121 INSTALL_INFO = install-info