You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2017/10/14 23:30:59 UTC
[4/8] flink git commit: [hotfix] [docs] Minor improvements to the
'building form source' guide.
[hotfix] [docs] Minor improvements to the 'building form source' guide.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/769b40cd
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/769b40cd
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/769b40cd
Branch: refs/heads/master
Commit: 769b40cd7f3875e36a16d2b75f6efc65a3998f1b
Parents: 1e03c6c
Author: Stephan Ewen <se...@apache.org>
Authored: Sat Oct 14 18:45:16 2017 +0200
Committer: Stephan Ewen <se...@apache.org>
Committed: Sat Oct 14 18:48:08 2017 +0200
----------------------------------------------------------------------
docs/start/building.md | 24 ++++++++++--------------
1 file changed, 10 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/769b40cd/docs/start/building.md
----------------------------------------------------------------------
diff --git a/docs/start/building.md b/docs/start/building.md
index 1478dfd..455ebbfe 100644
--- a/docs/start/building.md
+++ b/docs/start/building.md
@@ -48,13 +48,15 @@ The simplest way of building Flink is by running:
mvn clean install -DskipTests
~~~
-This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`). The `-DskipTests` command prevents Maven from executing the tests.
+This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
-The default build includes the YARN Client for Hadoop 2.
+To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
+
+The default build adds a Flink-specific JAR for Hadoop 2, to allow using Flink with HDFS and YARN.
## 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.
+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*, *Netty*, and others.
The dependency shading mechanism was recently changed in Maven and requires users to build Flink slightly differently, depending on their Maven version:
@@ -80,23 +82,13 @@ mvn clean install
Flink has dependencies to HDFS and YARN which are both dependencies from [Apache Hadoop](http://hadoop.apache.org). There exist many different versions of Hadoop (from both the upstream project and the different Hadoop distributions). If you are using a wrong combination of versions, exceptions can occur.
-Hadoop is only supported from version 2.3.0 upwards.
+Hadoop is only supported from version 2.4.0 upwards.
You can also specify a specific Hadoop version to build against:
~~~bash
mvn clean install -DskipTests -Dhadoop.version=2.6.1
~~~
-#### Before Hadoop 2.3.0
-
-Hadoop 2.x versions are only supported with YARN features from version 2.3.0 upwards. If you want to use a version lower than 2.3.0, you can exclude the YARN support using the following extra build arguments: `-P!include-yarn`.
-
-For example, if you want to build Flink for Hadoop `2.2.0`, use the following command:
-
-~~~bash
-mvn clean install -Dhadoop.version=2.2.0 -P!include-yarn
-~~~
-
### Vendor-specific Versions
To build Flink against a vendor specific Hadoop version, issue the following command:
@@ -115,6 +107,10 @@ The `-Pvendor-repos` activates a Maven [build profile](http://maven.apache.org/g
Flink has APIs, libraries, and runtime modules written in [Scala](http://scala-lang.org). Users of the Scala API and libraries may have to match the Scala version of Flink with the Scala version of their projects (because Scala is not strictly backwards compatible).
+Flink 1.4 currently builds only with Scala version 2.11.
+
+We are working on supporting Scala 2.12, but certain breaking changes in Scala 2.12 make this a more involved effort. Please check out (this JIRA issue)[https://issues.apache.org/jira/browse/FLINK-7811] for updates.
+
{% top %}
## Encrypted File Systems