You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by hu...@apache.org on 2013/01/14 17:15:58 UTC
[20/50] git commit: Added Marvin building docs in developer guide
Added Marvin building docs in developer guide
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/5f19c45e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/5f19c45e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/5f19c45e
Branch: refs/heads/cloud-agent-with-openvswitch
Commit: 5f19c45e0401bd380e15af26d5c9d1e03d77795d
Parents: 86a77e2
Author: Sebastien Goasguen <ru...@gmail.com>
Authored: Fri Jan 11 10:55:37 2013 +0100
Committer: Sebastien Goasguen <ru...@gmail.com>
Committed: Fri Jan 11 10:55:37 2013 +0100
----------------------------------------------------------------------
docs/en-US/building-marvin.xml | 46 +++++++++++++++++++++++++++++++++++
docs/en-US/marvin.xml | 1 +
2 files changed, 47 insertions(+), 0 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/5f19c45e/docs/en-US/building-marvin.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/building-marvin.xml b/docs/en-US/building-marvin.xml
new file mode 100644
index 0000000..3dac9d6
--- /dev/null
+++ b/docs/en-US/building-marvin.xml
@@ -0,0 +1,46 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="building-marvin">
+ <title>Building and Installing Marvin</title>
+ <para>Marvin is built with Maven and is dependent on APIdoc. To build it do the following in the root tree of &PRODUCT;:</para>
+ <programlisting>mvn -P developer -l :cloud-apidoc</programlisting>
+ <programlisting>mvn -P developer -l :cloud-marvin</programlisting>
+ <para>If successfull the build will have created the cloudstackAPI Python package under tools/marvin/marvin/cloudstackAPI as well as a gziped Marvin package under tools/marvin dist. To install the Python Marvin module do the following in tools/marvin:</para>
+ <programlisting>sudo python ./setup.py install</programlisting>
+ <para>The dependencies will be downloaded the Python module installed and you should be able to use Marvin in Python. Check that you can import the module before starting to use it.</para>
+ <programlisting>$ python
+Python 2.7.3 (default, Nov 17 2012, 19:54:34)
+[GCC 4.2.1 Compatible Apple Clang 4.1 ((tags/Apple/clang-421.11.66))] on darwin
+Type "help", "copyright", "credits" or "license" for more information.
+>>> import marvin
+>>> from marvin.cloudstackAPI import *
+>>> </programlisting>
+
+ <para>You could also install it using <emphasis>pip</emphasis> or <emphasis>easy_install</emphasis> using the local distribution package in tools/marvin/dist :</para>
+ <programlisting>pip install tools/marvin/dist/Marvin-0.1.0.tar.gz</programlisting>
+ <para>Or:</para>
+ <programlisting>easy_install tools/marvin/dist/Marvin-0.1.0.tar.gz</programlisting>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/5f19c45e/docs/en-US/marvin.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/marvin.xml b/docs/en-US/marvin.xml
index 062616a..8fd2c96 100644
--- a/docs/en-US/marvin.xml
+++ b/docs/en-US/marvin.xml
@@ -29,4 +29,5 @@
<para>Marvin's complete documenation is on the wiki at <ulink url="https://cwiki.apache.org/CLOUDSTACK/testing-with-python.html">https://cwiki.apache.org/CLOUDSTACK/testing-with-python.html</ulink></para>
<para>The source code is located at <emphasis>tools/marvin</emphasis></para>
</note>
+ <xi:include href="building-marvin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>