[dpdk-dev] [PATCH v4 5/7] mk: Add rule for installing documentation

Mario Carrillo mario.alfredo.c.arevalo at intel.com
Mon Oct 5 22:20:04 CEST 2015


Add hierarchy-file support to the DPDK documentation.

When invoking "make install-doc" documentation files will
be installed in: $(DESTDIR)/$(DOC_DIR) where
DOC_DIR=$(DESTDIR)/usr/share/doc/dpdk by default.

You can override DOC_DIR var.
This hierarchy is based on:
http://www.freedesktop.org/software/systemd/man/file-hierarchy.html

Signed-off-by: Mario Carrillo <mario.alfredo.c.arevalo at intel.com>
---
 mk/rte.sdkinstall.mk | 14 ++++++++++++++
 mk/rte.sdkroot.mk    |  6 ++++--
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/mk/rte.sdkinstall.mk b/mk/rte.sdkinstall.mk
index 628d9fb..d917329 100644
--- a/mk/rte.sdkinstall.mk
+++ b/mk/rte.sdkinstall.mk
@@ -44,12 +44,14 @@ T=*
 ifneq (,$(wildcard $(BUILD_DIR)/build/.config))
 INCLUDE_DIR ?= /usr/include/dpdk
 BIN_DIR ?= /usr/bin
+DOC_DIR ?= /usr/share/doc/dpdk
 HSLINKS := $(wildcard $(RTE_OUTPUT)/include/*)
 BINARY_FILES := $(patsubst %.map,,$(wildcard $(RTE_OUTPUT)/app/*))
 NIC_FILES := $(wildcard $(BUILD_DIR)/tools/*.py)
 BINARY_FILES += $(NIC_FILES)
 LIBS := $(wildcard $(RTE_OUTPUT)/lib/*)
 MODULES := $(wildcard $(RTE_OUTPUT)/kmod/*)
+DOCS := $(wildcard $(BUILD_DIR)/doc/*)
 include $(BUILD_DIR)/build/.config
 RTE_ARCH := $(CONFIG_RTE_ARCH:"%"=%)
 RTE_EXEC_ENV := $(CONFIG_RTE_EXEC_ENV:"%"=%)
@@ -148,6 +150,18 @@ install-mod:
 	echo installing: $$MOD; \
 	done
 #
+# install documentation in /usr/share/doc/dpdk
+# bu default, DOC_DIR can be overriden.
+#
+.PHONY: install-doc
+install-doc:
+	@echo ================== Installing documentation
+	@[ -d $(DESTDIR)/$(DOC_DIR) ] || mkdir -p $(DESTDIR)/$(DOC_DIR)
+	@for DOC in ${DOCS}; do \
+	cp -rf $$DOC ${DESTDIR}/${DOC_DIR}; \
+	echo installing: $$DOC; \
+	done
+#
 # uninstall: remove all built sdk
 #
 UNINSTALL_TARGETS := $(addsuffix _uninstall,\
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index e652218..43f937e 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -97,8 +97,10 @@ test fast_test ring_test mempool_test perf_test coverage:
 testall:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdktestall.mk $@
 
-.PHONY: install install-headers install-bin install-lib install-mod uninstall
-install install-headers install-bin install-lib install-mod uninstall:
+.PHONY: install install-headers install-bin install-lib install-mod \
+install-doc uninstall
+install install-headers install-bin install-lib install-mod install-doc \
+uninstall:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@
 
 .PHONY: doc help
-- 
2.1.0



More information about the dev mailing list