Robotics Service Bus

From 7576363a6426665f0f137b76cd9f8cbf32a355ea Mon Sep 17 00:00:00 2001

From: Jan Moringen <jmoringe@techfak.uni-bielefeld.de>

Date: Wed, 15 Jan 2014 20:37:10 +0100

Subject: [PATCH 1/2] Post-release adjustments in index.rst

refs #1688

* index.rst: updated suggestion to use stable version

---

 index.rst |    2 +-

 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/index.rst b/index.rst

index 1d6c32f..048600b 100644

--- a/index.rst

+++ b/index.rst

@@ -19,7 +19,7 @@ systems in diverse environments.

    When possible, the most recent stable version of |project| should

    be used instead. That version is described in a `separate manual

-   <../../0.9/html/index.html>`_.

+   <../../0.10/html/index.html>`_.

 .. toctree::

    :hidden:

-- 

1.7.9.5

From d3b4110521ef4c298c9f0a7e77c5b98d4a4fef75 Mon Sep 17 00:00:00 2001

From: suchit sharma <ssharma@TechFak.Uni-Bielefeld.DE>

Date: Wed, 29 Jan 2014 20:50:45 +0100

Subject: [PATCH 1/4] updated for maven installation steps

---

 install-java.rst |  155 ++++++++++++++++++++++++++++++++++++++++++++++++++++--

 1 file changed, 152 insertions(+), 3 deletions(-)

diff --git a/install-java.rst b/install-java.rst

index 9a4ef72..cc4ed48 100644

--- a/install-java.rst

+++ b/install-java.rst

@@ -21,7 +21,7 @@ Required Dependencies

   * |ubuntu| packages (``libprotobuf-java``,

     ``protobuf-compiler``) are OK

-* `Apache Ant`_

+* `Apache Ant`_ / ´Maven`_

 * :term:`Spread daemon`

@@ -125,6 +125,11 @@ Installation of RSC and RSBProtocol

 Installation of RSBJava

 =======================

+* Installation of |project| Java with `Apache Ant`_.

