svn commit: r881519 - in /buildr/trunk: CHANGELOG doc/projects.textile

[bo...@apache.org]

Author: boisvert
Date: Tue Nov 17 21:09:55 2009
New Revision: 881519

URL: http://svn.apache.org/viewvc?rev=881519&view=rev
Log:
BUILDR-345 Improve project documentation (Peter Schröder)

Modified:
    buildr/trunk/CHANGELOG
    buildr/trunk/doc/projects.textile

Modified: buildr/trunk/CHANGELOG
URL: http://svn.apache.org/viewvc/buildr/trunk/CHANGELOG?rev=881519&r1=881518&r2=881519&view=diff
==============================================================================
--- buildr/trunk/CHANGELOG (original)
+++ buildr/trunk/CHANGELOG Tue Nov 17 21:09:55 2009
@@ -18,6 +18,7 @@
           entries (Stefan Wasilewski)
 * Fixed:  BUILDR-327 Specifying :plugin eclipse nature explicitly fails
 * Fixed:  buildr test=all didn't run all tests as expected
+* Fixed:  BUILDR-345 Improve project documentation (Peter Schröder)
 
 1.3.5 (2009-10-05)
 * Added:  Interactive shell (REPL) support

Modified: buildr/trunk/doc/projects.textile
URL: http://svn.apache.org/viewvc/buildr/trunk/doc/projects.textile?rev=881519&r1=881518&r2=881519&view=diff
==============================================================================
--- buildr/trunk/doc/projects.textile (original)
+++ buildr/trunk/doc/projects.textile Tue Nov 17 21:09:55 2009
@@ -13,7 +13,9 @@
 The remainder of this guide deals with what it takes to build a project.  But first, let's pick up a sample project to work with.  We'll call it _killer-app_:
 
 {% highlight ruby %}
-require 'buildr'
+require "buildr/openjpa"
+
+include Buildr::OpenJPA
  
 VERSION_NUMBER = '1.0'
  
@@ -90,7 +92,7 @@
 
 h2(#naming). Naming And Finding Projects
 
-Each project has a given name, the first argument you pass when calling @define@.  The project name is just a string, but we advise to stay clear of colon (@:@) and slashes (@/@ and @\@), which could conflict with other task and file names.  Also, avoid using common Buildr task names, don't pick @compile@ or @build@ for your project name.
+Each project has a given name, the first argument you pass when calling @define@.  The project name is just a string, but we advise to stay clear of colon (@:@) and slashes (@/@ and @\@), which could conflict with other task and file names.  Also, avoid using common Buildr task names, don't pick @compile@, @build@ or any existing task name for your project name.
 
 Since each project knows its parent project, child projects and siblings, you can reference them from within the project using just the given name.  In other cases, you'll need to use the full name.  The full name is just @parent:child@. So if you wanted to refer to _teh-impl_, you could do so with either @project('killer-app:teh-impl')@ or @project('killer-app').project('teh-impl')@.
 
@@ -201,6 +203,9 @@
 # Relative to the current project
 path_to('src', 'main', 'java')
 
+# the same using symbols
+path_to(:src, :main, :java)
+
 # Exactly the same thing
 _('src/main/java')