You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildr.apache.org by as...@apache.org on 2008/02/15 21:30:47 UTC
svn commit: r628165 - in /incubator/buildr/trunk/doc/pages: building.textile
extending.textile getting_started.textile packaging.textile whats_new.textile
Author: assaf
Date: Fri Feb 15 12:30:46 2008
New Revision: 628165
URL: http://svn.apache.org/viewvc?rev=628165&view=rev
Log:
More table goodness and Groovy listed in what's new page
Modified:
incubator/buildr/trunk/doc/pages/building.textile
incubator/buildr/trunk/doc/pages/extending.textile
incubator/buildr/trunk/doc/pages/getting_started.textile
incubator/buildr/trunk/doc/pages/packaging.textile
incubator/buildr/trunk/doc/pages/whats_new.textile
Modified: incubator/buildr/trunk/doc/pages/building.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/building.textile?rev=628165&r1=628164&r2=628165&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/building.textile (original)
+++ incubator/buildr/trunk/doc/pages/building.textile Fri Feb 15 12:30:46 2008
@@ -259,6 +259,7 @@
that @fsc@ _may_ cache class libraries -- don't forget to run @fsc -reset@ if you
upgrade a library.
+
h3. Compiling Groovy
Before using the Groovy compiler, you must first require it on your buildfile:
Modified: incubator/buildr/trunk/doc/pages/extending.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/extending.textile?rev=628165&r1=628164&r2=628165&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/extending.textile (original)
+++ incubator/buildr/trunk/doc/pages/extending.textile Fri Feb 15 12:30:46 2008
@@ -99,17 +99,17 @@
The easiest way to add callbacks is by incorporating the Extension module in
your own extension, and using the various class methods to define callback
-behavior:
+behavior.
-* @first_time@ -- This block will be called once for any particular extension.
-You can use this to setup top-level and local tasks.
-* @before_define@ -- This block is called once for the project with the
-project instance, right before running the project definition. You can use
-this to add tasks and set properties that will be used in the project
-definition.
-* @after_define@ -- This block is called once for the project with the project
+|_. Method |_. Usage |
+| @first_time@ | This block will be called once for any particular
+extension. You can use this to setup top-level and local tasks. |
+| @before_define@ | This block is called once for the project with the project
+instance, right before running the project definition. You can use this to add
+tasks and set properties that will be used in the project definition. |
+| @after_define@ | This block is called once for the project with the project
instance, right after running the project definition. You can use this to do
-any post-processing that depends on the project definition.
+any post-processing that depends on the project definition. |
This example illustrates how to write a simple extension:
@@ -195,18 +195,19 @@
The built-in tasks expand lists of symbols into relative paths, using the
following convention:
-* @:source, :main, <lang/usage>@ -- Directory containing source files for a
-given language or usage, for example, @:java@, @:resources@, @:webapp@.
-* @:source, :test, <lang/usage>@ -- Directory containing test files for a
-given language or usage, for example, @:java@, @:resources@.
-* @:target, :generated@ -- Target directory for generated code (typically
-source code).
-* @:target, :main, <lang/usage>@ -- Target directory for compiled code, for
-example, @:classes@, @:resources@.
-* @:target, :test, <lang/usage>@ -- Target directory for compile test cases,
-for example, @:classes@, @:resources@.
-* @:reports, <framework/usage>@ -- Target directory for generated reports, for
-example, @:junit@, @:coverage@.
+|_. Path |_. Expands to |
+| @:source, :main, <lang/usage>@ | Directory containing source files for a
+given language or usage, for example, @:java@, @:resources@, @:webapp@. |
+| @:source, :test, <lang/usage>@ | Directory containing test files for a given
+language or usage, for example, @:java@, @:resources@. |
+| @:target, :generated@ | Target directory for generated code
+(typically source code). |
+| @:target, :main, <lang/usage>@ | Target directory for compiled code, for
+example, @:classes@, @:resources@. |
+| @:target, :test, <lang/usage>@ | Target directory for compile test cases,
+for example, @:classes@, @:resources@. |
+| @:reports, <framework/usage>@ | Target directory for generated reports, for
+example, @:junit@, @:coverage@. |
All tasks are encouraged to use the same convention, and whenever possible, we
recommend using the project's @path_to@ method to expand a list of symbols
Modified: incubator/buildr/trunk/doc/pages/getting_started.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/getting_started.textile?rev=628165&r1=628164&r2=628165&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/getting_started.textile (original)
+++ incubator/buildr/trunk/doc/pages/getting_started.textile Fri Feb 15 12:30:46 2008
@@ -56,7 +56,7 @@
$ buildr --help
}}}
-|_. Option |_. Description |
+|_. Option |_. Usage |
| @-f/--buildfile [file]@ | Specify the buildfile. |
| @-e/--environment [name]@ | Environment name (e.g. development, test, production). |
| @-h/--help@ | Display this help message. |
Modified: incubator/buildr/trunk/doc/pages/packaging.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/packaging.textile?rev=628165&r1=628164&r2=628165&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/packaging.textile (original)
+++ incubator/buildr/trunk/doc/pages/packaging.textile Fri Feb 15 12:30:46 2008
@@ -289,10 +289,11 @@
EAR packages support four component types:
-* @:war@ -- J2EE Web Application (WAR).
-* @:ejb@ -- Enterprise Java Bean (JAR).
-* @:jar@ -- J2EE Application Client (JAR).
-* @:lib@ -- Shared library (JAR).
+|_. Argument |_. Component |
+| @:war@ | J2EE Web Application (WAR). |
+| @:ejb@ | Enterprise Java Bean (JAR). |
+| @:jar@ | J2EE Application Client (JAR). |
+| @:lib@ | Shared library (JAR). |
This example shows two ways for adding components built by other projects:
Modified: incubator/buildr/trunk/doc/pages/whats_new.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/whats_new.textile?rev=628165&r1=628164&r2=628165&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/whats_new.textile (original)
+++ incubator/buildr/trunk/doc/pages/whats_new.textile Fri Feb 15 12:30:46 2008
@@ -18,8 +18,6 @@
picked for JVM compilers (Java, Scala, Groovy, etc), so resources are not copied to
their own directory, @target/resources@. The prepare task has been removed.
-"Read more about Javac, Scalac, Groovyc":building.html#compiling_java
-
Not all languages have classpaths, so @compile.classpath@ is now known as
@compile.dependencies@, but the old attribute still exists for backward
compatibility.
@@ -44,15 +42,29 @@
add new compilers; however, I had to change the test framework API to
accommodate the new features, so old test frameworks will not work on 1.3.
+h4. Scala Support
+
+Buildr now supports Scala, using both native and fast Scala compiler.
+
+Read more about "using Scala":building.html#compiling_scala.
+
+
+h4. Groovy Support
+
+Buildr now supports Groovy, using the Groovyc Ant task.
+
+Read more about "using Groovy":building.html#compiling_groovy.
+
h4. Packaging EARs
EAR packages support four component types:
-* @:war@ -- J2EE Web Application (WAR).
-* @:ejb@ -- Enterprise Java Bean (JAR).
-* @:jar@ -- J2EE Application Client (JAR).
-* @:lib@ -- Shared library (JAR).
+|_. Argument |_. Component |
+| @:war@ | J2EE Web Application (WAR). |
+| @:ejb@ | Enterprise Java Bean (JAR). |
+| @:jar@ | J2EE Application Client (JAR). |
+| @:lib@ | Shared library (JAR). |
This example shows two ways for adding components built by other projects: