Repository: incubator-reef Updated Branches: refs/heads/branch-0.11.0-incubating-maven d0e4a4811 -> 249880434
[REEF-338] Sync the script from source release for maven release This PR is to sync the script changes made for reef 0.11.0 source release. The following files are changed: *.gitattributes for line ending *.README.md *Run.cmd JIRA: REEF-329(https://issues.apache.org/jira/browse/REEF-338) This closes # Author: Julia Wang Email: [email protected] Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/24988043 Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/24988043 Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/24988043 Branch: refs/heads/branch-0.11.0-incubating-maven Commit: 2498804342f5c8ed7ba0030a50f7bc5aa762ea50 Parents: d0e4a48 Author: Julia Wang <[email protected]> Authored: Tue May 19 16:15:16 2015 -0700 Committer: Julia Wang <[email protected]> Committed: Tue May 19 16:15:16 2015 -0700 ---------------------------------------------------------------------- .gitattributes | 22 ++++++++ README.md | 82 ++++++++++++++++++++++------- lang/cs/Org.Apache.REEF.Client/run.cmd | 21 +++++++- 3 files changed, 106 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/24988043/.gitattributes ---------------------------------------------------------------------- diff --git a/.gitattributes b/.gitattributes index db5b15f..fa96ba0 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,25 @@ # Commit text files using LF endings *.java text eol=lf whitespace=trailing-space,space-before-tab,tab-in-indent,blank-at-eof +*.sh text eol=lf +*.js text eol=lf +site.xml text eol=lf +*.apt text eol=lf +DISCLAIMER text eol=lf +HEADER text eol=lf +LICENSE text eol=lf +NOTICE text eol=lf +*.md text eol=lf +pom.xml text eol=lf +*.h text eol=crlf +*.cpp text eol=crlf +*.rc text eol=crlf +*.vcproj text eol=crlf +*.csproj text eol=crlf +*.bat text eol=crlf +*.cs text eol=crlf +*.cmd text eol=crlf +*.ps1 text eol=crlf +*.psm1 eol=crlf +*.png binary +*.jpg binary * text=auto http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/24988043/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e4e650d..7348cda 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,77 @@ -# Apache REEF - -REEF (Retainable Evaluator Execution Framework) is a scale-out computing fabric -that makes it easier to write Big Data applications on top of resource managers -(e.g., Apache YARN and Mesos). For example, Azure Stream Analytics is built on -REEF and Hadoop. Apache REEF is currently undergoing incubation at the [Apache +Apache REEF (incubating) +======================== +Apache REEF (Retainable Evaluator Execution Framework) is a scale-out +computing fabric that simplifies the development of Big Data +applications on top of resource managers (e.g., Apache YARN and +Mesos). For example, Azure Stream Analytics is built on REEF and +Hadoop. Apache REEF is currently undergoing incubation at the [Apache Software Foundation](http://www.apache.org/). -<http://reef.incubator.apache.org/> -## Online Documentation +Online Documentation +==================== +This file will cover the very basics of compiling and testing +REEF. Much more detailed information can be found in the following +places: + + * [The project website](http://reef.incubator.apache.org/) + * [The project wiki](https://cwiki.apache.org/confluence/display/REEF/Home) -You can find the latest REEF documentation, including tutorials, on the -[project web page](http://reef.incubator.apache.org/). This README file -contains only basic setup instructions. +[The developer +mailinglist](http://reef.incubator.apache.org/mailing-list.html) is +the best way to reach REEF's developers when the above aren't +sufficient. -## Building REEF +Building REEF +============= Requirements +------------ -* Java 7 Development Kit -* [Apache Maven](http://maven.apache.org) 3 or newer. Make sure that mvn is in your PATH. -* [Protocol Buffers](https://code.google.com/p/protobuf/) Compiler (protoc) 2.5. Make sure that protoc is in your PATH. + * Java 7 Development Kit + * [Apache Maven](http://maven.apache.org) 3 or newer. Make sure that + `mvn` is in your `PATH`. + * [Protocol Buffers](https://code.google.com/p/protobuf/) Compiler + version 2.5. Make sure that `protoc` is on your `PATH`. + * For REEF.NET, you will also need [Visual Studio + 2013](http://www.visualstudio.com). Most REEF developers use the + free Community Edition -REEF is built using Apache Maven. -To build REEF and its example programs, run: +REEF Java +--------- +The Java side of REEF is built using Apache Maven. To build, execute: mvn -DskipTests clean install -More detailed documentation is available from the project site. +To test, execute: + + mvn test + +Note that the tests will take several minutes to complete. You will +also see stack traces fly by. Not to worry: Those are part of the +tests that test REEF's error reporting. + +REEF.NET +-------- +REEF.NET uses REEF Java. In fact, the instructions below build REEF +Java as part of building REEF.NET. Hence, the same requirements apply. + +To build and test in Visual Studio, open +`lang\cs\Org.Apache.REEF.sln`. + +Alternatively, you can build REEF.NET from a developer command line +via: + + msbuild .\lang\cs\Org.Apache.REEF.sln + +To test, execute the following command thereafter: + + vstest.console.exe .\lang\cs\bin\x64\Debug\Org.Apache.REEF.Tests\Org.Apache.REEF.Tests.dll /Platform:x64 +Additional Information +---------------------- +More detailed documentation, including building from PowerShell and +creating NuGets is available from the [project +wiki](https://cwiki.apache.org/confluence/display/REEF/Home), +specifcially the [building +instructions](https://cwiki.apache.org/confluence/display/REEF/Compiling+REEF). http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/24988043/lang/cs/Org.Apache.REEF.Client/run.cmd ---------------------------------------------------------------------- diff --git a/lang/cs/Org.Apache.REEF.Client/run.cmd b/lang/cs/Org.Apache.REEF.Client/run.cmd index 3b4ba38..fdf83fe 100644 --- a/lang/cs/Org.Apache.REEF.Client/run.cmd +++ b/lang/cs/Org.Apache.REEF.Client/run.cmd @@ -1,3 +1,22 @@ +@REM +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM + @echo off :: :: Licensed to the Apache Software Foundation (ASF) under one @@ -19,7 +38,7 @@ :: :: RUNTIME -set SHADED_JAR=.\reef-bridge-java-0.11.0-incubating-SNAPSHOT-shaded.jar +set SHADED_JAR=.\reef-bridge-java-0.11.0-incubating-snapshot-shaded.jar set LOGGING_CONFIG=-Djava.util.logging.config.class=org.apache.reef.util.logging.CLRLoggingConfig
