[jboss-osgi-commits] JBoss-OSGI SVN: r87627 - projects/jboss-osgi/trunk/build/docbook/en/modules.

[jboss-osgi-commits at lists.jboss.org]

Author: thomas.diesler at jboss.com
Date: 2009-04-21 08:49:51 -0400 (Tue, 21 Apr 2009)
New Revision: 87627

Modified:
   projects/jboss-osgi/trunk/build/docbook/en/modules/ch06-provided-examples.xml
Log:
More docbook on provided examples

Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/ch06-provided-examples.xml
===================================================================
--- projects/jboss-osgi/trunk/build/docbook/en/modules/ch06-provided-examples.xml	2009-04-21 12:34:55 UTC (rev 87626)
+++ projects/jboss-osgi/trunk/build/docbook/en/modules/ch06-provided-examples.xml	2009-04-21 12:49:51 UTC (rev 87627)
@@ -5,10 +5,85 @@
 
   <title>Provided Examples</title>
   
-  <para>JBossOSGi comes with a number of examples that demonstrate supported functionality
-  and show best practices. All examples are part of the binary distribution and tightly 
-  integrated in our <ulink url="http://www.jboss.org/community/docs/DOC-13275">Maven Build Process</ulink> 
-  and <ulink url="http://www.jboss.org/community/docs/DOC-13420">Hudson QA Environment</ulink>.</para>
+  <sect1 xml:id="SecBuildAndRunExamples">  
+    <title>Build and Run the Examples</title>
+    
+    <para>JBossOSGi comes with a number of examples that demonstrate supported functionality
+    and show best practices. All examples are part of the binary distribution and tightly 
+    integrated in our <ulink url="http://www.jboss.org/community/docs/DOC-13275">Maven Build Process</ulink> 
+    and <ulink url="http://www.jboss.org/community/docs/DOC-13420">Hudson QA Environment</ulink>.</para>
+    
+    <para>The examples can be either run against a local embedded OSGi Framework or against
+    a remote OSGi Runtime instance. Here is how you build and run the against the embedded OSGi Framework.</para>
+    
+    <programlisting>
+    /home/yourname/jboss-osgi-1.0.0.Beta1/example
+    [tdiesler at tddell example]$ mvn test
+    ...
+    [INFO] ------------------------------------------------------------------------
+    [INFO] Building JBossOSGi - Testsuite Examples
+    [INFO]    task-segment: [test]
+    [INFO] ------------------------------------------------------------------------
+    ...
+    build-example-jars:
+    # example-log (example-log.jar) 2 
+    # example-http (example-http.jar) 4 
+    # example-microcontainer (example-microcontainer.jar) 4
+    ... 
+    -------------------------------------------------------
+     T E S T S
+    -------------------------------------------------------
+    Running org.jboss.test.osgi.example.log.LogServiceTestCase
+    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.876 sec
+    ...
+    [INFO] ------------------------------------------------------------------------
+    [INFO] BUILD SUCCESSFUL
+    [INFO] ------------------------------------------------------------------------
+    [INFO] Total time: 17 seconds
+    [INFO] Finished at: Tue Apr 21 14:32:31 CEST 2009
+    [INFO] Final Memory: 21M/51M
+    [INFO] ------------------------------------------------------------------------
+    </programlisting>
+    
+    <para>To run the examples against a remote OSGi Runtime, you need to provide the
+    host theat the runtime binds to. This can be done with the 
+    <emphasis role="bold">-Djboss.bind.address=localhost</emphasis> property.</para> 
+    
+    <programlisting>
+    /home/yourname/jboss-osgi-1.0.0.Beta1/example
+    [tdiesler at tddell example]$ mvn -Djboss.bind.address=localhost test
+    ...
+    [INFO] ------------------------------------------------------------------------
+    [INFO] Building JBossOSGi - Testsuite Examples
+    [INFO]    task-segment: [test]
+    [INFO] ------------------------------------------------------------------------
+    ...
+    build-example-jars:
+    # example-log (example-log.jar) 2 
+    # example-http (example-http.jar) 4 
+    # example-microcontainer (example-microcontainer.jar) 4
+    ... 
+    -------------------------------------------------------
+     T E S T S
+    -------------------------------------------------------
+    Running org.jboss.test.osgi.example.http.HttpServiceRemoteTestCase
+    Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.435 sec
+    Running org.jboss.test.osgi.example.log.LogServiceTestCase
+    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.06 sec
+    Running org.jboss.test.osgi.example.microcontainer.MBeanServiceRemoteTestCase
+    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.177 sec
+    Running org.jboss.test.osgi.example.log.LogServiceRemoteTestCase
+    Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.632 sec
+    ...
+    [INFO] ------------------------------------------------------------------------
+    [INFO] BUILD SUCCESSFUL
+    [INFO] ------------------------------------------------------------------------
+    [INFO] Total time: 29 seconds
+    [INFO] Finished at: Tue Apr 21 14:47:33 CEST 2009
+    [INFO] Final Memory: 44M/82M
+    [INFO] ------------------------------------------------------------------------
+    </programlisting>
+  </sect1>
   
   <sect1 xml:id="SecHTTPServiceExample">  
     <title>HTTP Service Example</title>