flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject flink git commit: [FLINK-5123] [docs] Add description how to build a properly shaded build with different Maven versions
Date Tue, 22 Nov 2016 11:58:03 GMT
Repository: flink
Updated Branches:
  refs/heads/release-1.1 cf4b22127 -> a79290c28


[FLINK-5123] [docs] Add description how to build a properly shaded build with different Maven
versions


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/a79290c2
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/a79290c2
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/a79290c2

Branch: refs/heads/release-1.1
Commit: a79290c28aed1d39588524cf873957c141c67a21
Parents: cf4b221
Author: Stephan Ewen <sewen@apache.org>
Authored: Tue Nov 22 12:54:17 2016 +0100
Committer: Stephan Ewen <sewen@apache.org>
Committed: Tue Nov 22 12:56:22 2016 +0100

----------------------------------------------------------------------
 docs/setup/building.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/a79290c2/docs/setup/building.md
----------------------------------------------------------------------
diff --git a/docs/setup/building.md b/docs/setup/building.md
index 1848466..c36585c 100644
--- a/docs/setup/building.md
+++ b/docs/setup/building.md
@@ -53,6 +53,26 @@ This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove
all exis
 
 The default build includes the YARN Client for Hadoop 2.
 
+## Dependency Shading
+
+Flink [shades away](https://maven.apache.org/plugins/maven-shade-plugin/) some of the libraries
it uses, in order to avoid version clashes with user programs that use different versions
of these libraries. Among the shaded libraries are *Google Guava*, *Asm*, *Apache Curator*,
*Apache HTTP Components*, and others.
+
+The dependency shading mechanism was recently changed in Maven and requires users to build
Flink slightly differently, depending on their Maven version:
+
+**Maven 3.0.x, 3.1.x, and 3.2.x**
+It is sufficient to call `mvn clean install -DskipTests` in the root directory of Flink code
base.
+
+**Maven 3.3.x**
+The build has to be done in two steps: First in the base directory, then in the distribution
project:
+
+~~~bash
+mvn clean install -DskipTests
+cd flink-dist
+mvn clean install
+~~~
+
+*Note:* To check your Maven version, run `mvn --version`.
+
 {% top %}
 
 ## Hadoop Versions


Mime
View raw message