org-export: Fix docstrings
[org-mode.git] / default.mk
blob7bdb7df50d2c91ba387af3deb14a022be70c8475
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>/htmlize # need at least version 1.34 for source code formatting
37 BTEST_OB_LANGUAGES = awk C fortran maxima lilypond octave python sh
38 # R is not activated by default because it requires ess to be installed and configured
39 # extra packages to require for testing
40 BTEST_EXTRA =
42 ##->8-------------------------------------------------------------------
43 ## YOU MAY NEED TO ADAPT THESE DEFINITIONS
44 ##----------------------------------------------------------------------
46 # How to run tests
47 req-ob-lang = --eval '(require '"'"'ob-$(ob-lang))'
48 req-extra = --eval '(require '"'"'$(req))'
49 BTEST = $(BATCH) \
50 $(BTEST_PRE) \
51 --eval '(add-to-list '"'"'load-path "./lisp")' \
52 --eval '(add-to-list '"'"'load-path "./testing")' \
53 $(BTEST_POST) \
54 -l org-install.el \
55 -l testing/org-test.el \
56 $(foreach ob-lang,$(BTEST_OB_LANGUAGES),$(req-ob-lang)) \
57 $(foreach req,$(BTEST_EXTRA),$(req-extra)) \
58 --eval '(setq org-confirm-babel-evaluate nil)' \
59 -f org-test-run-batch-tests
61 # Using emacs in batch mode.
62 # BATCH = $(EMACS) -batch -vanilla # XEmacs
63 BATCH = $(EMACS) -batch -Q
65 # How to generate local.mk
66 MAKE_LOCAL_MK = $(BATCH) \
67 --eval '(add-to-list '"'"'load-path "./lisp")' \
68 --eval '(load "org-compat.el")' \
69 --eval '(load "../UTILITIES/org-fixup.el")' \
70 --eval '(org-make-local-mk)'
72 # Emacs must be started in lisp directory
73 BATCHL = $(BATCH) \
74 --eval '(add-to-list '"'"'load-path ".")'
76 # How to generate org-install.el
77 MAKE_ORG_INSTALL = $(BATCHL) \
78 --eval '(load "org-compat.el")' \
79 --eval '(load "../UTILITIES/org-fixup.el")' \
80 --eval '(org-make-org-install)'
82 # How to generate org-version.el
83 MAKE_ORG_VERSION = $(BATCHL) \
84 --eval '(load "org-compat.el")' \
85 --eval '(load "../UTILITIES/org-fixup.el")' \
86 --eval '(org-make-org-version "$(ORGVERSION)" "$(GITVERSION)" "$(datadir)")'
88 # How to byte-compile the whole source directory
89 ELCDIR = $(BATCHL) \
90 --eval '(batch-byte-recompile-directory 0)'
92 # How to make a pdf file from a texinfo file
93 TEXI2PDF = texi2pdf --batch --clean
95 # How to make a pdf file from a tex file
96 PDFTEX = pdftex
98 # How to create directories with leading path components
99 # MKDIR = mkdir -m 755 -p # try this if you have no install
100 MKDIR = install -m 755 -d
102 # How to create the info files from the texinfo file
103 MAKEINFO = makeinfo
105 # How to create the HTML file
106 TEXI2HTML = makeinfo --html --number-sections
108 # How to find files
109 FIND = find
111 # How to remove files
112 RM = rm -f
114 # How to remove files recursively
115 RMR = rm -fr
117 # How to copy the lisp files and elc files to their destination.
118 # CP = cp -p # try this if you have no install
119 CP = install -m 644 -p
121 # How to obtain administrative privileges
122 # leave blank if you don't need this
123 # SUDO =
124 SUDO = sudo
126 # Name of the program to install info files
127 # INSTALL_INFO = ginstall-info # Debian: avoid harmless warning message
128 INSTALL_INFO = install-info