Makefile

   1 # Makefile - for the org-mode distribution
   2 # GNU make is required
   3 #
   4 # This file is not part of GNU Emacs
   5
   6 # set up environment
   7  include default.mk     # defaults, customizable via "local.mk"
   8 -include local.mk       # optional local customization, use default.mk as template
   9
  10 # default target is "all" unless overridden in local.mk
  11 all::
  12
  13 # Describe valid make targets for org-mode.
  14 .PHONY: targets help helpall
  15 targets:        help
  16 help helpall::
  17         $(info )
  18         $(info Getting Help)
  19         $(info ============)
  20         $(info )
  21         $(info make help           - show brief help)
  22         $(info make targets        - ditto)
  23         $(info make helpall        - show extended help)
  24         $(info )
  25         $(info Build and Check)
  26         $(info ===============)
  27         $(info make                - build Org ELisp and all documentation)
  28         $(info make all            - ditto)
  29         $(info make compile        - build Org ELisp files)
  30         $(info make autoloads      - create org-install.el to load org in-place)
  31         $(info make check          - build Org ELisp files and run test suite)
  32 helpall::
  33         $(info make test           - ditto)
  34         $(info make compile-dirty  - build only stale Org ELisp files)
  35         $(info make compile-single - build using one Emacs process per file)
  36         $(info make compile-source - ditto, but immediately remove byte-compiled file )
  37         $(info make test-dirty     - check without building first)
  38         $(info )
  39         $(info Compatibility)
  40         $(info =============)
  41         $(info make oldorg         - what the old make did: compile autoloads info)
  42         $(info )
  43         $(info Convenience)
  44         $(info ===========)
  45         $(info make up0            - pull from upstream)
  46         $(info make up1            - pull from upstream, build and check)
  47         $(info make up2            - pull from upstream, build, check and install)
  48         $(info make update         - pull from upstream and build)
  49         $(info make update2        - pull from upstream, build and install)
  50         $(info make uncompiled     - combine cleanlisp and autoloads)
  51         $(info make local.mk       - create new local.mk as template for adaptation)
  52         $(info )
  53         $(info Cleaning)
  54         $(info ========)
  55         $(info make clean          - remove built Org ELisp files and documentation)
  56         $(info make cleanall       - remove everything that can be built and all remnants)
  57         $(info make cleandirs      - clean in etc/, lisp/ and doc/)
  58         $(info make cleancontrib   - remove remnants in contrib/)
  59         $(info make cleantesting   - remove remnants in testing/)
  60         $(info make cleanutils     - remove remnants in UTILITIES/)
  61         $(info make cleandoc       - remove built documentation)
  62         $(info make cleandocs      - ditto)
  63         $(info make cleanlisp      - remove built Org ELisp files)
  64         $(info make cleanelc       - ditto)
  65         $(info make cleantest      - remove test directory)
  66         $(info make clean-install  - remove previous Org installation)
  67         $(info )
  68         $(info Configuration Check)
  69         $(info ===================)
  70 help helpall::
  71         $(info make config         - check main configuration)
  72 helpall::
  73         $(info make config-test     - check test configuration)
  74         $(info make config-exe      - check executables configuration)
  75         $(info make config-cmd      - check command configuration)
  76         $(info make config-all      - check all configuration)
  77         $(info make config-eol      - check all configuration, mark end-of-line)
  78         $(info )
  79         $(info Documentation)
  80         $(info =============)
  81 help helpall::
  82         $(info make doc            - build all documentation)
  83 helpall::
  84         $(info make docs           - ditto)
  85 help helpall::
  86         $(info make info           - build Info documentation)
  87 helpall::
  88         $(info make html           - build HTML documentation)
  89         $(info make pdf            - build PDF documentation)
  90         $(info make card           - build reference cards)
  91         $(info make refcard        - ditto)
  92 help helpall::
  93         $(info )
  94         $(info Installation)
  95         $(info ============)
  96         $(info make install        - build and install Org)
  97 helpall::
  98         $(info make install-etc    - build and install files in /etc)
  99         $(info make install-lisp   - build and install Org Elisp files)
 100         $(info make install-info   - build and install Info documentation)
 101 help helpall::
 102         @echo ""
 103
 104  include targets.mk     # toplevel make machinery