[docs] Use RTD links for OPNFV Fuel docs refs
[armband.git] / Makefile
index 9a7f36a..841b6b7 100644 (file)
--- a/Makefile
+++ b/Makefile
-root:=$(shell pwd)
+##############################################################################
+# Copyright (c) 2016,2017 Cavium, Enea AB and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
 
-all: build
+# NOTE: Armband patching consists of:
+# - clone upstream repositories to git submodules, tracking remotes;
+# - tag each submodule (before patching) with "${A_OPNFV_TAG}-root";
+# - apply Armband patches for each submodule;
+# - tag each submodule (after patching) with "${OPNFV_TAG}";
+# - stage Fuel submodule patches by copying them to Fuel f_repos/patch dir;
+# - pass updated repository info to Fuel@OPNFV build system
+#   (e.g. FUEL_PLUGIN_ODL_CHANGE="${OPNFV_TAG}") via armband-fuel-config.mk;
 
-.PHONY: submodules-init submodules-clean
-submodules-init:
-       @git submodule -q init
-       @git submodule -q sync
-       @git submodule update --remote
+# NOTE: Long-term goals (Armband repo should merge with Fuel@OPNFV):
+# - all build related changes should affect Fuel@OPNFV, NOT Armband;
+# - Armband make/build system should only handle patching non-Fuel submodules,
+#   and then invoke Fuel@OPNFV's patch & build system;
+# - Fuel@OPNFV is made aware of an Armband type build by passing
+#   the "ARMBAND_BASE" env var;
 
-# Cleans any changes made to submodules
+SHELL = /bin/sh
+
+export ARMBAND_BASE  := $(shell pwd)
+export OPNFV_GIT_SHA := $(shell git rev-parse HEAD)
+export REVSTATE
+
+include armband-fuel-config.mk
+
+all: upgrade
+
+# Ignore release tag and upgrade Armband to latest change on <branch>/HEAD
+.PHONY: upgrade
+upgrade:
+       @git fetch -u origin ${A_BRANCH}:${A_BRANCH}
+       @git checkout ${A_BRANCH}
+       @$(MAKE) -e submodules-clean patches-import
+
+# Fetch & update git submodules, checkout remote HEAD
+.PHONY: submodules-init
+submodules-init: .submodules-init
+
+.submodules-init:
+       @if [ -n "${ARMBAND_TRACK_REMOTES}" ]; then \
+               git submodule update --init --remote 2>/dev/null; \
+       else \
+               git submodule update --init 2>/dev/null; \
+       fi
+       @touch $@
+
+# Clean any changes made to submodules, checkout Armband root commit
+.PHONY: submodules-clean
 submodules-clean:
-       @git submodule -q foreach \
-               'git am --abort; \
-               git checkout -q armband-workbench-root; \
-               git branch -q -D armband-workbench; \
-               git tag -d armband-workbench-root; \
-               git reset -q --hard HEAD; git clean -xdff'
-
-.PHONY: patches-export patches-import
+       @git submodule -q foreach ' \
+               git am -q --abort 2>/dev/null; \
+               git checkout -q -f ${A_OPNFV_TAG}-root 2>/dev/null; \
+               git branch -q -D opnfv-armband 2>/dev/null; \
+               git tag | grep ${A_OPNFV_TAG} | xargs git tag -d > /dev/null 2>&1; \
+               git reset -q --hard HEAD; \
+               git clean -xdff'
+       @rm -f .submodules-*
+       @$(MAKE) -e submodules-init
+
 # Generate patches from submodules
