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

101 lines
3.6 KiB
Makefile
Raw Normal View History

Release 4.48
2008-01-31 05:32:35 -05:00
# Makefile - for the org-mode distribution
Document convenience target 'uncompiled'. * Makefile: Document convenience target 'uncompiled' (a surrogate for 'make cleanlisp autoloads').
2012-05-24 14:40:04 -04:00
# GNU make is required
Release 4.48
2008-01-31 05:32:35 -05: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
# This file is not part of GNU Emacs
provide an easier way to get the old behaviour of plain "make" back * Makefile: move setup includes to top * lisp/Makefile: reduce verbosity of org-version.el target, add a more friendly @echo instead. * targets.mk: provide compatibility target "oldorg" to do "compile autoloads info" which is closest to the old behaviour.
2012-04-21 11:25:35 -04:00
# set up environment
include default.mk # defaults, customizable via "local.mk"
-include local.mk # optional local customization, use default.mk as template
# default target is "all" unless overridden in local.mk
The default target should be "all" Makefile: "all" should be the default target
2012-01-02 15:54:55 -05:00
all::
Release 4.48
2008-01-31 05:32:35 -05:00
Makefile: add `make targets' to document possible targets Thanks to Jude DaShiell for this suggestion, and to Nick Dokos for comments.
2011-07-05 05:27:13 -04:00
# Describe valid make targets for org-mode.
Improve compatibility with old Makefile * targets.mk: change the "local.mk" template so that "oldorg" will be the default target for maximum compatibility. Admonish info message with a reminder to use "make help" for more information on targets and that "oldorg" is the default target for now. Add new convenience target "uncompiled" that will keep the lisp directory free from *.elc files and the autoload files up-to-date. * Makefile: make "targets" and "helpall" depend on "help" so that only "help::" or "helpall::" needs to be written for adding more help messages. Useful when users want to add their own messages to "make help" et al.
2012-04-25 13:04:29 -04:00
.PHONY: targets help helpall
targets: help
correct output from "make helpall" * Makefile: correct definitions to have "make helpall" display the output in the way it was intended. Remove documentation for "cleanrel" as it is not intended to be used except on the release server; this target may move into server.mk, but for now leave it in targets.mk.
2012-05-10 14:29:13 -04:00
help helpall::
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
$(info )
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info Getting Help)
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
$(info ============)
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
$(info )
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make help - show brief help)
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make targets - ditto)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make helpall - show extended help)
$(info )
$(info Build and Check)
$(info ===============)
$(info make - build Org ELisp and all documentation)
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make all - ditto)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make compile - build Org ELisp files)
$(info make autoloads - create org-install.el to load org in-place)
$(info make check - build Org ELisp files and run test suite)
helpall::
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make test - ditto)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make compile-dirty - build only stale Org ELisp files)
$(info make test-dirty - check without building first)
$(info )
$(info Compatibility)
$(info =============)
$(info make oldorg - what the old make did: compile autoloads info)
$(info )
$(info Convenience)
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
$(info ===========)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make up0 - pull from upstream)
$(info make up1 - pull from upstream, build and check)
$(info make up2 - pull from upstream, build, check and install)
$(info make update - pull from upstream and build)
$(info make update2 - pull from upstream, build and install)
Document convenience target 'uncompiled'. * Makefile: Document convenience target 'uncompiled' (a surrogate for 'make cleanlisp autoloads').
2012-05-24 14:40:04 -04:00
$(info make uncompiled - combine cleanlisp and autoloads)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make local.mk - create new local.mk as template for adaptation)
$(info )
$(info Cleaning)
$(info ========)
$(info make clean - remove built Org ELisp files and documentation)
$(info make cleanall - remove everything that can be built and all remnants)
$(info make cleandirs - clean in etc/, lisp/ and doc/)
$(info make cleancontrib - remove remnants in contrib/)
$(info make cleandoc - remove built documentation)
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make cleandocs - ditto)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make cleanlisp - remove built Org ELisp files)
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make cleanelc - ditto)
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make cleantest - remove check remnants)
$(info make clean-install - remove previous Org installation)
$(info )
Add configuration checks to build system * targets.mk: Add targets "config", "config-test", "config-exe", "config-cmd", "config-all" and "config-eol" (all .PHONY). These echo various configuration dependent variables so they can be more easily checked for correctness. * Makefile: Document the new targets, "config" with "help" and the rest with "helpall".
2012-06-02 07:32:53 -04:00
$(info Configuration Check)
$(info ===================)
help helpall::
$(info make config - check main configuration)
helpall::
$(info make config-test - check test configuration)
$(info make config-exe - check executables configuration)
$(info make config-cmd - check command configuration)
$(info make config-all - check all configuration)
$(info make config-eol - check all configuration, mark end-of-line)
$(info )
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info Documentation)
$(info =============)
correct output from "make helpall" * Makefile: correct definitions to have "make helpall" display the output in the way it was intended. Remove documentation for "cleanrel" as it is not intended to be used except on the release server; this target may move into server.mk, but for now leave it in targets.mk.
2012-05-10 14:29:13 -04:00
help helpall::
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make doc - build all documentation)
helpall::
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make docs - ditto)
correct output from "make helpall" * Makefile: correct definitions to have "make helpall" display the output in the way it was intended. Remove documentation for "cleanrel" as it is not intended to be used except on the release server; this target may move into server.mk, but for now leave it in targets.mk.
2012-05-10 14:29:13 -04:00
help helpall::
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info make info - build Info documentation)
helpall::
$(info make html - build HTML documentation)
$(info make pdf - build PDF documentation)
$(info make card - build reference cards)
spelling fixes Makefile: dito -> ditto
2012-04-27 15:04:57 -04:00
$(info make refcard - ditto)
correct output from "make helpall" * Makefile: correct definitions to have "make helpall" display the output in the way it was intended. Remove documentation for "cleanrel" as it is not intended to be used except on the release server; this target may move into server.mk, but for now leave it in targets.mk.
2012-05-10 14:29:13 -04:00
help helpall::
Introduce compatibility and convenience targets, local.mk template, add "helpall" * Makefile: new target "helpall" to document all targets, while "help" continues to show a brief subset. * default.mk: add cutlines for sed to produce local.mk with. * targets.mk: add target "local.mk" to produce an (empty) local.mk configuration template when it isn't already present. Ignore any error when making this target since sed might not be present on all systems. Redefine target "update" to not include testing, similarly add target "update2" to additionally install without test. Add targets "up0" to stop after git pull and "up1" to stop after test, while "up2" continues to do everything and then installs. Complete .PHONY target list. Add "refcard" target for compatibility with old make. Clean contrib in "cleanall", too.
2012-04-23 15:20:58 -04:00
$(info )
$(info Installation)
$(info ============)
$(info make install - build and install Org)
helpall::
$(info make install-etc - build and install files in /etc)
$(info make install-lisp - build and install Org Elisp files)
$(info make install-info - build and install Info documentation)
correct output from "make helpall" * Makefile: correct definitions to have "make helpall" display the output in the way it was intended. Remove documentation for "cleanrel" as it is not intended to be used except on the release server; this target may move into server.mk, but for now leave it in targets.mk.
2012-05-10 14:29:13 -04:00
help helpall::
Makefile: add `make targets' to document possible targets Thanks to Jude DaShiell for this suggestion, and to Nick Dokos for comments.
2011-07-05 05:27:13 -04:00
@echo ""
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
include targets.mk # toplevel make machinery