You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildr.apache.org by vb...@apache.org on 2008/03/05 20:31:09 UTC

svn commit: r633994 - in /incubator/buildr/trunk: CHANGELOG doc/pages/more_stuff.textile doc/pages/whats_new.textile lib/java/jruby.rb lib/java/nailgun.rb

Author: vborja
Date: Wed Mar  5 11:31:05 2008
New Revision: 633994

URL: http://svn.apache.org/viewvc?rev=633994&view=rev
Log:
BUILDR-50. Documentation for running with nailgun

Modified:
    incubator/buildr/trunk/CHANGELOG
    incubator/buildr/trunk/doc/pages/more_stuff.textile
    incubator/buildr/trunk/doc/pages/whats_new.textile
    incubator/buildr/trunk/lib/java/jruby.rb
    incubator/buildr/trunk/lib/java/nailgun.rb

Modified: incubator/buildr/trunk/CHANGELOG
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/CHANGELOG?rev=633994&r1=633993&r2=633994&view=diff
==============================================================================
--- incubator/buildr/trunk/CHANGELOG (original)
+++ incubator/buildr/trunk/CHANGELOG Wed Mar  5 11:31:05 2008
@@ -1,4 +1,5 @@
 1.3.0 (Pending)
+* Added: Nailgun integration for improved user experience when running on JRuby.
 * Added: Cobertura tasks can be invoked for a single project using project name as prefix to cobetura tasks.
 * Added: Cobertura can exclude specified classes from instrumentation.
 * Added: ArchiveTask#clean can be used to remove content from a package. 

Modified: incubator/buildr/trunk/doc/pages/more_stuff.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/more_stuff.textile?rev=633994&r1=633993&r2=633994&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/more_stuff.textile (original)
+++ incubator/buildr/trunk/doc/pages/more_stuff.textile Wed Mar  5 11:31:05 2008
@@ -47,6 +47,27 @@
 with a partial classpath, or before all remote repositories are listed.
 # Check on a clean build with empty local repository.
 
+h2. Nailgun
+
+"Nailgun":http://www.martiansoftware.com/nailgun/index.html is a client,
+protocol, and server for running Java programs from the command line without 
+incurring the JVM startup overhead. 
+Nailgun integration is available only when running Buildr within JRuby.
+
+Buildr provides a custom nailgun server, allowing you to start a single JVM
+and let buildr create a queue of runtimes.
+These JRuby runtimes can be cached (indexed by buildfile path) and are 
+automatically reloaded when the buildfile has been modified.
+Runtime caching allows you to execute tasks without spending time creating 
+the buildr environment. 
+
+Some nailgun tasks have been provided to manage the cached runtimes, 
+to get an overview of them execute the @ng:tasks@ task.
+
+Be sure to read the nailgun help by executing the @ng:help@ task.
+
+To start the buildr server execute the @ng:start@ task, as mentioned
+above these tasks are only available when running on JRuby.
 
 h2. Eclipse, IDEA
 

Modified: incubator/buildr/trunk/doc/pages/whats_new.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/whats_new.textile?rev=633994&r1=633993&r2=633994&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/whats_new.textile (original)
+++ incubator/buildr/trunk/doc/pages/whats_new.textile Wed Mar  5 11:31:05 2008
@@ -97,6 +97,11 @@
 
 "Read more ...":download.html#jruby
 
+Buildr provides a "Nailgun":http://www.martiansoftware.com/nailgun/index.html
+server when running on JRuby. Using the integrated BuildrServer allows for 
+faster task execution and avoid frequent JVM startup overhead. 
+
+"Read more ...":more_stuff.html#nailgun
 
 h4.  Profiles
 

Modified: incubator/buildr/trunk/lib/java/jruby.rb
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/lib/java/jruby.rb?rev=633994&r1=633993&r2=633994&view=diff
==============================================================================
--- incubator/buildr/trunk/lib/java/jruby.rb (original)
+++ incubator/buildr/trunk/lib/java/jruby.rb Wed Mar  5 11:31:05 2008
@@ -96,9 +96,11 @@
 
   end
 
-  task 'ng:start' do |t|
-    require 'java/nailgun'
-    Rake.application.invoke_task('nailgun:start')
+  [:start, :help, :tasks].each do |n|
+    task "ng:#{n}" do |t|
+      require 'java/nailgun'
+      Rake.application.invoke_task("nailgun:#{n}")
+    end
   end
   
 end

Modified: incubator/buildr/trunk/lib/java/nailgun.rb
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/lib/java/nailgun.rb?rev=633994&r1=633993&r2=633994&view=diff
==============================================================================
--- incubator/buildr/trunk/lib/java/nailgun.rb (original)
+++ incubator/buildr/trunk/lib/java/nailgun.rb Wed Mar  5 11:31:05 2008
@@ -215,7 +215,7 @@
             super
             puts 
             puts 'To get a summary of Nailgun features use'
-            puts '  help:nailgun'
+            puts '  ng:help'
           end
 
           def do_option(opt, value)
@@ -249,7 +249,7 @@
         end
         Buildr.help do 
           "\nTo get a summary of Nailgun features use" << 
-          "\n  help:nailgun"
+          "\n  ng:help"
         end
         if ctx.fresh
           run_fresh(ctx)
@@ -796,6 +796,14 @@
          and will be used by default when ``#{installed_bin.to_s.pathmap("%f")}'' is invoked from inside 
          from a directory inside #{installed_bin.to_s.pathmap("%d")}
         NOTICE
+      end
+
+      task :help do 
+        puts Rake.application.nailgun_help
+      end
+
+      task :tasks do 
+        puts Rake.application.nailgun_tasks
       end
     end # namespace :nailgun