Makefile revision 747d2f83a980debd0ec75a05af7e97d44e7dc998 
1##===- docs/tools/Makefile ---------------------------------*- Makefile -*-===##
2# 
3#                     The LLVM Compiler Infrastructure
4#
5# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
7# 
8##===----------------------------------------------------------------------===##
9
10ifdef BUILD_FOR_WEBSITE
11
12# FIXME: This was copied from the CommandGuide makefile. Figure out
13# how to get this stuff on the website.
14
15# This special case is for keeping the CommandGuide on the LLVM web site
16# up to date automatically as the documents are checked in. It must build
17# the POD files to HTML only and keep them in the src directories. It must also
18# build in an unconfigured tree, hence the ifdef. To use this, run
19# make -s BUILD_FOR_WEBSITE=1 inside the cvs commit script.
20SRC_DOC_DIR=
21DST_HTML_DIR=html/
22DST_MAN_DIR=man/man1/
23DST_PS_DIR=ps/
24CLANG_VERSION := trunk
25
26# If we are in BUILD_FOR_WEBSITE mode, default to the all target.
27all:: html man ps
28
29clean:
30	rm -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
31
32# To create other directories, as needed, and timestamp their creation
33%/.dir:
34	-mkdir $* > /dev/null
35	date > $@
36
37else
38
39# Otherwise, if not in BUILD_FOR_WEBSITE mode, use the project info.
40CLANG_LEVEL := ../..
41include $(CLANG_LEVEL)/Makefile
42
43CLANG_VERSION := $(word 3,$(shell grep "CLANG_VERSION " \
44	$(PROJ_OBJ_DIR)/$(CLANG_LEVEL)/include/clang/Basic/Version.inc))
45
46SRC_DOC_DIR=$(PROJ_SRC_DIR)/
47DST_HTML_DIR=$(PROJ_OBJ_DIR)/
48DST_MAN_DIR=$(PROJ_OBJ_DIR)/
49DST_PS_DIR=$(PROJ_OBJ_DIR)/
50
51endif
52
53
54POD  := $(wildcard $(SRC_DOC_DIR)*.pod)
55HTML := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_HTML_DIR)%.html, $(POD))
56MAN  := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD))
57PS   := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD))
58
59ifdef ONLY_MAN_DOCS
60INSTALL_TARGETS := install-man
61else
62INSTALL_TARGETS := install-html install-man install-ps
63endif
64
65.SUFFIXES:
66.SUFFIXES: .html .pod .1 .ps
67
68$(DST_HTML_DIR)%.html: %.pod $(DST_HTML_DIR)/.dir
69	pod2html --css=manpage.css --htmlroot=. \
70	  --podpath=. --infile=$< --outfile=$@ --title=$*
71
72$(DST_MAN_DIR)%.1: %.pod $(DST_MAN_DIR)/.dir
73	pod2man --release "clang $(CLANG_VERSION)" --center="Clang Tools Documentation" $< $@
74
75$(DST_PS_DIR)%.ps: $(DST_MAN_DIR)%.1 $(DST_PS_DIR)/.dir
76	groff -Tps -man $< > $@
77
78
79html: $(HTML)
80man: $(MAN)
81ps: $(PS)
82
83EXTRA_DIST := $(POD)
84
85clean-local::
86	$(Verb) $(RM) -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
87
88HTML_DIR := $(DESTDIR)$(PROJ_docsdir)/html/clang
89MAN_DIR  := $(DESTDIR)$(PROJ_mandir)/man1
90PS_DIR   := $(DESTDIR)$(PROJ_docsdir)/ps
91
92install-html:: $(HTML)
93	$(Echo) Installing HTML Clang Tools Documentation
94	$(Verb) $(MKDIR) $(HTML_DIR)
95	$(Verb) $(DataInstall) $(HTML) $(HTML_DIR)
96	$(Verb) $(DataInstall) $(PROJ_SRC_DIR)/manpage.css $(HTML_DIR)
97
98install-man:: $(MAN)
99	$(Echo) Installing MAN Clang Tools Documentation
100	$(Verb) $(MKDIR) $(MAN_DIR)
101	$(Verb) $(DataInstall) $(MAN) $(MAN_DIR)
102
103install-ps:: $(PS)
104	$(Echo) Installing PS Clang Tools Documentation
105	$(Verb) $(MKDIR) $(PS_DIR)
106	$(Verb) $(DataInstall) $(PS) $(PS_DIR)
107
108install-local:: $(INSTALL_TARGETS)
109
110uninstall-local::
111	$(Echo) Uninstalling Clang Tools Documentation
112	$(Verb) $(RM) -rf $(HTML_DIR) $(MAN_DIR) $(PS_DIR)
113
114printvars::
115	$(Echo) "POD            : " '$(POD)'
116	$(Echo) "HTML           : " '$(HTML)'
117