You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sqoop.apache.org by ab...@apache.org on 2013/03/11 04:13:24 UTC
git commit: Sqoop2: Devguide: Building and setting up developer
environment.
Updated Branches:
refs/heads/sqoop2 273b5bc56 -> abd2c5258
Sqoop2: Devguide: Building and setting up developer environment.
(Jarek Jarcec Cecho via Abhijeet Gaikwad)
Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/abd2c525
Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/abd2c525
Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/abd2c525
Branch: refs/heads/sqoop2
Commit: abd2c52581272095c5a3b10446f74c5dc1a7f060
Parents: 273b5bc
Author: Abhijeet Gaikwad <ab...@apache.org>
Authored: Mon Mar 11 08:41:13 2013 +0530
Committer: Abhijeet Gaikwad <ab...@apache.org>
Committed: Mon Mar 11 08:41:13 2013 +0530
----------------------------------------------------------------------
docs/src/site/sphinx/BuildingSqoop2.rst | 69 ++++++++++++++++++++++++++
docs/src/site/sphinx/index.rst | 9 +++-
2 files changed, 76 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sqoop/blob/abd2c525/docs/src/site/sphinx/BuildingSqoop2.rst
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/BuildingSqoop2.rst b/docs/src/site/sphinx/BuildingSqoop2.rst
new file mode 100644
index 0000000..ad07d46
--- /dev/null
+++ b/docs/src/site/sphinx/BuildingSqoop2.rst
@@ -0,0 +1,69 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+
+================================
+Building Sqoop2 from source code
+================================
+
+This guide will show you how to build Sqoop2 from source code. Sqoop is using `maven <http://maven.apache.org/>`_ as build system. You you will need to use at least version 3.0 as older versions will not work correctly. All other dependencies will be downloaded by maven automatically. With exception of special JDBC drivers that are needed only for advanced integration tests.
+
+Downloading source code
+-----------------------
+
+Sqoop project is using git as a revision control system hosted at Apache Software Foundation. You can clone entire repository using following command:
+
+::
+
+ git clone https://git-wip-us.apache.org/repos/asf/sqoop.git sqoop2
+
+Sqoop2 is currently developed in special branch ``sqoop2`` that you need to check out after clone:
+
+::
+
+ cd sqoop2
+ git checkout sqoop2
+
+Building project
+----------------
+
+You can use usual maven targets like ``compile`` or ``package`` to build the project. Sqoop supports two major Hadoop revisions at the moment - 1.x and 2.x. As compiled code for one Hadoop major version can't be used on another, you must compile Sqoop against appropriate Hadoop version. You can change the target Hadoop version by specifying ``-Dhadoop.profile=$hadoopVersion`` on the maven command line. Possible values of ``$hadoopVersions`` are 100 and 200 for Hadoop version 1.x and 2.x respectively. Sqoop will compile against Hadoop 2 by default. Following example will compile Sqoop against Hadoop 1.x:
+
+::
+
+ mvn compile -Dhadoop.profile=100
+
+Maven target ``package`` can be used to create Sqoop packages similar to the ones that are officially available for download. Sqoop will build only source tarball by default. You need to specify ``-Pbinary`` to build binary distribution. You might need to explicitly specify Hadoop version if the default is not accurate.
+
+::
+
+ mvn package -Pbinary
+
+Running tests
+-------------
+
+Sqoop supports two different sets of tests. First smaller and much faster set is called unit tests and will be executed on maven target ``test``. Second larger set of integration tests will be executed on maven target ``integration-test``. Please note that integration tests might require manual steps for installing various JDBC drivers into your local maven cache.
+
+Example for running unit tests:
+
+::
+
+ mvn test
+
+Example for running integration tests:
+
+::
+
+ mvn integration-test
http://git-wip-us.apache.org/repos/asf/sqoop/blob/abd2c525/docs/src/site/sphinx/index.rst
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/index.rst b/docs/src/site/sphinx/index.rst
index b133161..02dce33 100644
--- a/docs/src/site/sphinx/index.rst
+++ b/docs/src/site/sphinx/index.rst
@@ -48,9 +48,14 @@ Overview
- `Sqoop Issue Tracking (JIRA) <https://issues.apache.org/jira/browse/SQOOP>`_
- `Sqoop Source Code <https://git-wip-us.apache.org/repos/asf?p=sqoop.git;a=summary>`_
-Documentation
--------------
+User Documentation
+------------------
- `Installation <Installation.html>`_
- `5 Minutes Demo <Sqoop5MinutesDemo.html>`_
- `Command Line Client <CommandLineClient.html>`_
+
+Developer Guide
+---------------
+
+- `Building Sqoop2 <BuildingSqoop2.html>`_