Author: vborja
Date: Thu Mar 6 07:34:14 2008
New Revision: 634308
URL: http://svn.apache.org/viewvc?rev=634308&view=rev
Log:
Nailgun documentation fixes
Modified:
incubator/buildr/trunk/doc/pages/more_stuff.textile
incubator/buildr/trunk/lib/java/nailgun.rb
Modified: incubator/buildr/trunk/doc/pages/more_stuff.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/more_stuff.textile?rev=634308&r1=634307&r2=634308&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/more_stuff.textile (original)
+++ incubator/buildr/trunk/doc/pages/more_stuff.textile Thu Mar 6 07:34:14 2008
@@ -61,13 +61,31 @@
Runtime caching allows you to execute tasks without spending time creating
the buildr environment.
+Start the BuildrServer by executing @ng:start@ task.
+server output will display a message when it becomes ready, you
+will also see messages when the JRuby runtimes are being created,
+or when a new buildr environment is being loaded on them.
+After the runtime queues have been populated, you can start calling
+buildr as you normally do, by invoking the $NAILGUN_HOME/ng binary:
+
+{{{!sh
+# on another terminal, change directory to a project.
+# if this project is the same ng:start was invoked on, it's
+# runtime has been cached, so no loading is performed unless
+# the buildfile has been modified. otherwise the buildfile
+# will be loaded on a previously loaded fresh-buildr runtime
+# and it will be cached.
+cd /some/buildr/project
+ng ng:help # display nailgun help
+ng ng:tasks # display overview of ng tasks
+ng clean compile # just invoke those two tasks
+}}}
+
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/lib/java/nailgun.rb
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/lib/java/nailgun.rb?rev=634308&r1=634307&r2=634308&view=diff
==============================================================================
--- incubator/buildr/trunk/lib/java/nailgun.rb (original)
+++ incubator/buildr/trunk/lib/java/nailgun.rb Thu Mar 6 07:34:14 2008
@@ -72,9 +72,28 @@
spending time creating the buildr environment. Some nailgun
tasks have been provided to manage the cached runtimes.
- To start the buildr server execute the ng:start task.
+ To start the buildr server execute the following task:
- Configuration and Environment Variables.
+ ng:start
+
+ Server output will display a message when it becomes ready, you
+ will also see messages when the JRuby runtimes are being created,
+ or when a new buildr environment is being loaded on them.
+ After the runtime queues have been populated, you can start calling
+ buildr as you normally do, by invoking the $NAILGUN_HOME/ng binary:
+
+ # on another terminal, change directory to a project.
+ # if this project is the same ng:start was invoked on, it's
+ # runtime has been cached, so no loading is performed unless
+ # the buildfile has been modified. otherwise the buildfile
+ # will be loaded on a previously loaded fresh-buildr runtime
+ # and it will be cached.
+ cd /some/buildr/project
+ ng ng:help # display nailgun help
+ ng ng:tasks # display overview of ng tasks
+ ng clean compile # just invoke those two tasks
+
+ Configuration and Environment Variables.
Before starting the server, buildr will check if you have
nailgun already installed by seeking the nailgun jar under
@@ -103,7 +122,7 @@
Buildr::Nailgun.server = '127.0.0.1'
Buildr::Nailgun.port = 2233
- Once started, if you provided custom host/port settings you need
+ If you provided custom host/port settings you need
to tell the nailgun client where to connect to:
ng --nailgun-server 127.0.0.1 --nailgun-port 2233 ng:tasks
@@ -124,6 +143,11 @@
The buildr_queue_size is of particular importance if you expect to
reload lots of buildfiles.
+
+ Running buildr using a nailgun client.
+
+ After you have started the nailgun server, you only have to open
another
+ terminal on a project directory
Execute ng:tasks get an overview of available nailgun tasks.
@@ -782,19 +806,19 @@
variable:
#{win ?
- "> set PATH=%PATH%:#{installed_bin.to_s.pathmap("%d")}" :
- "$ export PATH=${PATH};#{installed_bin.to_s.pathmap("%d")}"
+ "> set PATH=%PATH%;#{installed_bin.to_s.pathmap("%d")}" :
+ "$ export PATH=${PATH}:#{installed_bin.to_s.pathmap("%d")}"
}
To display Nailgun related help, execute the command:
- ``#{installed_bin.to_s.pathmap("%f")} help:nailgun''
+ ``ng ng:help''
To get an overview of Nailgun tasks, execute the command:
- ``#{installed_bin.to_s.pathmap("%f")} ng:tasks''
+ ``ng ng:tasks''
Runtime for #{Rake.application.buildfile} has been cached
- 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")}
+ and will be used by default when
``#{installed_bin.to_s.pathmap("%f")}'' is invoked
+ from a directory inside of #{installed_bin.to_s.pathmap("%d")}
NOTICE
end
