| 1 |
.PHONY: install uninstall clean |
| 2 |
|
| 3 |
.NOTPARALLEL: |
| 4 |
|
| 5 |
SOURCE_DIR := source |
| 6 |
BUILD_DIR := build |
| 7 |
|
| 8 |
SPHINXOPTS := -q |
| 9 |
|
| 10 |
# commands to install files |
| 11 |
INSTALL = install |
| 12 |
INSTALL_DIR = $(INSTALL) -d -m 755 |
| 13 |
INSTALL_DATA = $(INSTALL) -m 644 |
| 14 |
|
| 15 |
# source definitions shared across the Makefiles of this project |
| 16 |
ifneq ($(wildcard ../Makefile.inc),../Makefile.inc) |
| 17 |
$(error ../Makefile.inc is missing, please run '../configure') |
| 18 |
endif |
| 19 |
include ../Makefile.inc |
| 20 |
|
| 21 |
# quit if no sphinx-build found at configure time |
| 22 |
ifeq ($(builddoc),n) |
| 23 |
$(error No 'sphinx-build' command defined, cannot build documentation) |
| 24 |
endif |
| 25 |
|
| 26 |
# setup summary echo rules unless silent mode set |
| 27 |
ECHO_DIR_PREFIX = doc/ |
| 28 |
ifneq ($(findstring s,$(MAKEFLAGS)),s) |
| 29 |
ECHO_GEN = @echo ' ' GEN $(ECHO_DIR_PREFIX)$@; |
| 30 |
ECHO_GEN2 = @echo ' ' GEN |
| 31 |
else |
| 32 |
# disable echo rules followed by a string |
| 33 |
ECHO_GEN2 = \# |
| 34 |
endif |
| 35 |
|
| 36 |
ALL_RST := $(filter-out $(SOURCE_DIR)/latex_index.rst, $(wildcard $(SOURCE_DIR)/*.rst\ |
| 37 |
$(SOURCE_DIR)/cookbook/*.rst $(SOURCE_DIR)/design/*.rst)) |
| 38 |
ALL_TXT := $(patsubst $(SOURCE_DIR)/%,$(BUILD_DIR)/%,$(patsubst %.rst,%.txt,$(ALL_RST))) |
| 39 |
ALL_HTML := $(patsubst $(SOURCE_DIR)/%,$(BUILD_DIR)/%,$(patsubst %.rst,%.html,$(ALL_RST))) |
| 40 |
ALL_MAN := $(BUILD_DIR)/module.1 $(BUILD_DIR)/ml.1 $(BUILD_DIR)/envml.1\ |
| 41 |
$(BUILD_DIR)/modulefile.5 |
| 42 |
ALL_TEX := $(BUILD_DIR)/latex/modules.tex |
| 43 |
ALL_PDF := $(BUILD_DIR)/latex/modules.pdf |
| 44 |
|
| 45 |
all: man txt |
| 46 |
|
| 47 |
# enable HTML pages build only from git repository |
| 48 |
ifeq ($(wildcard ../.git),../.git) |
| 49 |
ifneq ($(builddoc),p) |
| 50 |
all: html |
| 51 |
endif |
| 52 |
endif |
| 53 |
|
| 54 |
man: $(ALL_MAN) |
| 55 |
|
| 56 |
ifneq ($(builddoc),p) |
| 57 |
txt: $(ALL_TXT) |
| 58 |
html: $(ALL_HTML) |
| 59 |
latex: $(ALL_TEX) |
| 60 |
latexpdf: $(ALL_PDF) |
| 61 |
else |
| 62 |
# limit txt targets to documents that have been prebuilt |
| 63 |
txt: $(BUILD_DIR)/changes.txt $(BUILD_DIR)/MIGRATING.txt \ |
| 64 |
$(BUILD_DIR)/INSTALL.txt $(BUILD_DIR)/INSTALL-win.txt \ |
| 65 |
$(BUILD_DIR)/NEWS.txt $(BUILD_DIR)/CONTRIBUTING.txt |
| 66 |
endif |
| 67 |
|
| 68 |
../version.inc: |
| 69 |
$(MAKE) --no-print-directory -C .. version.inc |
| 70 |
|
| 71 |
# source version definitions shared across the Makefiles of this project |
| 72 |
ifeq ($(findstring clean,$(MAKECMDGOALS)),) |
| 73 |
-include ../version.inc |
| 74 |
endif |
| 75 |
|
| 76 |
define translate-in-script |
| 77 |
$(ECHO_GEN) |
| 78 |
sed -e 's|@prefix@|$(prefix)|g' \ |
| 79 |
-e 's|@libexecdir@|$(libexecdir)|g' \ |
| 80 |
-e 's|@etcdir@|$(etcdir)|g' \ |
| 81 |
-e 's|@initdir@|$(initdir)|g' \ |
| 82 |
-e 's|@modulefilesdir@|$(modulefilesdir)|g' \ |
| 83 |
-e 's|@MODULES_RELEASE@|$(MODULES_RELEASE)|g' \ |
| 84 |
-e 's|@MODULES_BUILD@|$(MODULES_BUILD)|g' \ |
| 85 |
-e 's|@MODULES_BUILD_DATE@|$(MODULES_BUILD_DATE)|g' $< > $@ |
| 86 |
endef |
| 87 |
|
| 88 |
# avoid shared definitions to be rebuilt by make |
| 89 |
../Makefile.inc: ; |
| 90 |
|
| 91 |
# rules to build docs from source are defined if docs are not found pre-built |
| 92 |
# which happens when working from git repository or from a `git archive` dist |
| 93 |
ifneq ($(builddoc),p) |
| 94 |
$(SOURCE_DIR)/version.py: $(SOURCE_DIR)/version.py.in ../version.inc |
| 95 |
$(translate-in-script) |
| 96 |
|
| 97 |
linkcheck: $(SOURCE_DIR)/version.py |
| 98 |
$(SPHINXBUILD) $(SPHINXOPTS) -b linkcheck "$(SOURCE_DIR)" "$(BUILD_DIR)" |
| 99 |
|
| 100 |
$(BUILD_DIR)/%.html: $(SOURCE_DIR)/%.rst $(SOURCE_DIR)/version.py |
| 101 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/*.html |
| 102 |
$(SPHINXBUILD) $(SPHINXOPTS) -b html "$(SOURCE_DIR)" "$(BUILD_DIR)" |
| 103 |
|
| 104 |
$(BUILD_DIR)/%.txt: $(SOURCE_DIR)/%.rst $(SOURCE_DIR)/version.py |
| 105 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/*.txt |
| 106 |
$(SPHINXBUILD) $(SPHINXOPTS) -b text "$(SOURCE_DIR)" "$(BUILD_DIR)" |
| 107 |
|
| 108 |
$(BUILD_DIR)/module.1.in $(BUILD_DIR)/modulefile.5 $(BUILD_DIR)/ml.1 $(BUILD_DIR)/envml.1: $(ALL_RST) $(SOURCE_DIR)/version.py |
| 109 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/envml.1 |
| 110 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/ml.1 |
| 111 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/module.1.in |
| 112 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/modulefile.5 |
| 113 |
$(SPHINXBUILD) $(SPHINXOPTS) -t pathsubs -b man "$(SOURCE_DIR)" "$(BUILD_DIR)" |
| 114 |
$(if $(findstring module.1.in,$@),mv $(BUILD_DIR)/module.1 $@) |
| 115 |
endif |
| 116 |
|
| 117 |
$(BUILD_DIR)/module.1: $(BUILD_DIR)/module.1.in |
| 118 |
$(translate-in-script) |
| 119 |
|
| 120 |
$(BUILD_DIR)/latex/modules.tex: $(SOURCE_DIR)/version.py |
| 121 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$@ |
| 122 |
$(SPHINXBUILD) $(SPHINXOPTS) -b latex "$(SOURCE_DIR)" "$(BUILD_DIR)/latex" |
| 123 |
|
| 124 |
$(BUILD_DIR)/latex/modules.pdf: $(BUILD_DIR)/latex/modules.tex |
| 125 |
$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$@ |
| 126 |
$(MAKE) -C "$(BUILD_DIR)/latex" all-pdf |
| 127 |
|
| 128 |
install: man txt |
| 129 |
$(INSTALL_DIR) '$(DESTDIR)$(mandir)/man1' '$(DESTDIR)$(mandir)/man5' |
| 130 |
ifeq ($(docinstall),y) |
| 131 |
$(INSTALL_DIR) '$(DESTDIR)$(docdir)' |
| 132 |
$(INSTALL_DATA) $(BUILD_DIR)/changes.txt '$(DESTDIR)$(docdir)/' |
| 133 |
$(INSTALL_DATA) $(BUILD_DIR)/MIGRATING.txt '$(DESTDIR)$(docdir)/' |
| 134 |
$(INSTALL_DATA) $(BUILD_DIR)/INSTALL.txt '$(DESTDIR)$(docdir)/' |
| 135 |
$(INSTALL_DATA) $(BUILD_DIR)/INSTALL-win.txt '$(DESTDIR)$(docdir)/' |
| 136 |
$(INSTALL_DATA) $(BUILD_DIR)/NEWS.txt '$(DESTDIR)$(docdir)/' |
| 137 |
$(INSTALL_DATA) $(BUILD_DIR)/CONTRIBUTING.txt '$(DESTDIR)$(docdir)/' |
| 138 |
endif |
| 139 |
$(INSTALL_DATA) $(BUILD_DIR)/module.1 '$(DESTDIR)$(mandir)/man1/' |
| 140 |
$(INSTALL_DATA) $(BUILD_DIR)/ml.1 '$(DESTDIR)$(mandir)/man1/' |
| 141 |
$(INSTALL_DATA) $(BUILD_DIR)/envml.1 '$(DESTDIR)$(mandir)/man1/' |
| 142 |
$(INSTALL_DATA) $(BUILD_DIR)/modulefile.5 '$(DESTDIR)$(mandir)/man5/' |
| 143 |
|
| 144 |
uninstall: |
| 145 |
ifeq ($(docinstall),y) |
| 146 |
rm -f '$(DESTDIR)$(docdir)/changes.txt' |
| 147 |
rm -f '$(DESTDIR)$(docdir)/MIGRATING.txt' |
| 148 |
rm -f '$(DESTDIR)$(docdir)/INSTALL.txt' |
| 149 |
rm -f '$(DESTDIR)$(docdir)/INSTALL-win.txt' |
| 150 |
rm -f '$(DESTDIR)$(docdir)/NEWS.txt' |
| 151 |
rm -f '$(DESTDIR)$(docdir)/CONTRIBUTING.txt' |
| 152 |
rmdir '$(DESTDIR)$(docdir)' |
| 153 |
endif |
| 154 |
rm -f '$(DESTDIR)$(mandir)/man1/module.1' |
| 155 |
rm -f '$(DESTDIR)$(mandir)/man1/ml.1' |
| 156 |
rm -f '$(DESTDIR)$(mandir)/man1/envml.1' |
| 157 |
rm -f '$(DESTDIR)$(mandir)/man5/modulefile.5' |
| 158 |
rmdir '$(DESTDIR)$(mandir)/man1' '$(DESTDIR)$(mandir)/man5' |
| 159 |
rmdir '$(DESTDIR)$(mandir)' |
| 160 |
|
| 161 |
clean: |
| 162 |
# do not clean generated docs if not in git repository |
| 163 |
ifeq ($(wildcard ../.git),../.git) |
| 164 |
ifeq ($(wildcard $(BUILD_DIR)),$(BUILD_DIR)) |
| 165 |
rm -rf $(BUILD_DIR) |
| 166 |
endif |
| 167 |
rm -f $(SOURCE_DIR)/version.py |
| 168 |
endif |
| 169 |
rm -f $(BUILD_DIR)/module.1 |
| 170 |
|
| 171 |
# quiet all commands unless verbose mode set |
| 172 |
ifeq ($(VERBOSE),1) |
| 173 |
V = 1 |
| 174 |
endif |
| 175 |
# let verbose by default the install/clean/test and other specific non-build targets |
| 176 |
$(V).SILENT: ../version.inc $(SOURCE_DIR)/version.py $(ALL_HTML) $(ALL_TXT) \ |
| 177 |
$(BUILD_DIR)/module.1.in $(ALL_MAN) $(ALL_TEX) $(ALL_PDF) |