+* Installation of |project| Java with ´Maven`_

+

+Installation with Apache Ant

+-----------------------------

 #. Checkout |project| and its immediate dependencies from

    |repository_versioned_java|.

@@ -182,8 +187,8 @@ Installation of RSBJava

       $ ant install

-Testing the Installation

-========================

+Testing the Ant Installation

+-----------------------------

 The Java implementation of |project| comes with a set of unit tests,

 which you may use to check the compiled code. Executing the test suite

@@ -249,3 +254,147 @@ excerpt):

 If no failed test cases are reported, the Java implementation of

 |project| is likely to work correctly on your machine.

+

+Installation with Maven

+------------------------

+

+#. Checkout |project| and its immediate dependencies from

+   |repository_versioned_java|.

+

+#. Run :file:`mvnprep.sh` in rsb.git.java folder from commandline:

+

+.. code-block:: sh

+

+   $ cd rsb.git.java

+   

+   $ ./mvnprep.sh

+   

+#. Invoke :program:`mvn` supplying build properties on the commandline

+   or via file:`pom.xml` (see below)

+

+   The following properties are used to configure the build:

+

+   ==================  =================================================================================  ====================================

+   Maven Property        Meaning                                                                            Example

+   ==================  =================================================================================  ====================================

+   ``pbuf.protoc``     Location of protocol buffer compiler (:program:`protoc` or :program:`protoc.exe`)  :file:`/usr/bin/protoc`

+   ``pbuf.protopath``  Location of |project| protocol IDL files (see TODO)                                :file:`/vol/cit/share/rsbprotocol`

+   ``spread.daemon``   Location of :term:`Spread daemon` executable                                       :file:`/vol/cit/sbin/spread`

+   ==================  =================================================================================  ====================================

+

+   All properties can be supplied on the :program:`mvn` commandline

+   using the :samp:`-D{NAME}={VALUE}` syntax or by editing a

+   :file:`pom.xml` file containing lines of the form

+   :samp:`<NAME>{VALUE}</NAME>`.

+

+   An exemplary ``mvn clean package`` command, which builds the |project| jar

+   library, may look as follows:

+

+   .. code-block:: sh

+

+      $ mvn clean package 				\

+	    -Dpbuf.protoc=/usr/bin/protoc               \

+            -Dpbuf.protopath=/vol/cit/share/rsbprotocol \

+            -Dspread.daemon=/vol/cit/sbin/spread        

+

+   The equivalent :file:`pom.xml` file looks like this:

+

+   .. code-block:: ini

+

+      <properties>

+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

+        <pbuf.protopath>/vol/cit/share/rsbprotocol</pbuf.protopath>

+        <pbuf.protoc>/usr/bin/protoc</pbuf.protoc>

+        <pbuf.version>2.4.1</pbuf.version>

+        <pbuf.outpath>target/generated-protocol</pbuf.outpath>

+        <spread.daemon>/vol/cit/sbin/spread</spread.daemon>

+        <target.java.version>1.6</target.java.version>

+     </properties>

+

+

+   In the presence of this file, the :program:`mvn` command reduces to

+   ``maven clean package``.

+

+#. Installation of Java archive

+

+   To install |project| jars into the configured prefix (e.g., into

+   :samp:`{PREFIX}/share/java`), the following :program:`mvn` command

+   can be used :file:`pom.xml` is not configured as mentioned earlier:

+

+   .. code-block:: sh

+

+      $ mvn clean install			        \

+	    -Dpbuf.protoc=/usr/bin/protoc               \

+            -Dpbuf.protopath=/vol/cit/share/rsbprotocol \

+            -Dspread.daemon=/vol/cit/sbin/spread 

+           

+   or when :file:`pom.xml` is configured :

+   

+   .. code-block:: sh

+

+      $ mvn clean install			           

+      

+Testing the Maven Installation

+-------------------------------

+

+The Java implementation of |project| comes with a set of unit tests,

+which you may use to check the compiled code. Executing the test suite

+is straightforward.  To do so, the following :program:`mvn` target

+needs to be invoked (please note that a :term:`Spread daemon` is

+automatically started by the :program:`mvn` script):

+

+When :file:`pom.xml` is configured : 

+

+.. code-block:: sh

+

+   $ mvn clean test

+

+or when :file:`pom.xml` is not configured :

+

+.. code-block:: sh

+

+   $ mvn clean	test				       \

+	 -Dpbuf.protoc=/opt/local/bin/protoc           \

+         -Dpbuf.protopath=/vol/cit/share/RSBProtocol   \

+         -Dspread.daemon=/vol/cit/sbin/spread          

+         

+

+You should see a console output similar to the following (shortened

+excerpt):

+

+.. code-block:: sh

+

+   $ mvn -Dpbuf.protoc=/opt/local/bin/protoc           \

+         -Dpbuf.protopath=/vol/cit/share/RSBProtocol   \

+         -Dspread.daemon=/vol/cit/sbin/spread          \

+         test

+   [INFO] Scanning for projects...

+   [INFO]                                                                         

+   [INFO] ------------------------------------------------------------------------

+   [INFO] Building RSB 0.11-SNAPSHOT

+   [INFO] ------------------------------------------------------------------------

+   [INFO] 

+   .

+   ..

+   ...

+   

+   

+   Results :

+   

+   Tests run: 175, Failures: 0, Errors: 0, Skipped: 0

+   

+   [INFO] 

+   [INFO] --- jacoco-maven-plugin:0.6.3.201306030806:report (post-unit-test) @ rsb ---

+   [INFO] ------------------------------------------------------------------------

+   [INFO] BUILD SUCCESS

+   [INFO] ------------------------------------------------------------------------

+   [INFO] Total time: 27.010s

+   [INFO] Finished at: Wed Jan 29 19:59:08 CET 2014

+   [INFO] Final Memory: 25M/193M

+   [INFO] ------------------------------------------------------------------------

+        [exec] Result: 143

+         

+

+         

+If no failed test cases are reported, the Java implementation of

+|project| is likely to work correctly on your machine.

-- 

1.7.9.5

From b91bd8f82ea23d57660479350a401c5774e08209 Mon Sep 17 00:00:00 2001

From: Jan Moringen <jmoringe@techfak.uni-bielefeld.de>

Date: Sun, 26 Jan 2014 22:19:32 +0100

Subject: [PATCH 2/2] Updated dependencies in install-cl.rst

* install-cl.rst (External Dependencies): updated dependency list

---

 install-cl.rst |   56 +++++++++++++++++++++++++++-----------------------------

 1 file changed, 27 insertions(+), 29 deletions(-)

diff --git a/install-cl.rst b/install-cl.rst

index 48aa298..22ecbce 100644

--- a/install-cl.rst

+++ b/install-cl.rst

@@ -22,28 +22,32 @@ Required Infrastructure

 External Dependencies

 ---------------------

-==================== ========================= ===============

-System               Required                  Obtainable From

-==================== ========================= ===============

-alexandria           yes                       Quicklisp

-split-sequence       yes                       Quicklisp

-iterate              yes                       Quicklisp

-metabang-bind        yes                       Quicklisp

-bordeaux-threads     yes                       Quicklisp

-closer-mop           yes                       Quicklisp

-log5                 yes                       Quicklisp

-puri                 yes                       Quicklisp

-uuid                 yes                       Quicklisp

-local-time           yes                       Quicklisp

-cl-hooks             yes                       https://launchpad.net/cl-hooks

-cl-dynamic-classes   yes                       |repository_versioned_cl| at ``cl-dynamic-classes``

-cl-ppcre             for Regexp filtering      Quicklisp

-cxml-stp             for XML event data        Quicklisp

-xpath                for XPath event filtering Quicklisp

-cl-protobuf          for Spread transport      |repository_versioned_cl| at ``cl-protobuf``

-cl-spread            for Spread transport      |repository_versioned_cl| at ``cl-spread``

--- libspread         for Spread transport      See :ref:`C++ installation instructions <install-cpp>`

-==================== ========================= ===============

+==================== ==================================== ======================================================

+System               Required?                            Obtainable From

+==================== ==================================== ======================================================

+alexandria           yes                                  Quicklisp

+split-sequence       yes                                  Quicklisp

+iterate              yes                                  Quicklisp

+let-plus             yes                                  Quicklisp

+more-conditions      yes                                  Quicklisp

+bordeaux-threads     yes                                  Quicklisp

+lparallel            yes                                  Quicklisp

+trivial-garbage      yes                                  Quicklisp

+closer-mop           yes                                  Quicklisp

+cl-hooks             yes                                  Quicklisp

+cl-dynamic-classes   yes                                  -

+log4cl               yes                                  Quicklisp

+nibbles              yes                                  Quicklisp

+puri                 yes                                  Quicklisp

+uuid                 yes                                  Quicklisp

+local-time           yes                                  Quicklisp

+cl-ppcre             for Regexp filtering                 Quicklisp

+cxml-stp             for XML :term:`payload`              Quicklisp

+xpath                for XPath filtering                  Quicklisp

+cl-protobuf          for :term:`Spread` :term:`transport` -

+network.spread       for :term:`Spread` :term:`transport` http://github.com/scymtym/network.spread

+-- libspread         for :term:`Spread` :term:`transport` See :ref:`C++ installation instructions <install-cpp>`

+==================== ==================================== ======================================================

 Installation

 ============

@@ -53,15 +57,9 @@ Installation

 #. Install other required systems:

-   * ``cl-hooks``

-

-     .. code-block:: sh

-

-        bzr branch lp:cl-hooks

-

    * ``cl-dynamic-classes``

    * ``cl-protobuf``

-   * ``cl-spread``

+   * ``network.spread``

 #. Load ``cl-rsb`` with `Quicklisp`_ to pull in remaining dependencies

-- 

1.7.9.5

From 6e2859e89752ea1b81f169728cfa1d9ed1fdcc1f Mon Sep 17 00:00:00 2001

From: suchit sharma <ssharma@TechFak.Uni-Bielefeld.DE>

Date: Thu, 30 Jan 2014 19:10:04 +0100

Subject: [PATCH 2/4] updates for maven installation

---

 conf.py.in       |    2 ++

 install-java.rst |   26 +++++++++++++++-----------

 2 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/conf.py.in b/conf.py.in

index 6e47574..37f9bcb 100644

--- a/conf.py.in

+++ b/conf.py.in

@@ -134,6 +134,8 @@ rst_prolog = """

 .. _boost: http://www.boost.org/

 .. _boost.uuid: http://www.boost.org/doc/libs/1_42_0/libs/uuid/uuid.html

+.. _Maven: http://maven.apache.org/

+

 .. _apache ant: http://ant.apache.org/

 .. _javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

diff --git a/install-java.rst b/install-java.rst

index cc4ed48..6ae503e 100644

--- a/install-java.rst

+++ b/install-java.rst

@@ -21,7 +21,7 @@ Required Dependencies

   * |ubuntu| packages (``libprotobuf-java``,

     ``protobuf-compiler``) are OK

-* `Apache Ant`_ / ´Maven`_

