blob: a2953512b819bfa665ccd945f7beca291a9603af [file] [log] [blame]
Reid Spencer52d7a752004-11-29 03:45:02 +00001##===- docs/CommandGuide/Makefile --------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
Chris Lattner57360d12007-12-29 20:11:13 +00005# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
Reid Spencer52d7a752004-11-29 03:45:02 +00007#
8##===----------------------------------------------------------------------===##
Brian Gaekee993d202004-05-14 19:50:33 +00009
Reid Spencer63184562004-12-08 04:43:40 +000010ifdef BUILD_FOR_WEBSITE
11# This special case is for keeping the CommandGuide on the LLVM web site
12# up to date automatically as the documents are checked in. It must build
13# the POD files to HTML only and keep them in the src directories. It must also
14# build in an unconfigured tree, hence the ifdef. To use this, run
15# make -s BUILD_FOR_WEBSITE=1 inside the cvs commit script.
Chris Lattner18232a52008-02-12 06:07:47 +000016SRC_DOC_DIR=
17DST_HTML_DIR=html/
18DST_MAN_DIR=man/man1/
19DST_PS_DIR=ps/
Reid Spencer63184562004-12-08 04:43:40 +000020
Chris Lattner18232a52008-02-12 06:07:47 +000021# If we are in BUILD_FOR_WEBSITE mode, default to the all target.
22all:: html man ps
Reid Spencere47fd7d2004-12-08 19:01:01 +000023
24clean:
25 rm -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
Chris Lattner18232a52008-02-12 06:07:47 +000026else
Reid Spencer63184562004-12-08 04:43:40 +000027
Chris Lattner18232a52008-02-12 06:07:47 +000028# Otherwise, if not in BUILD_FOR_WEBSITE mode, use the project info.
Reid Spencer52d7a752004-11-29 03:45:02 +000029LEVEL := ../..
Reid Spencer52d7a752004-11-29 03:45:02 +000030include $(LEVEL)/Makefile.common
31
Chris Lattner18232a52008-02-12 06:07:47 +000032SRC_DOC_DIR=$(PROJ_SRC_DIR)/
33DST_HTML_DIR=$(PROJ_OBJ_DIR)/
34DST_MAN_DIR=$(PROJ_OBJ_DIR)/
35DST_PS_DIR=$(PROJ_OBJ_DIR)/
Reid Spencer52d7a752004-11-29 03:45:02 +000036
Chris Lattner18232a52008-02-12 06:07:47 +000037endif
Reid Spencer52d7a752004-11-29 03:45:02 +000038
Chris Lattner18232a52008-02-12 06:07:47 +000039
40POD := $(wildcard $(SRC_DOC_DIR)*.pod)
41HTML := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_HTML_DIR)%.html, $(POD))
42MAN := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD))
43PS := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD))
Reid Spencer52d7a752004-11-29 03:45:02 +000044
Brian Gaekee993d202004-05-14 19:50:33 +000045.SUFFIXES:
46.SUFFIXES: .html .pod .1 .ps
47
Chris Lattner18232a52008-02-12 06:07:47 +000048$(DST_HTML_DIR)%.html: %.pod $(DST_HTML_DIR)/.dir
49 pod2html --css=manpage.css --htmlroot=. \
50 --podpath=. --noindex --infile=$< --outfile=$@ --title=$*
51
52$(DST_MAN_DIR)%.1: %.pod $(DST_MAN_DIR)/.dir
53 pod2man --release=CVS --center="LLVM Command Guide" $< $@
54
55$(DST_PS_DIR)%.ps: $(DST_MAN_DIR)%.1 $(DST_PS_DIR)/.dir
56 groff -Tps -man $< > $@
57
Reid Spencer52d7a752004-11-29 03:45:02 +000058
Chris Lattnerdbcd4f52004-12-09 21:06:32 +000059html: $(HTML)
Chris Lattner18232a52008-02-12 06:07:47 +000060man: $(MAN)
61ps: $(PS)
Chris Lattnerdbcd4f52004-12-09 21:06:32 +000062
Chris Lattner18232a52008-02-12 06:07:47 +000063EXTRA_DIST := $(POD) index.html
Brian Gaekee993d202004-05-14 19:50:33 +000064
Reid Spencer52d7a752004-11-29 03:45:02 +000065clean-local::
66 $(Verb) $(RM) -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
Brian Gaekee993d202004-05-14 19:50:33 +000067
Reid Spencerbdf6a392005-01-16 02:21:29 +000068HTML_DIR := $(PROJ_docsdir)/html/CommandGuide
69MAN_DIR := $(PROJ_mandir)/man1
70PS_DIR := $(PROJ_docsdir)/ps
Reid Spencer3c54b6c2004-11-29 04:34:05 +000071
Reid Spencer52d7a752004-11-29 03:45:02 +000072install-local:: $(HTML) $(MAN) $(PS)
73 $(Echo) Installing HTML CommandGuide Documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000074 $(Verb) $(MKDIR) $(HTML_DIR)
75 $(Verb) $(DataInstall) $(HTML) $(HTML_DIR)
76 $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/index.html $(HTML_DIR)
Reid Spencer837300a2005-02-24 21:41:26 +000077 $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/manpage.css $(HTML_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000078 $(Echo) Installing MAN CommandGuide Documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000079 $(Verb) $(MKDIR) $(MAN_DIR)
80 $(Verb) $(DataInstall) $(MAN) $(MAN_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000081 $(Echo) Installing PS CommandGuide Documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000082 $(Verb) $(MKDIR) $(PS_DIR)
83 $(Verb) $(DataInstall) $(PS) $(PS_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000084
85uninstall-local::
Erick Tryzelaar4f678c32008-03-30 20:32:18 +000086 $(Echo) Uninstalling CommandGuide Documentation
87 $(Verb) $(RM) -rf $(HTML_DIR) $(MAN_DIR) $(PS_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000088
89printvars::
90 $(Echo) "POD : " '$(POD)'
91 $(Echo) "HTML : " '$(HTML)'