-patches-export:
-       @git submodule -q foreach 'mkdir -p ${root}/patches/$$name'
-       @git submodule -q foreach 'git format-patch \
-               -o ${root}/patches/$$name -N armband-workbench-root \
-           --no-signature'
-       @find ${root}/patches -name '*.patch' -exec sed -i -e '1d' {} \;
-
-# apply patches from patches/* to respective submodules
-patches-import:
-       @git submodule -q foreach 'mkdir -p ${root}/patches/$$name'
-       @git submodule -q foreach 'git tag armband-workbench-root'
-       @git submodule -q foreach 'git checkout -q -b armband-workbench'
-       @git submodule -q foreach \
-               'if [ ! -z "$$(ls ${root}/patches/$$name/)" ]; then \
-                       echo "-- patching $$name"; \
-                       git am ${root}/patches/$$name/*.patch; \
-               fi'
-clean-docker:
-       @if [ -d ${root}/upstream/fuel/build ]; then \
-               sudo make -C ${root}/upstream/fuel/build deepclean; \
-       fi
-       @for container in $(shell sudo docker ps -a -q); do \
-               sudo docker rm -f -v $${container}; \
-       done
-       @for image in $(shell sudo docker images -q); do \
-               sudo docker rmi -f $${image}; \
+.PHONY: patches-export
+patches-export: .submodules-init
+       @git submodule -q foreach ' \
+               SUB_DIR=${A_PATCH_DIR}/$$name; \
+               rm -rf $$SUB_DIR/*; \
+               git tag | awk "!/root/ && /${A_OPNFV_TAG}-fuel/" | while read A_TAG; do \
+                       SUB_FEATURE=`dirname $${A_TAG#${A_OPNFV_TAG}-fuel/}`; \
+                       echo "`tput setaf 2`== exporting $$name ($$A_TAG)`tput sgr0`"; \
+                       mkdir -p $$SUB_DIR/$${SUB_FEATURE} && \
+                       git format-patch --no-signature --ignore-space-at-eol \
+                               -o $$SUB_DIR/$$SUB_FEATURE -N $$A_TAG-root..$$A_TAG; \
+                       sed -i -e "1{/From: /!d}" -e "s/[[:space:]]*$$//" \
+                               $$SUB_DIR/$$SUB_FEATURE/*.patch; \
+               done'
+
+# Apply patches from patches/* to respective submodules
+.PHONY: patches-import
+patches-import: .submodules-init .submodules-patched
+
+.submodules-patched: ${A_PATCHES}
+       @$(MAKE) submodules-clean
+       @git submodule -q foreach ' \
+               SUB_DIR=${A_PATCH_DIR}/$$name; mkdir -p $$SUB_DIR && \
+               git tag ${A_OPNFV_TAG}-root && \
+               git checkout -q -b opnfv-armband && \
+               find $$SUB_DIR -type d | sort | while read p_dir; do \
+                       SUB_PATCHES=$$(ls $$p_dir/*.patch 2>/dev/null); \
+                       if [ -n "$$SUB_PATCHES" ]; then \
+                               SUB_FEATURE=$${p_dir#$$SUB_DIR} \
+                               SUB_TAG=${A_OPNFV_TAG}-fuel$$SUB_FEATURE/patch; \
+                               echo "`tput setaf 2`== patching $$name ($$SUB_TAG)`tput sgr0`";\
+                               git tag $$SUB_TAG-root && \
+                               git am -3 --whitespace=nowarn --patch-format=mbox \
+                                       --committer-date-is-author-date $$SUB_PATCHES && \
+                               git tag $$SUB_TAG || exit 1; \
+                       fi \
+               done && \
+               git tag ${A_OPNFV_TAG}'
+       # Staging Fuel@OPNFV patches
+       @ls -d ${F_PATCH_DIR}/* 2>/dev/null | while read p_sub_path; do \
+               SUB_NAME=`basename $$p_sub_path`; \
+               find ${A_PATCH_DIR}/$$SUB_NAME -name '*.patch' 2>/dev/null -exec sh -c '\
+                       A_PATCH={}; R_PATCH=$${A_PATCH#${A_PATCH_DIR}/}; \
+                       F_PATCH=${F_PATCH_DIR}/$${0}/armband/$${R_PATCH#$${0}/}; \
+                       if [ -f $$F_PATCH ]; then \
+                               echo "`tput setaf 3`* WARN: $$R_PATCH upstream.`tput sgr0`"; \
+                       else \
+                               if [ -h $$A_PATCH ]; then \
+                                       echo "`tput setaf 3`* PHONY: $$R_PATCH`tput sgr0`"; \
+                               else \
+                                       echo "`tput setaf 6`* Staging $$R_PATCH`tput sgr0`"; \
+                                       mkdir -p `dirname $$F_PATCH` && cp $$A_PATCH $$F_PATCH; \
+                               fi; \
+                       fi' "$$SUB_NAME" \; || true ; \
        done
+       @touch $@
+
+##############################################################################
+# Fuel@OPNFV patch operations - to be used only during development
+##############################################################################
+# Apply all Fuel@OPNFV patches, including Armband patches
+.PHONY: fuel-patches-import
+fuel-patches-import: .submodules-patched fuel-patches-clean
+       $(MAKE) -e -C ${F_PATCH_DIR} patches-import
 
-clean-build:
-       sudo rm -rf /tmp/fuel-main
-       git -C ${root}/upstream/fuel reset --hard HEAD
-       git -C ${root}/upstream/fuel clean -xdff
-
-release: export LC_ALL=en_US.UTF-8
-release: submodules-clean clean-docker clean-build submodules-init patches-import build
-
-ifneq ($(REVSTATE),)
-    EXTRA_PARAMS="REVSTATE=$(REVSTATE)"
-endif
-
-build:
-       cd ${root}/upstream/fuel/build && \
-               make \
-                       BUILD_FUEL_PLUGINS=f_odlpluginbuild \
-                       FUEL_MAIN_REPO=${root}/upstream/fuel-main \
-                       FUEL_MAIN_TAG= \
-                       UBUNTU_ARCH="amd64 arm64" \
-                       FUELLIB_REPO=${root}/upstream/fuel-library \
-                       NAILGUN_REPO=${root}/upstream/fuel-web \
-                       FUEL_AGENT_REPO=${root}/upstream/fuel-agent \
-                       FUEL_NAILGUN_AGENT_REPO=${root}/upstream/fuel-nailgun-agent \
-                       FUEL_MIRROR_REPO=${root}/upstream/fuel-mirror \
-                       ODL_REPO=${root}/upstream/fuel-plugin-opendaylight \
-                       ODL_CHANGE= \
-                       OVS_NSH_DPDK_REPO=${root}/upstream/fuel-plugin-ovs \
-                       OVS_NSH_DPDK_BRANCH=HEAD \
-                       FUELLIB_COMMIT=HEAD \
-                       NAILGUN_COMMIT=HEAD \
-                       FUEL_AGENT_COMMIT=HEAD \
-                       FUEL_NAILGUN_AGENT_COMMIT=HEAD \
-                       FUEL_MIRROR_COMMIT=HEAD \
-                       ODL_BRANCH=armband-workbench \
-                       CENTOS_MAJOR=7 \
-                       EXTRA_RPM_REPOS="armband,http://linux.enea.com/mos-repos/centos/mos9.0-centos7/armband/x86_64,10" \
-                       MIRROR_MOS_UBUNTU=linux.enea.com \
-                       JAVA8_URL=https://launchpad.net/~openjdk-r/+archive/ubuntu/ppa/+files/openjdk-8-jre-headless_8u72-b15-1~trusty1_arm64.deb \
-                       $(EXTRA_PARAMS) \
-                       iso 2>&1 | tee ${root}/build.log
+.PHONY: fuel-patches-clean
+fuel-patches-clean:
+       $(MAKE) -e -C ${F_PATCH_DIR} clean
 
+# Add copyright header to patch files if not already present
+.PHONY: patches-copyright
+patches-copyright:
+       @grep -e "Copyright (c)" -L ${A_PATCHES} | while read p_file; do \
+               ptmp=`mktemp` && \
+               cat armband-patch-copyright.template $$p_file > $$ptmp && \
+               mv $$ptmp $$p_file; \
+       done