svn commit: r883434 - in /buildr/trunk/doc: artifacts.textile more_stuff.textile settings_profiles.textile

[bo...@apache.org]

Author: boisvert
Date: Mon Nov 23 17:55:25 2009
New Revision: 883434

URL: http://svn.apache.org/viewvc?rev=883434&view=rev
Log:
Update documentation for change related to buildr.rb location

Modified:
    buildr/trunk/doc/artifacts.textile
    buildr/trunk/doc/more_stuff.textile
    buildr/trunk/doc/settings_profiles.textile

Modified: buildr/trunk/doc/artifacts.textile
URL: http://svn.apache.org/viewvc/buildr/trunk/doc/artifacts.textile?rev=883434&r1=883433&r2=883434&view=diff
==============================================================================
--- buildr/trunk/doc/artifacts.textile (original)
+++ buildr/trunk/doc/artifacts.textile Mon Nov 23 17:55:25 2009
@@ -125,7 +125,7 @@
 repositories.local = '/usr/local/maven/repository'
 {% endhighlight %}
 
-That's one change you don't want to commit into the Buildfile, so the best place to do it is in your home directory's @buildr.rb@ file.
+That's one change you don't want to commit into the Buildfile, so the best place to do it is in the @buildr.rb@ file in the @.buildr@ directory under your home directory.
 
 Buildr downloads artifacts when it needs to use them, for example, to compile a project.  You don't need to download artifacts directly.  Except when you do, for example, if you want to download all the latest artifacts and then go off-line.  It's as simple as:
 

Modified: buildr/trunk/doc/more_stuff.textile
URL: http://svn.apache.org/viewvc/buildr/trunk/doc/more_stuff.textile?rev=883434&r1=883433&r2=883434&view=diff
==============================================================================
--- buildr/trunk/doc/more_stuff.textile (original)
+++ buildr/trunk/doc/more_stuff.textile Mon Nov 23 17:55:25 2009
@@ -280,7 +280,7 @@
 end
 {% endhighlight %}
 
-You can place this code inside @buildr.rb@ in your home directory.
+You can place this code inside @buildr.rb@ in the @.buildr@ directory under your home directory.
 
 h2(#eclipse). Eclipse
 
@@ -390,7 +390,7 @@
 require 'buildr/jdepend'
 {% endhighlight %}
 
-You may want to add those to the Buildfile.  Alternatively, you can use these tasks for all your projects without modifying the Buildfile.  One convenient method is to add these lines to the @buildr.rb@ file in your home directory.
+You may want to add those to the Buildfile.  Alternatively, you can use these tasks for all your projects without modifying the Buildfile.  One convenient method is to add these lines to the @buildr.rb@ file in the @.buildr@ directory under your home directory.
 
 Another option is to require it from the command line (@--require@ or @-r@), for example:
 

Modified: buildr/trunk/doc/settings_profiles.textile
URL: http://svn.apache.org/viewvc/buildr/trunk/doc/settings_profiles.textile?rev=883434&r1=883433&r2=883434&view=diff
==============================================================================
--- buildr/trunk/doc/settings_profiles.textile (original)
+++ buildr/trunk/doc/settings_profiles.textile Mon Nov 23 17:55:25 2009
@@ -166,9 +166,9 @@
 
 h2(#variable). Non constant settings
 
-Before loading the Buildfile, Buildr will attempt to load two other files: the @buildr.rb@ file it finds in your home directory, followed by the @buildr.rb@ file it finds in the build directory.
+Before loading the Buildfile, Buildr will attempt to load two other files: the @buildr.rb@ file in the @.buildr@ directory under your home directory, followed by the @buildr.rb@ file it finds in the build directory.
 
-The loading order allows you to place global settings that affect all your builds in your home directory's @buildr.rb@, but also over-ride those with settings for a given project.
+The loading order allows you to place global settings that affect all your builds in your @buildr.rb@, but also over-ride those with settings for a given project.
 
 Here's an example @buildr.rb@:
 
@@ -180,6 +180,12 @@
 repositories.remote << 'http://inside-the-firewall'
 {% endhighlight %}
 
+p(note). Buildr 1.3 and earlier used the file @buildr.rb@ directly in your home directory.  Starting with version 1.4, Buildr loads @buildr.rb@ from the @.buildr@ directory under your home directory in preference.  If you use Buildr 1.3 and earlier and don't want to duplicate your settings, you can move you existing @buildr.rb@ under the @.buildr@ directory and create a new @buildr.rb@ in your home directory containing:
+
+{% highlight ruby %}
+# Backward compatibility:  Buildr 1.4+ uses $HOME/.buildr/buildr.rb
+load File.expand_path('buildr.rb', Buildr.application.home_dir)
+{% endhighlight %}
 
 h2(#environments). Environments