From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <mario.alfredo.c.arevalo@intel.com>
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
by dpdk.org (Postfix) with ESMTP id EF0CA8DA9
for <dev@dpdk.org>; Tue, 1 Dec 2015 01:53:08 +0100 (CET)
Received: from fmsmga003.fm.intel.com ([10.253.24.29])
by fmsmga103.fm.intel.com with ESMTP; 30 Nov 2015 16:53:08 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.20,366,1444719600"; d="scan'208";a="610300666"
Received: from mcarril6-mobl.zpn.intel.com ([10.219.16.33])
by FMSMGA003.fm.intel.com with ESMTP; 30 Nov 2015 16:53:07 -0800
From: Mario Carrillo <mario.alfredo.c.arevalo@intel.com>
To: dev@dpdk.org
Date: Mon, 30 Nov 2015 18:53:19 -0600
Message-Id: <1448931205-17357-6-git-send-email-mario.alfredo.c.arevalo@intel.com>
X-Mailer: git-send-email 2.6.3
In-Reply-To: <1448931205-17357-1-git-send-email-mario.alfredo.c.arevalo@intel.com>
References: <1442608390-12537-1-git-send-email-mario.alfredo.c.arevalo@intel.com>
<1448931205-17357-1-git-send-email-mario.alfredo.c.arevalo@intel.com>
Cc: jos.c.venegas.munoz@intel.com
Subject: [dpdk-dev] [PATCH v7 05/11] mk: Add rule for installing
documentation
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 01 Dec 2015 00:53:09 -0000
Add hierarchy-file support to the DPDK documentation,
when invoking "make install-doc" documentation files will
be installed in: $(DESTDIR)/$(docdir) where
docdir=$(datarootdir)/doc/dpdk
datarootdir=$(prefix)/share
prefix=/usr/local by default, you can override "prefix",
"datarootdir" and "docdir" vars.
This hierarchy is based on:
http://www.freedesktop.org/software/systemd/man/file-hierarchy.html
and variables are based on:
https://www.gnu.org/prep/standards/html_node/Directory-Variables.html
https://www.gnu.org/prep/standards/html_node/DESTDIR.html
Signed-off-by: Mario Carrillo <mario.alfredo.c.arevalo@intel.com>
---
mk/rte.sdkinstall.mk | 17 +++++++++++++++++
mk/rte.sdkroot.mk | 5 +++--
2 files changed, 20 insertions(+), 2 deletions(-)
diff --git a/mk/rte.sdkinstall.mk b/mk/rte.sdkinstall.mk
index 1502399..c062489 100644
--- a/mk/rte.sdkinstall.mk
+++ b/mk/rte.sdkinstall.mk
@@ -47,11 +47,14 @@ exec_prefix ?= $(prefix)
includedir ?= $(prefix)/include/dpdk
bindir ?= $(exec_prefix)/bin
libdir ?= $(exec_prefix)/lib
+datarootdir ?= $(prefix)/share
+docdir ?= $(datarootdir)/doc/dpdk
HSLINKS := $(shell find $(RTE_OUTPUT)/include/ -name *.h)
BINARY_FILES := $(patsubst %.map,,$(wildcard $(RTE_OUTPUT)/app/*))
NIC_FILES := $(wildcard $(RTE_SDK)/tools/*.py)
LIBS := $(wildcard $(RTE_OUTPUT)/lib/*)
MODULES := $(wildcard $(RTE_OUTPUT)/kmod/*)
+DOCS := $(wildcard $(RTE_SDK)/doc/*)
BINARY_FILES += $(NIC_FILES)
include $(RTE_OUTPUT)/.config
RTE_EXEC_ENV := $(CONFIG_RTE_EXEC_ENV:"%"=%)
@@ -153,6 +156,20 @@ install-mod:
done \
fi
#
+# install documentation in /usr/local/share/doc/dpdk
+# by default, "docdir", "prefix" and "datarootdir" vars can be overriden.
+#
+.PHONY: install-doc
+install-doc:
+ @echo ================== Installing documentation
+ @if [ ! -z "${DOCS}" ]; then \
+ [ -d $(DESTDIR)/$(docdir) ] || mkdir -p $(DESTDIR)/$(docdir); \
+ for DOC in ${DOCS}; do \
+ cp -rf $$DOC ${DESTDIR}/${docdir}; \
+ echo installing: $$DOC; \
+ done \
+ fi
+#
# uninstall: remove all built sdk
#
UNINSTALL_TARGETS := $(addsuffix _uninstall,\
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index e652218..f56341d 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -97,8 +97,9 @@ 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.6.3