+* `Apache Ant`_ / `Maven`_

 * :term:`Spread daemon`

@@ -126,7 +126,7 @@ Installation of RSC and RSBProtocol

 Installation of RSBJava

 =======================

 * Installation of |project| Java with `Apache Ant`_.

-* Installation of |project| Java with ´Maven`_

+* Installation of |project| Java with `Maven`_

 Installation with Apache Ant

 -----------------------------

@@ -261,12 +261,11 @@ Installation with Maven

 #. Checkout |project| and its immediate dependencies from

    |repository_versioned_java|.

-#. Run :file:`mvnprep.sh` in rsb.git.java folder from commandline:

+#. Run :file:`mvnprep.sh` in :file:`rsb.git.java` folder from commandline:

 .. code-block:: sh

    $ cd rsb.git.java

-   

    $ ./mvnprep.sh

 #. Invoke :program:`mvn` supplying build properties on the commandline

@@ -297,9 +296,9 @@ Installation with Maven

             -Dpbuf.protopath=/vol/cit/share/rsbprotocol \

             -Dspread.daemon=/vol/cit/sbin/spread        

-   The equivalent :file:`pom.xml` file looks like this:

+   The equivalent changes can be done in :file:`pom.xml` file which then looks like this:

-   .. code-block:: ini

+   .. code-block:: xml

       <properties>

         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

@@ -312,8 +311,12 @@ Installation with Maven

      </properties>

-   In the presence of this file, the :program:`mvn` command reduces to

-   ``maven clean package``.

+   In the presence of this file :file:`pom.xml` , the :program:`mvn` command reduces to:

+   

+    .. code-block:: sh

+

+      $ mvn clean package 				

+

 #. Installation of Java archive

@@ -364,10 +367,11 @@ excerpt):

 .. code-block:: sh

-   $ mvn -Dpbuf.protoc=/opt/local/bin/protoc           \

+   $ mvn clean	test				       \

+	 -Dpbuf.protoc=/opt/local/bin/protoc           \

          -Dpbuf.protopath=/vol/cit/share/RSBProtocol   \

-         -Dspread.daemon=/vol/cit/sbin/spread          \

-         test

+         -Dspread.daemon=/vol/cit/sbin/spread          

+         

    [INFO] Scanning for projects...

    [INFO]                                                                         

    [INFO] ------------------------------------------------------------------------

-- 

1.7.9.5

From 2330c1404a87295ec1b33bdaf0a95ac923cadf6d Mon Sep 17 00:00:00 2001

From: suchit sharma <ssharma@TechFak.Uni-Bielefeld.DE>

Date: Wed, 5 Feb 2014 18:34:22 +0100

Subject: [PATCH 3/4] added steps for installation with maven

---

 install-binary.rst |   28 +++++++++++++++++++++++++++-

 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/install-binary.rst b/install-binary.rst

index 4b4774a..c7cbedf 100644

--- a/install-binary.rst

+++ b/install-binary.rst

@@ -235,7 +235,33 @@ it. These files have to be placed on the Java classpath. Afterwards,

 the Java implementation of |project| should be usable in any Java

 program.

-.. _install-binary-download:

+Installation with Maven

+------------------------

+

+#. Download |project| from `here

