Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 0304b2bc2bc3acaa4c6ff71816b69cc7c4b49997 / . / docs / Makefile
blob: 6cea58dd5ef844703edf8f69d0ad4b026d8fe514 [file] [log] [blame]
John Criswelld8846c12003-10-21 14:33:46 +0000[diff] [blame]1##===- 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 +0000[diff] [blame]9
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]10LEVEL := ..
11DIRS := CommandGuide
12
Chris Lattner9e4692c2006-07-06 00:36:52 +0000[diff] [blame]13ifdef BUILD_FOR_WEBSITE
14PROJ_OBJ_DIR = .
15DOXYGEN = doxygen
Reid Spencer12cabda2007-03-04 00:45:50 +0000[diff] [blame]16# Extract version number from the AC_INT line in configure.ac
17# AC_INIT([[llvm]],[[2.0cvs]],[llvmbugs@cs.uiuc.edu])
18PACKAGE_VERSION = $(shell grep AC_INIT ../autoconf/configure.ac | sed -e 's/[^,]*,[[][[]//' -e 's/]],.*//')
19$(warning VERSION=$(VERSION))
Chris Lattner9e4692c2006-07-06 00:36:52 +0000[diff] [blame]20
Tanya Lattnerb747fd22007-03-27 23:19:39 +0000[diff] [blame]21$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
Reid Spencer12cabda2007-03-04 00:45:50 +0000[diff] [blame]22 cat $< | sed \
23 -e 's/@abs_top_srcdir@/../g' \
24 -e 's/@DOT@/dot/g' \
25 -e 's/@PACKAGE_VERSION@/$(PACKAGE_VERSION)/g' \
26 -e 's/@abs_top_builddir@/../g' > $@
Chris Lattner9e4692c2006-07-06 00:36:52 +0000[diff] [blame]27endif
28
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]29include $(LEVEL)/Makefile.common
30
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]31HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
32 $(wildcard $(PROJ_SRC_DIR)/*.css)
33IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Reid Spencer5a069f52005-01-11 06:26:27 +0000[diff] [blame]34DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
35 doxygen.intro
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]36EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
37
38.PHONY: install-html install-doxygen doxygen
39
40ifeq ($(ENABLE_DOXYGEN),1)
41install-local:: install-html install-doxygen
42else
43install-local:: install-html
44endif
45
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]46install-html: $(PROJ_OBJ_DIR)/html.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]47 $(Echo) Installing HTML documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +0000[diff] [blame]48 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
49 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
50 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
51 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
52 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]53
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]54$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]55 $(Echo) Packaging HTML documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]56 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
57 $(Verb) cd $(PROJ_SRC_DIR) && \
58 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
59 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]60
61install-doxygen: doxygen
62 $(Echo) Installing doxygen documentation
63 $(Echo) Installing doxygen documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +0000[diff] [blame]64 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
65 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]66 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]67 $(FIND) . -type f -exec \
Reid Spencer29fbdd72005-02-24 21:28:08 +0000[diff] [blame]68 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]69
Reid Spencer0b57a762007-03-27 06:06:15 +0000[diff] [blame]70doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]71
Reid Spencer0b57a762007-03-27 06:06:15 +0000[diff] [blame]72regendoc:
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]73 $(Echo) Building doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]74 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
75 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
Reid Spencer5a069f52005-01-11 06:26:27 +0000[diff] [blame]76 fi
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]77 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencer0b57a762007-03-27 06:06:15 +0000[diff] [blame]78
79$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]80 $(Echo) Packaging doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +0000[diff] [blame]81 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
82 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
83 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
Chris Lattner889bc472005-11-30 06:31:28 +0000[diff] [blame]84 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
Reid Spencerca5fc7b2004-11-29 04:47:35 +0000[diff] [blame]85
Reid Spencerd5de2c82005-05-16 18:29:13 +0000[diff] [blame]86userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
87
88$(LLVM_SRC_ROOT)/docs/userloc.html:
Reid Spenceree6fcf22005-05-16 18:12:58 +0000[diff] [blame]89 $(Echo) Making User LOC Table
90 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
Reid Spencerd5de2c82005-05-16 18:29:13 +0000[diff] [blame]91 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
Reid Spenceree6fcf22005-05-16 18:12:58 +0000[diff] [blame]92