blob: 92ba96107ca5ed988a850bdc6ec0a0a5bf245845 [file] [log] [blame]
John Criswelld8846c12003-10-21 14:33:46 +00001##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
5# This file was developed by the LLVM research group and is distributed under
6# the University of Illinois Open Source License. See LICENSE.TXT for details.
7#
8##===----------------------------------------------------------------------===##
Chris Lattnerb9a827c2002-01-30 21:20:23 +00009
Reid Spencerca5fc7b2004-11-29 04:47:35 +000010LEVEL := ..
11DIRS := CommandGuide
12
13include $(LEVEL)/Makefile.common
14
Reid Spencerbdf6a392005-01-16 02:21:29 +000015HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
16 $(wildcard $(PROJ_SRC_DIR)/*.css)
17IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Reid Spencer5a069f52005-01-11 06:26:27 +000018DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
19 doxygen.intro
Reid Spencerca5fc7b2004-11-29 04:47:35 +000020EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
21
22.PHONY: install-html install-doxygen doxygen
23
24ifeq ($(ENABLE_DOXYGEN),1)
25install-local:: install-html install-doxygen
26else
27install-local:: install-html
28endif
29
Reid Spencerbdf6a392005-01-16 02:21:29 +000030install-html: $(PROJ_OBJ_DIR)/html.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000031 $(Echo) Installing HTML documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000032 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
33 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
34 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
35 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
36 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000037
Reid Spencerbdf6a392005-01-16 02:21:29 +000038$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000039 $(Echo) Packaging HTML documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000040 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
41 $(Verb) cd $(PROJ_SRC_DIR) && \
42 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
43 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
Reid Spencerca5fc7b2004-11-29 04:47:35 +000044
45install-doxygen: doxygen
46 $(Echo) Installing doxygen documentation
47 $(Echo) Installing doxygen documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000048 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
49 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
Reid Spencerbdf6a392005-01-16 02:21:29 +000050 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
Reid Spencerca5fc7b2004-11-29 04:47:35 +000051 $(FIND) . -type f -exec \
Reid Spencer29fbdd72005-02-24 21:28:08 +000052 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
Reid Spencerca5fc7b2004-11-29 04:47:35 +000053
Reid Spencerbdf6a392005-01-16 02:21:29 +000054doxygen: $(PROJ_OBJ_DIR)/doxygen.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000055
Reid Spencerbdf6a392005-01-16 02:21:29 +000056$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +000057 $(Echo) Building doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000058 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
59 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
Reid Spencer5a069f52005-01-11 06:26:27 +000060 fi
Reid Spencerbdf6a392005-01-16 02:21:29 +000061 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +000062 $(Echo) Packaging doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000063 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
64 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
65 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
Chris Lattner889bc472005-11-30 06:31:28 +000066 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
Reid Spencerca5fc7b2004-11-29 04:47:35 +000067
Reid Spencerd5de2c82005-05-16 18:29:13 +000068userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
69
70$(LLVM_SRC_ROOT)/docs/userloc.html:
Reid Spenceree6fcf22005-05-16 18:12:58 +000071 $(Echo) Making User LOC Table
72 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
Reid Spencerd5de2c82005-05-16 18:29:13 +000073 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
Reid Spenceree6fcf22005-05-16 18:12:58 +000074