ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
org-mode/default.mk

86 lines
2.2 KiB
Makefile
Raw Normal View History

Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
##----------------------------------------------------------------------
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
## NEVER EDIT THIS FILE, PUT ANY ADAPTATIONS INTO local.mk
##----------------------------------------------------------------------
## CHECK AND ADAPT THE FOLLOWING DEFINITIONS
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
##----------------------------------------------------------------------
# Name of your emacs binary
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
EMACS = emacs
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# Where local software is found
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
prefix = /usr/share
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# Where local lisp files go.
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
lispdir= $(prefix)/emacs/site-lisp/org
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
Introduce $(datadir), prefix all installation paths with $(DESTDIR) Makefile: remove includes for maintainer targets, these will go into local.mk on the server default.mk: introduce $(datadir) to replace $(etcdir) in etc/Makefile doc/Makefile: replace $etcdir) with $(datadir) lisp/Makefile: record ODT styles location as defconst in org-install {doc,etc,lisp}/Makefile: prefix all installation targets with $(DESTDIR)
2012-01-02 14:07:04 -05:00
# Where local data files go.
introduce new make target "test" Makefile: add help for target "test" default.mk: more sane location for local data, add $(BTEST) that will run the test in batch mode. Some tests require non-standard packages, introduce $(BTEST_EXTRA) in order to add options so they can be found. targets.mk: new target "test" that implies "all" and then runs all test. Hidden target "test-dirty" runs tests without doing compilation.
2012-01-04 15:02:14 -05:00
datadir = $(prefix)/emacs/etc/org
Introduce $(datadir), prefix all installation paths with $(DESTDIR) Makefile: remove includes for maintainer targets, these will go into local.mk on the server default.mk: introduce $(datadir) to replace $(etcdir) in etc/Makefile doc/Makefile: replace $etcdir) with $(datadir) lisp/Makefile: record ODT styles location as defconst in org-install {doc,etc,lisp}/Makefile: prefix all installation targets with $(DESTDIR)
2012-01-02 14:07:04 -05:00
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# Where info files go.
change defaults to something that should work on most Linux systems and Cygwin * default.mk: change prefix to /usr/share and do some formatting This change establishes the baseline installation path that should work out-of-the-box on Linux and Cygwin when the install is done system-wide (which needs administrator privileges).
2011-07-12 14:11:15 -04:00
infodir = $(prefix)/info
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
##----------------------------------------------------------------------
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
## YOU MAY NEED TO ADAPT THESE DEFINITIONS
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
##----------------------------------------------------------------------
# Using emacs in batch mode.
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
BATCH = $(EMACS) -batch -Q \
make sure org-release is defined in batch mode default.mk: make sure org-release is defined when starting emacs in batch mode. Add a suffix to see if this definition leaks into the installed version someplace. When running from an installed version, this definition is pulled in from org-install.el.
2012-01-04 16:53:02 -05:00
-L . \
--eval '(defconst org-release "$(ORGVERSION)-Make")' \
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
# How to run tests
BTEST_EXTRA = # placeholder
BTEST = $(EMACS) -batch \
introduce new make target "test" Makefile: add help for target "test" default.mk: more sane location for local data, add $(BTEST) that will run the test in batch mode. Some tests require non-standard packages, introduce $(BTEST_EXTRA) in order to add options so they can be found. targets.mk: new target "test" that implies "all" and then runs all test. Hidden target "test-dirty" runs tests without doing compilation.
2012-01-04 15:02:14 -05:00
$(BTEST_EXTRA) \
-L lisp/ \
make sure org-release is defined in batch mode default.mk: make sure org-release is defined when starting emacs in batch mode. Add a suffix to see if this definition leaks into the installed version someplace. When running from an installed version, this definition is pulled in from org-install.el.
2012-01-04 16:53:02 -05:00
--eval '(defconst org-release "$(ORGVERSION)-Test")' \
introduce new make target "test" Makefile: add help for target "test" default.mk: more sane location for local data, add $(BTEST) that will run the test in batch mode. Some tests require non-standard packages, introduce $(BTEST_EXTRA) in order to add options so they can be found. targets.mk: new target "test" that implies "all" and then runs all test. Hidden target "test-dirty" runs tests without doing compilation.
2012-01-04 15:02:14 -05:00
-l testing/org-test.el \
-eval "(setq org-confirm-babel-evaluate nil)" \
-f org-test-run-batch-tests
update target descriptions, target "all" now automatically cleans .elc before compilation * targets.mk: target "all" for lisp directory does now the same as "compile", i.e. it cleans .elc file first * Makefile: describe all targets and re-arrange the target groups
2011-11-13 05:53:12 -05:00
# How to byte-compile the whole source directory
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
ELCDIR = $(BATCH) \
update target descriptions, target "all" now automatically cleans .elc before compilation * targets.mk: target "all" for lisp directory does now the same as "compile", i.e. it cleans .elc file first * Makefile: describe all targets and re-arrange the target groups
2011-11-13 05:53:12 -05:00
--eval '(batch-byte-recompile-directory 0)'
# How to byte-compile a single source file
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
ELC = $(BATCH) -f batch-byte-compile
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# How to make a pdf file from a texinfo file
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
TEXI2PDF = texi2pdf --batch --clean
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
hand off ./doc to sub-make * Makefile: use info function for output and call shell only once * default.mk: add PDFTEX and RMR variables for customization * lisp/Makefile: add target 'all' and create $(lispdir) if necessary * maint-targets.mk: invoke sub-make for HTML manuals * maint.mk: remove unsused VARIABLES * targets.mk: invoke sub-make for ./doc and clean up some targets
2011-07-17 08:49:43 -04:00
# How to make a pdf file from a tex file
PDFTEX = pdftex
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# How to create directories
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
MKDIR = mkdir -p
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# How to create the info files from the texinfo file
MAKEINFO = makeinfo
# How to create the HTML file
TEXI2HTML = makeinfo --html --number-sections
shuffle targets to their correct place, harden recipes * Makefile: declare phony targets, remove help text for install-info-debian * default.mk: add variable for FIND and RM * targets.mk, maint-targets.mk: shuffle targets to where they belong, declare phony targets, work around a texi2dvi bug, use pattern rules, use targets for dependencies instead of repeating them verbatim
2011-07-12 16:31:41 -04:00
# How to find files
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
FIND = find
shuffle targets to their correct place, harden recipes * Makefile: declare phony targets, remove help text for install-info-debian * default.mk: add variable for FIND and RM * targets.mk, maint-targets.mk: shuffle targets to where they belong, declare phony targets, work around a texi2dvi bug, use pattern rules, use targets for dependencies instead of repeating them verbatim
2011-07-12 16:31:41 -04:00
# How to remove files
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
RM = rm -f
shuffle targets to their correct place, harden recipes * Makefile: declare phony targets, remove help text for install-info-debian * default.mk: add variable for FIND and RM * targets.mk, maint-targets.mk: shuffle targets to where they belong, declare phony targets, work around a texi2dvi bug, use pattern rules, use targets for dependencies instead of repeating them verbatim
2011-07-12 16:31:41 -04:00
hand off ./doc to sub-make * Makefile: use info function for output and call shell only once * default.mk: add PDFTEX and RMR variables for customization * lisp/Makefile: add target 'all' and create $(lispdir) if necessary * maint-targets.mk: invoke sub-make for HTML manuals * maint.mk: remove unsused VARIABLES * targets.mk: invoke sub-make for ./doc and clean up some targets
2011-07-17 08:49:43 -04:00
# How to remove files recursively
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
RMR = rm -fr
hand off ./doc to sub-make * Makefile: use info function for output and call shell only once * default.mk: add PDFTEX and RMR variables for customization * lisp/Makefile: add target 'all' and create $(lispdir) if necessary * maint-targets.mk: invoke sub-make for HTML manuals * maint.mk: remove unsused VARIABLES * targets.mk: invoke sub-make for ./doc and clean up some targets
2011-07-17 08:49:43 -04:00
use sed instead of perl, add target clean-install * Makefile, lisp/Makefile, doc/Makefile: add target clean-install to remove files in install-directories * default.mk: add customization variable $(SED) * doc/Makefile: do not remove dir while cleaning * lisp/Makefile: use sed instead of perl to weave git-status into org.el and ignore any errors while doing it. Keep git status in $(GITSTATUS) to make it more clear what happens in the check.
2011-07-18 11:55:23 -04:00
# How to stream edit a file
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
SED = sed
use sed instead of perl, add target clean-install * Makefile, lisp/Makefile, doc/Makefile: add target clean-install to remove files in install-directories * default.mk: add customization variable $(SED) * doc/Makefile: do not remove dir while cleaning * lisp/Makefile: use sed instead of perl to weave git-status into org.el and ignore any errors while doing it. Keep git status in $(GITSTATUS) to make it more clear what happens in the check.
2011-07-18 11:55:23 -04:00
change defaults to something that should work on most Linux systems and Cygwin * default.mk: change prefix to /usr/share and do some formatting This change establishes the baseline installation path that should work out-of-the-box on Linux and Cygwin when the install is done system-wide (which needs administrator privileges).
2011-07-12 14:11:15 -04:00
# How to copy the lisp files and elc files to their destination.
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
# CP = cp -p # try this if there is no install
CP = install -p
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
introduce $(SUDO) to make install with administrative privileges customizable defaults.mk: define SUDO to map to sudo, add comment to define blank if administrative privileges are not needed (already root on Linux or Administrator on Windows) targets.mk: use newly defined $(SUDO) uinstead of plain sudo, replaces some braces with parentheses
2012-01-31 14:44:37 -05:00
# How to obtain administrative privileges
# SUDO = # leave blank if you don't need this
SUDO = sudo
Split off Makefile into several parts, included from master Makefile * Makefile: just keep help target (now also default for no target) and include all other parts from here. * default.mk: user editable variables with their default values * maint.mk: definitions by maintainer, should not be touched by user * targets.mk: user callable targets * maint-targets.mk: targets for maintenance, should not be called by user * dependencies.mk: keep order during compile (could become auto-generated) This is the first in a series of patches that restructures the Makefile to achieve easier customization and separation of different concerns (mainly user vs. maintenance of the distribution). This first patch simply establishes a set of files without changing anything else to provide a clean starting point. It uses GNU make extensions since Makefile already depends on GNU make anyway.
2011-07-12 13:45:59 -04:00
# Name of the program to install info files
ignore *.t2d directories in doc/, adapt some comments, implement missing targets .gitignore: also ignore *.t2d directories in doc/ that texi2pdf might produce when run in tidy mode default.mk: correct some comments targets.mk: implement missing clean targets and add aliases for them
2012-01-05 14:54:52 -05:00
# INSTALL_INFO = ginstall-info # Debian: avoid harmless warning message
change defaults to something that should work on most Linux systems and Cygwin * default.mk: change prefix to /usr/share and do some formatting This change establishes the baseline installation path that should work out-of-the-box on Linux and Cygwin when the install is done system-wide (which needs administrator privileges).
2011-07-12 14:11:15 -04:00
INSTALL_INFO = install-info