Makefile

   1 # Makefile - for the org-mode distribution
   2 #
   3 # Maintainer: Carsten Dominik <dominik@science.uva.nl>
   4 # Version: VERSIONTAG
   5 #
   6 # To install org-mode, edit the Makefile, type `make', then `make install'.
   7 # To create the PDF and HTML documentation files, type `make doc'.
   8
   9 ##----------------------------------------------------------------------
  10 ##  YOU MUST EDIT THE FOLLOWING LINES
  11 ##----------------------------------------------------------------------
  12
  13 # Name of your emacs binary
  14 EMACS=emacs
  15
  16 # Where local software is found
  17 prefix=/usr/local
  18
  19 # Where local lisp files go.
  20 lispdir   = $(prefix)/share/emacs/site-lisp
  21
  22 # Where info files go.
  23 infodir = $(prefix)/share/info
  24
  25 ##----------------------------------------------------------------------
  26 ## YOU MAY NEED TO EDIT THESE
  27 ##----------------------------------------------------------------------
  28
  29 # Using emacs in batch mode.
  30
  31 BATCH=$(EMACS) -batch -q -no-site-file -eval                                                    \
  32   "(setq load-path (cons (expand-file-name \"./lisp/\") (cons \"$(lispdir)\" load-path)))"
  33
  34 # Specify the byte-compiler for compiling org-mode files
  35 ELC= $(BATCH) -f batch-byte-compile
  36
  37 # How to make a pdf file from a texinfo file
  38 TEXI2PDF = texi2pdf
  39
  40 # How to create directories
  41 MKDIR = mkdir -p
  42
  43 # How to create the info files from the texinfo file
  44 MAKEINFO = makeinfo
  45
  46 # How to create the HTML file
  47 TEXI2HTML = makeinfo --html --number-sections
  48 TEXI2HTMLNOPSLIT = makeinfo --html --no-split --number-sections
  49
  50 # How to copy the lisp files and elc files to their distination.
  51 CP = cp -p
  52
  53 # Name of the program to install info files
  54 INSTALL_INFO=install-info
  55
  56 ##----------------------------------------------------------------------
  57 ##  BELOW THIS LINE ON YOUR OWN RISK!
  58 ##----------------------------------------------------------------------
  59
  60 # The following variables need to be defined by the maintainer
  61 LISPF      =    org.el                  \
  62                 org-agenda.el           \
  63                 org-ascii.el            \
  64                 org-attach.el           \
  65                 org-archive.el          \
  66                 org-bbdb.el             \
  67                 org-beamer.el           \
  68                 org-bibtex.el           \
  69                 org-capture.el          \
  70                 org-clock.el            \
  71                 org-colview.el          \
  72                 org-colview-xemacs.el   \
  73                 org-compat.el           \
  74                 org-pcomplete.el        \
  75                 org-crypt.el            \
  76                 org-ctags.el            \
  77                 org-datetree.el         \
  78                 org-docview.el          \
  79                 org-entities.el         \
  80                 org-exp.el              \
  81                 org-exp-blocks.el       \
  82                 org-docbook.el          \
  83                 org-faces.el            \
  84                 org-feed.el             \
  85                 org-footnote.el         \
  86                 org-freemind.el         \
  87                 org-gnus.el             \
  88                 org-habit.el            \
  89                 org-html.el             \
  90                 org-icalendar.el        \
  91                 org-id.el               \
  92                 org-indent.el           \
  93                 org-info.el             \
  94                 org-inlinetask.el       \
  95                 org-jsinfo.el           \
  96                 org-irc.el              \
  97                 org-latex.el            \
  98                 org-list.el             \
  99                 org-lparse.el           \
 100                 org-mac-message.el      \
 101                 org-macs.el             \
 102                 org-mew.el              \
 103                 org-mhe.el              \
 104                 org-mks.el              \
 105                 org-mobile.el           \
 106                 org-mouse.el            \
 107                 org-odt.el              \
 108                 org-publish.el          \
 109                 org-plot.el             \
 110                 org-protocol.el         \
 111                 org-remember.el         \
 112                 org-rmail.el            \
 113                 org-special-blocks.el   \
 114                 org-src.el              \
 115                 org-table.el            \
 116                 org-taskjuggler.el      \
 117                 org-timer.el            \
 118                 org-vm.el               \
 119                 org-w3m.el              \
 120                 org-wl.el               \
 121                 org-xoxo.el             \
 122                 ob.el                   \
 123                 ob-table.el             \
 124                 ob-lob.el               \
 125                 ob-ref.el               \
 126                 ob-exp.el               \
 127                 ob-tangle.el            \
 128                 ob-comint.el            \
 129                 ob-eval.el              \
 130                 ob-keys.el              \
 131                 ob-awk.el               \
 132                 ob-C.el                 \
 133                 ob-calc.el              \
 134                 ob-ditaa.el             \
 135                 ob-haskell.el           \
 136                 ob-perl.el              \
 137                 ob-sh.el                \
 138                 ob-R.el                 \
 139                 ob-dot.el               \
 140                 ob-mscgen.el            \
 141                 ob-latex.el             \
 142                 ob-lisp.el              \
 143                 ob-ledger.el            \
 144                 ob-python.el            \
 145                 ob-sql.el               \
 146                 ob-asymptote.el         \
 147                 ob-emacs-lisp.el        \
 148                 ob-matlab.el            \
 149                 ob-ruby.el              \
 150                 ob-sqlite.el            \
 151                 ob-clojure.el           \
 152                 ob-ocaml.el             \
 153                 ob-sass.el              \
 154                 ob-css.el               \
 155                 ob-gnuplot.el           \
 156                 ob-octave.el            \
 157                 ob-screen.el            \
 158                 ob-plantuml.el          \
 159                 ob-org.el               \
 160                 ob-js.el                \
 161                 ob-scheme.el            \
 162                 ob-lilypond.el          \
 163                 ob-java.el              \
 164                 ob-shen.el              \
 165                 ob-fortran.el           \
 166                 ob-picolisp.el
 167
 168 LISPFILES0  = $(LISPF:%=lisp/%)
 169 LISPFILES   = $(LISPFILES0) lisp/org-install.el
 170 ELCFILES0   = $(LISPFILES0:.el=.elc)
 171 ELCFILES    = $(LISPFILES:.el=.elc)
 172 DOCFILES    = doc/org.texi doc/org.pdf doc/org doc/dir \
 173               doc/pdflayout.sty doc/.nosearch \
 174               doc/orgguide.texi doc/orgguide.pdf
 175 CARDFILES   = doc/orgcard.tex doc/orgcard.pdf doc/orgcard_letter.pdf
 176 TEXIFILES   = doc/org.texi
 177 INFOFILES   = doc/org
 178
 179 # Package Manager (ELPA)
 180 PKG_TAG = $(shell date +%Y%m%d)
 181 PKG_DOC = "Outline-based notes management and organizer"
 182 PKG_REQ = "nil"
 183
 184 PKG_FILES = $(LISPFILES0)               \
 185             doc/dir doc/org             \
 186             doc/pdflayout.sty           \
 187             doc/org.pdf                 \
 188             doc/orgguide.pdf            \
 189             doc/orgcard.tex             \
 190             doc/orgcard.pdf             \
 191             doc/orgcard_letter.pdf      \
 192             etc/
 193
 194 .SUFFIXES: .el .elc .texi
 195 SHELL = /bin/sh
 196
 197 # Additional distribution files
 198 DISTFILES_extra=  Makefile request-assign-future.txt contrib etc
 199
 200 default: $(ELCFILES) $(ELCBFILES)
 201
 202 all:    $(ELCFILES) $(ELCBFILES) $(INFOFILES)
 203
 204 up2:    update
 205         sudo ${MAKE} install
 206
 207 update:
 208         git pull
 209         ${MAKE} clean
 210         ${MAKE} all
 211
 212 compile: $(ELCFILES0) $(ELCBFILES)
 213
 214 install: install-lisp
 215
 216 doc: doc/org.html doc/org.pdf doc/orgcard.pdf doc/orgcard_letter.pdf doc/orgguide.pdf doc/orgcard.txt
 217
 218 p:
 219         ${MAKE} pdf && open doc/org.pdf
 220
 221 g:
 222         ${MAKE} pdf && open doc/orgguide.pdf
 223
 224 install-lisp: $(LISPFILES) $(ELCFILES)
 225         if [ ! -d $(lispdir) ]; then $(MKDIR) $(lispdir); else true; fi ;
 226         $(CP) $(LISPFILES)  $(lispdir)
 227         $(CP) $(ELCFILES)   $(lispdir)
 228
 229 install-info: $(INFOFILES)
 230         if [ ! -d $(infodir) ]; then $(MKDIR) $(infodir); else true; fi ;
 231         $(CP) $(INFOFILES) $(infodir)
 232         $(INSTALL_INFO) --infodir=$(infodir) $(INFOFILES)
 233
 234 autoloads: lisp/org-install.el
 235
 236 lisp/org-install.el: $(LISPFILES0) Makefile
 237         $(BATCH) --eval "(require 'autoload)" \
 238                 --eval '(find-file "lisp/org-install.el")'  \
 239                 --eval '(erase-buffer)' \
 240                 --eval '(mapc (lambda (x) (generate-file-autoloads (symbol-name x))) (quote ($(LISPF))))' \
 241                 --eval '(insert "\n(provide (quote org-install))\n")' \
 242                 --eval '(save-buffer)'
 243
 244 doc/org: doc/org.texi
 245         (cd doc && $(MAKEINFO) --no-split org.texi -o org)
 246
 247 doc/org.pdf: doc/org.texi
 248         (cd doc && $(TEXI2PDF) org.texi)
 249
 250 doc/orgguide.pdf: doc/orgguide.texi
 251         (cd doc && $(TEXI2PDF) orgguide.texi)
 252
 253 doc/org.html: doc/org.texi
 254         (cd doc && $(TEXI2HTML) --no-split -o org.html org.texi)
 255         UTILITIES/manfull.pl doc/org.html
 256
 257 doc/orgcard.pdf: doc/orgcard.tex
 258         (cd doc && pdftex orgcard.tex)
 259
 260 doc/orgcard.txt: doc/orgcard.tex
 261         (cd doc && perl ../UTILITIES/orgcard2txt.pl orgcard.tex > orgcard.txt)
 262
 263 doc/orgcard_letter.tex: doc/orgcard.tex
 264         perl -pe 's/\\pdflayout=\(0l\)/\\pdflayout=(1l)/' \
 265                    doc/orgcard.tex > doc/orgcard_letter.tex
 266
 267 doc/orgcard_letter.pdf: doc/orgcard_letter.tex
 268         (cd doc && pdftex orgcard_letter.tex)
 269
 270 # Below here are special targets for maintenance only
 271
 272 html: doc/org.html
 273
 274 html_manual: doc/org.texi
 275         rm -rf doc/manual
 276         mkdir doc/manual
 277         $(TEXI2HTML) -o doc/manual doc/org.texi
 278         UTILITIES/mansplit.pl doc/manual/*.html
 279
 280 html_guide: doc/orgguide.texi
 281         rm -rf doc/guide
 282         mkdir doc/guide
 283         $(TEXI2HTML) -o doc/guide doc/orgguide.texi
 284         UTILITIES/guidesplit.pl doc/guide/*.html
 285
 286 info:   doc/org
 287
 288 pdf:    doc/org.pdf doc/orgguide.pdf
 289
 290 card:   doc/orgcard.pdf doc/orgcard_letter.pdf doc/orgcard.txt
 291
 292 testrelease:
 293         git checkout -b testrelease origin/maint
 294         git merge -s recursive -X theirs master
 295         UTILITIES/set-version.pl testing
 296         git commit -a -m "Release testing"
 297         make distfile TAG=testversion
 298         make cleanrel
 299         rm -rf org-testversion*
 300         git reset --hard
 301         git checkout master
 302         git branch -D testrelease
 303
 304 # The following target makes a full release for the stuff that is
 305 # currently on master.  Do it like this:
 306 #
 307 #   make release TAG=7.01
 308
 309 release:
 310         git checkout maint
 311         git merge -s recursive -X theirs master
 312         UTILITIES/set-version.pl $(TAG)
 313         git commit -a -m "Release $(TAG)"
 314         make relup TAG=$(TAG)
 315         make cleanrel
 316         rm -rf org-$(TAG)
 317         rm -f org-$(TAG)*.zip
 318         rm -f org-$(TAG)*.tar.gz
 319         make pushreleasetag TAG=$(TAG)
 320         git push -f origin maint
 321         git checkout master
 322         git merge -s ours maint
 323         UTILITIES/set-version.pl -a $(TAG)
 324         git commit -a -m "Update website to show $(TAG) as current release"
 325         git push
 326
 327 # The following target makes a release, but from the stuff that is on
 328 # maint, not from the stuff that is on master.  The idea is that it pushes
 329 # out a minor fix into a minor update, while development on master
 330 # already went full steam ahead.  To make a micro-relesse, cherry-pick
 331 # the necessary changes into maint, then run (with proper version number)
 332 # This is just like release, but we skip  the step which merges master
 333 # into maint.
 334 #
 335 #   make fixrelease TAG=7.01.02
 336
 337 fixrelease:
 338         git checkout maint
 339         git merge -s recursive -X theirs master
 340         UTILITIES/set-version.pl $(TAG)
 341         git commit -a -m "Release $(TAG)"
 342         make relup TAG=$(TAG)
 343         make cleanrel
 344         rm -rf org-$(TAG)
 345         rm org-$(TAG)*.zip
 346         rm org-$(TAG)*.tar.gz
 347         make pushreleasetag TAG=$(TAG)
 348         git push -f origin maint
 349         git checkout master
 350         git merge -s ours maint
 351         UTILITIES/set-version.pl -o $(TAG)
 352         git commit -a -m "Update website to show $(TAG) as current release"
 353         git push
 354
 355 # ~$ make relup only makes sense from orgmode.org server
 356 # Don't call it from your computer!
 357 relup:
 358         ${MAKE} makerelease
 359         ${MAKE} sync_release
 360         ${MAKE} sync_manual
 361
 362 makerelease:
 363         @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
 364         ${MAKE} distfile
 365         ${MAKE} doc
 366         UTILITIES/gplmanual.pl
 367         ${MAKE} html_manual
 368         ${MAKE} html_guide
 369         rm -rf RELEASEDIR
 370         $(MKDIR) RELEASEDIR
 371         cp org-$(TAG).zip org-$(TAG).tar.gz RELEASEDIR
 372         cp doc/org.pdf doc/orgcard.pdf doc/org.texi doc/org.html RELEASEDIR
 373         cp doc/org_dual_license.texi RELEASEDIR
 374         cp doc/orgguide.pdf doc/orgcard.txt RELEASEDIR
 375         cp RELEASEDIR/org-$(TAG).zip    RELEASEDIR/org.zip
 376         cp RELEASEDIR/org-$(TAG).tar.gz RELEASEDIR/org.tar.gz
 377
 378 # ~$ make sync_release only makes sense from orgmode.org server
 379 # Don't call it from your computer!
 380 sync_release:
 381         rsync -avuz RELEASEDIR/ /var/www/orgmode.org/
 382
 383 # ~$ make sync_manual only makes sense from orgmode.org server
 384 # Don't call it from your computer!
 385 sync_manual:
 386         rsync -avuz --delete doc/manual/ /var/www/orgmode.org/manual/
 387         rsync -avuz --delete doc/guide/ /var/www/orgmode.org/guide/
 388
 389 distfile:
 390         @if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
 391         touch doc/org.texi doc/orgcard.tex # force update
 392         ${MAKE} cleancontrib
 393         ${MAKE} info
 394         ${MAKE} doc
 395         ${MAKE} lisp/org-install.el
 396         rm -rf org-$(TAG) org-$(TAG).zip
 397         $(MKDIR) org-$(TAG)
 398         $(MKDIR) org-$(TAG)/doc
 399         $(MKDIR) org-$(TAG)/lisp
 400         cp -r $(LISPFILES) org-$(TAG)/lisp
 401         cp -r $(DOCFILES) $(CARDFILES) org-$(TAG)/doc
 402         cp -r $(DISTFILES_extra) org-$(TAG)/
 403         cp -r README_DIST org-$(TAG)/README
 404         zip -r org-$(TAG).zip org-$(TAG)
 405         tar zcvf org-$(TAG).tar.gz org-$(TAG)
 406
 407 pkg:
 408         @if [ "X$(PKG_TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
 409         touch doc/org.texi doc/orgcard.tex # force update
 410         ${MAKE} info
 411         ${MAKE} doc
 412         rm -rf org-$(PKG_TAG) org-$(PKG_TAG).tar
 413         $(MKDIR) org-$(PKG_TAG)
 414         cp -r $(PKG_FILES) org-$(PKG_TAG)
 415         echo "(define-package \"org\" \"$(PKG_TAG)\" \"$(PKG_DOC)\" $(PKG_REQ))" > org-$(PKG_TAG)/org-pkg.el
 416         tar cf org-$(PKG_TAG).tar org-$(PKG_TAG) --remove-files
 417
 418 cleanall:
 419         ${MAKE} clean
 420         rm -f lisp/org-install.el
 421
 422 clean:
 423         ${MAKE} cleanelc
 424         ${MAKE} cleandoc
 425         ${MAKE} cleanrel
 426         rm -f *~ */*~ */*/*~
 427
 428 cleancontrib:
 429         find contrib -name \*~ -exec rm {} \;
 430
 431 cleanelc:
 432         rm -f $(ELCFILES)
 433 cleandoc:
 434         -(cd doc && rm -f org.pdf org org.html orgcard.pdf orgguide.pdf)
 435         -(cd doc && rm -f *.aux *.cp *.cps *.dvi *.fn *.fns *.ky *.kys *.pg *.pgs)
 436         -(cd doc && rm -f *.toc *.tp *.tps *.vr *.vrs *.log *.html *.ps)
 437         -(cd doc && rm -f orgcard_letter.tex orgcard_letter.pdf)
 438         -(cd doc && rm -rf manual)
 439
 440 cleanrel:
 441         rm -rf RELEASEDIR
 442         rm -rf org-7.*
 443         rm -rf org-7*zip org-7*tar.gz
 444
 445 .el.elc:
 446         $(ELC) $<
 447
 448
 449 push:
 450         git push orgmode@orgmode.org:org-mode.git master
 451
 452 pushtag:
 453         git tag -m "Adding tag" -a $(TAG)
 454         git push orgmode@orgmode.org:org-mode.git $(TAG)
 455
 456 pushreleasetag:
 457         git tag -m "Adding release tag" -a release_$(TAG)
 458         git push orgmode@orgmode.org:org-mode.git release_$(TAG)
 459
 460 # Dependencies
 461
 462 lisp/org.elc:           lisp/org-macs.el lisp/org-compat.el lisp/org-faces.el
 463 lisp/org-agenda.elc:    lisp/org.el
 464 lisp/org-ascii.elc:     lisp/org-exp.el
 465 lisp/org-attach.elc:    lisp/org.el lisp/org-id.el
 466 lisp/org-archive.elc:   lisp/org.el
 467 lisp/org-bbdb.elc:      lisp/org.el
 468 lisp/org-beamer.elc:    lisp/org.el
 469 lisp/org-bibtex.elc:    lisp/org.el
 470 lisp/org-capture.elc:   lisp/org.el lisp/org-mks.el
 471 lisp/org-clock.elc:     lisp/org.el
 472 lisp/org-colview.elc:   lisp/org.el
 473 lisp/org-colview-xemacs.elc:    lisp/org.el
 474 lisp/org-compat.elc:    lisp/org-macs.el
 475 lisp/org-crypt.elc:     lisp/org-crypt.el lisp/org.el
 476 lisp/org-ctags.elc:     lisp/org.el
 477 lisp/org-datetree.elc:  lisp/org.el
 478 lisp/org-docview.elc:   lisp/org.el
 479 lisp/org-entities.elc:
 480 lisp/org-exp.elc:       lisp/org.el lisp/org-agenda.el
 481 lisp/org-exp-blocks.elc: lisp/org.el
 482 lisp/org-latex.elc:     lisp/org.el lisp/org-exp.el lisp/org-beamer.el
 483 lisp/org-docbook.elc:   lisp/org.el lisp/org-exp.el
 484 lisp/org-faces.elc:     lisp/org-macs.el lisp/org-compat.el
 485 lisp/org-feed.elc:      lisp/org.el
 486 lisp/org-footnotes.elc: lisp/org-macs.el lisp/org-compat.el
 487 lisp/org-freemind.elc:  lisp/org.el
 488 lisp/org-gnus.elc:      lisp/org.el
 489 lisp/org-html.elc:      lisp/org-exp.el
 490 lisp/org-habit.elc:     lisp/org.el lisp/org-agenda.el
 491 lisp/org-icalendar.elc: lisp/org-exp.el
 492 lisp/org-id.elc:        lisp/org.el
 493 lisp/org-indent.elc:    lisp/org.el lisp/org-macs.el lisp/org-compat.el
 494 lisp/org-info.elc:      lisp/org.el
 495 lisp/org-inlinetask.elc:
 496 lisp/org-irc.elc:       lisp/org.el
 497 lisp/org-jsinfo.elc:    lisp/org.el lisp/org-exp.el
 498 lisp/org-list.elc:      lisp/org-macs.el lisp/org-compat.el
 499 lisp/org-lparse.elc:    lisp/org-exp.el
 500 lisp/org-mac-message.elc:       lisp/org.el
 501 lisp/org-macs.elc:
 502 lisp/org-mew.elc:       lisp/org.el
 503 lisp/org-mhe.elc:       lisp/org.el
 504 lisp/org-mks.elc:
 505 lisp/org-mobile.elc:    lisp/org.el
 506 lisp/org-mouse.elc:     lisp/org.el
 507 lisp/org-odt.elc:       lisp/org-lparse.el
 508 lisp/org-plot.elc:      lisp/org.el lisp/org-exp.el lisp/org-table.el
 509 lisp/org-publish.elc:
 510 lisp/org-protocol.elc:  lisp/org.el
 511 lisp/org-remember.elc:  lisp/org.el
 512 lisp/org-rmail.elc:     lisp/org.el
 513 lisp/org-special-blocks.elc:    lisp/org-compat.el
 514 lisp/org-src.elc:       lisp/org-macs.el lisp/org-compat.el
 515 lisp/org-table.elc:     lisp/org.el
 516 lisp/org-taskjuggler.elc: lisp/org.el lisp/org-exp.el
 517 lisp/org-timer.elc:     lisp/org.el
 518 lisp/org-vm.elc:        lisp/org.el
 519 lisp/org-w3m.elc:       lisp/org.el
 520 lisp/org-wl.elc:        lisp/org.el
 521 lisp/org-xoxo.elc:      lisp/org-exp.el
 522
 523 # Describe valid make targets for org-mode.
 524 targets help:
 525         @echo "make - compile Org ELisp files"
 526         @echo "make clean - clean Elisp and documentation files"
 527         @echo "make all - compile Org ELisp files and documentation"
 528         @echo ""
 529         @echo "make doc - make all documentation"
 530         @echo "make info - make Info documentation"
 531         @echo "make html - make HTML documentation"
 532         @echo "make pdf - make pdf documentation"
 533         @echo "make card - make refcards documentation"
 534         @echo ""
 535         @echo "make install - install Org"
 536         @echo "make install-lisp - install Org ELisp files"
 537         @echo "make install-info - install Org Info file"