+   <https://ci.cor-lab.de/job/rsb-java-trunk/lastSuccessfulBuild/artifact/rsb-java.zip>`_

+

+#. Provide path for jars to maven

+

+   .. code-block:: sh

+

+     $ mvn install:install-file -DgroupId=rsb -DartifactId=rsb -Dversion=0.11.0 -Dpackaging=jar -Dfile=/usr/share/java/rsb-0.11.0.jar

+     $ mvn install:install-file -DgroupId=rsb -DartifactId=protobuf -Dversion=2.4.1 -Dpackaging=jar -Dfile=/usr/share/java/protobuf-java-2.4.1.jar

+

+#. To compile the code with dependency use :

+

+   .. code-block:: sh

+

+     $ mvn clean dependency:copy-dependencies package

+

+#. To run the jar:

+

+   .. code-block:: sh

+

+     $ java -cp target/my-app-1.0-SNAPSHOT-jar-with-dependencies.jar com.mycompany.app.App

+   

+

+ .. _install-binary-download:

 Binary Downloads of Tools

 =========================

-- 

1.7.9.5

From 51a5459ff30a8e35ed7047855e5d485a01991fe5 Mon Sep 17 00:00:00 2001

From: suchit sharma <ssharma@TechFak.Uni-Bielefeld.DE>

Date: Wed, 5 Feb 2014 19:29:04 +0100

Subject: [PATCH 4/4] updated for entries in pom.xml

Please enter the commit message for your changes. Lines starting

---

 install-binary.rst |   20 +++++++++++++++++++-

 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/install-binary.rst b/install-binary.rst

index c7cbedf..3e96cbf 100644

--- a/install-binary.rst

+++ b/install-binary.rst

@@ -248,6 +248,24 @@ Installation with Maven

      $ mvn install:install-file -DgroupId=rsb -DartifactId=rsb -Dversion=0.11.0 -Dpackaging=jar -Dfile=/usr/share/java/rsb-0.11.0.jar

      $ mvn install:install-file -DgroupId=rsb -DartifactId=protobuf -Dversion=2.4.1 -Dpackaging=jar -Dfile=/usr/share/java/protobuf-java-2.4.1.jar

+#. The following changes need to be done in :file:`pom.xml` file which then looks like this:

+

+   .. code-block:: xml

+

+      <dependency>

+        <groupId>rsb</groupId>

+        <artifactId>rsb</artifactId>

+        <version>0.11.0</version>

+        <scope>compile</scope>

+      </dependency>

+      <dependency>

+        <groupId>rsb</groupId>

+        <artifactId>protobuf</artifactId>

+        <version>2.4.1</version>

+        <scope>compile</scope>

+    </dependency>

+     

+     

 #. To compile the code with dependency use :

    .. code-block:: sh

@@ -258,7 +276,7 @@ Installation with Maven

    .. code-block:: sh

-     $ java -cp target/my-app-1.0-SNAPSHOT-jar-with-dependencies.jar com.mycompany.app.App

+     $ java -cp target/my-app-1.0-SNAPSHOT-jar.jar com.mycompany.app.App

  .. _install-binary-download:

-- 

1.7.9.5

#. The following changes need to be done in :file:`pom.xml` 

   Add dependency for rsb jar:

   .. code-block:: xml

      <dependencies>

	<dependency>

	<groupId>rsb</groupId>

	<artifactId>rsb</artifactId>

	<version>0.11-SNAPSHOT</version>

	</dependency>

      </dependencies>

   Add repository information for downloading rsb jar:

      <repositories>

	<repository>

	<id>citec</id>

	<name>CITEC Maven Repository Server</name>

	<url>http://repo.cit-ec.uni-bielefeld.de/</url>

	<layout>default</layout>

	<releases>

	<enabled>true</enabled>

	</releases>

	<snapshots>

	<enabled>true</enabled>

	</snapshots>

	</repository>

      </repositories>