Author: assaf
Date: Tue Aug 26 17:46:41 2008
New Revision: 689305
URL: http://svn.apache.org/viewvc?rev=689305&view=rev
Log:
Note: rake rcov is now rake coverage.
Contributing section: explaining how to use rake setup/install.
Contributing section: explaining how to use rake spec/failing/rcov.
Download section: mention that you can use Buildr from source with link to
contributing section.
OS/X => OS X, to please the fanboys.
Modified:
incubator/buildr/trunk/CHANGELOG
incubator/buildr/trunk/README.rdoc
incubator/buildr/trunk/doc/pages/contributing.textile
incubator/buildr/trunk/doc/pages/download.textile
incubator/buildr/trunk/doc/pages/getting_started.textile
incubator/buildr/trunk/doc/pages/more_stuff.textile
incubator/buildr/trunk/doc/pages/projects.textile
incubator/buildr/trunk/doc/pages/whats_new.textile
incubator/buildr/trunk/lib/buildr/java/jruby.rb
incubator/buildr/trunk/rakelib/doc.rake
incubator/buildr/trunk/rakelib/rspec.rake
Modified: incubator/buildr/trunk/CHANGELOG
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/CHANGELOG?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/CHANGELOG (original)
+++ incubator/buildr/trunk/CHANGELOG Tue Aug 26 17:46:41 2008
@@ -438,7 +438,7 @@
buildr/jdepend)
* Added: Cobertura test coverage tasks, reporting both html and xml. (Requires
buildr/cobertura)
-* Changed: tools_jar now returns empty array on OS/X, part of the ongoing
+* Changed: tools_jar now returns empty array on OS X, part of the ongoing
Write Once/Test Everywere effort. (Credit Paul Brown)
* Fixed: Work around keep_alive bug in Net::HTTP.
(http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/10818)
@@ -448,7 +448,7 @@
TestSuite.
* Changed: You can now run rake test:{foo,bar} to match against either foo or
bar (requires \{..\} on UNIX).
-* Changed: JAVA_HOME now required on all platforms, along with more OS/X
+* Changed: JAVA_HOME now required on all platforms, along with more OS X
fixes. (Credit Paul Brown)
* Fixed: You can now run rake test:<name> from any directory, and it will find
just the right test cases.
@@ -476,7 +476,7 @@
* Fixed: Local directory tasks now work from any directory in the project.
* Fixed: Artifacts no longer created with timestamp from server.
* Fixed: Buildr no longer fails when run without tools.jar or JAVA_HOME
-(OS/X). (Credit Lyle Johnson)
+(OS X). (Credit Lyle Johnson)
* Fixed: Manifest gets EOL to keep EOF company. (Credit Tommy Knowlton)
* Fixed: Compile tasks clean after themselves when target directory changed.
(Credit Lyle Johnson)
Modified: incubator/buildr/trunk/README.rdoc
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/README.rdoc?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/README.rdoc (original)
+++ incubator/buildr/trunk/README.rdoc Tue Aug 26 17:46:41 2008
@@ -20,7 +20,7 @@
gem install buildr
-(Use sudo for Linux and OS/X)
+(Use sudo for Linux and OS X)
More installation and setup instructions available online
http://incubator.apache.org/buildr/
@@ -79,7 +79,7 @@
When prompted for a platform, select ruby.
-=== OS/X
+=== OS X
Leopard includes the latest version of Ruby, if you are using Tiger or an older
release, we recommend re-installing the latest:
Modified: incubator/buildr/trunk/doc/pages/contributing.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/contributing.textile?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/contributing.textile (original)
+++ incubator/buildr/trunk/doc/pages/contributing.textile Tue Aug 26 17:46:41
2008
@@ -82,13 +82,13 @@
$ git clone git://github.com/vic/buildr.git
}}}
-The GitHub repository is maintained by contributors to this project, but is
*not* an official Apache repository. To obtain Buildr from the official Apache
repository, consider using @giv-svn@ instead.
-
If you want to learn more about Git, you can start by watching Scott
Chaconâs "Git
presentation":http://en.oreilly.com/rails2008/public/asset/attachment/2816
(PDF), or any of the "Git screencasts":http://www.gitcasts.com/. For more,
there's also the "Git Internals
book":http://peepcode.com/products/git-internals-pdf.
And keep this "Git cheat
sheet":http://ktown.kde.org/~zrusin/git/git-cheat-sheet-medium.png close at
hand. Very useful.
-h3. Installing from Source
+*Note:* The GitHub repository is maintained by contributors to this project,
but is *not* an official Apache repository. To obtain Buildr from the official
Apache repository, consider using @giv-svn@ instead.
+
+h3. Working with Source Code
To install Buildr from the source directory:
@@ -104,6 +104,12 @@
$ jruby -S rake setup install
}}}
+The _setup_ task takes care of installing all the necessary dependencies used
for building, testing and running Buildr. Once in a while we upgrade or add new
dependencies, if you're experiencing a missing dependency, simply run @rake
setup@ again.
+
+The _install_ task creates a Gem in your working directory (_pkg/_) and
install it in your local repository. Since Ruby Gems uses version numbers to
detect new releases, if you installed Buildr this way and want to upgrade to
the latest official release, you need to use @gem install buildr@ rather than
@gem [EMAIL PROTECTED]
+
+Both _setup_ and _install_ tasks use the @sudo@ command on platforms that
require it (i.e. not Windows), so there's no need to run @sudo rake@ when
working with the Buildr source code.
+
h3. Using development build
@@ -113,7 +119,7 @@
gem source --add http://people.apache.org/~assaf/buildr/snapshot
}}}
-Since Ruby Gems only upgrades when it notices a new version number, you have
to @gem install buildr@ to get the most recent development build.
+Since Ruby Gems uses version numbers to detect new releases, if you installed
Buildr from a snapshot and want to upgrade to a newer snapshot or the latest
official release, you need to use @gem install buildr@ rather than @gem [EMAIL
PROTECTED]
If you want to go back to using the RubyForge releases:
@@ -136,18 +142,29 @@
You can run an individual specifications using the @spec@ command, for example:
{{{!sh
+$ spec spec/compiler_spec.rb
$ spec spec/compiler_spec.rb -l 409
}}}
+The first command will run all the specifications in @compiler_spec@, the
second command will run only the specification identified by line 409 of that
file. You can use line numbers to point at a particular specification (lines
starting with @it@), or set of specifications (lines starting with @describe@).
You can also use the @-e@ command line option to name a particular
specification.
+
To make sure your change did not break anything else, you can run all the
specifications (be patient, we have a lot of these):
{{{!sh
$ rake spec
}}}
+If you get any failures, you can use @rake failed@ to run only the failed
specs, and repeat until there are no more failed specs to run. The list of
failed specs is stored in the file _failed_.
+
We always @rake spec@ before making a release.
-You can also check out the "RSpec report":report.html which provides the
official specification against which we test each release.
+For full test coverage:
+
+{{{!sh
+$ rake coverage
+}}}
+
+Specification and coverage reports are HTML files you can view with a Web
browser, look for them in the _reports_ directory. You can also check out the
"RSpec report":specs.html and "test coverage":coverage/index.html we publish
with each release.
h3. Documentation
Modified: incubator/buildr/trunk/doc/pages/download.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/download.textile?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/download.textile (original)
+++ incubator/buildr/trunk/doc/pages/download.textile Tue Aug 26 17:46:41 2008
@@ -3,12 +3,14 @@
h2. Installing Buildr
-The easiest way to install Buildr is using the fabulous RubyGems package
manager. Of course, you will need either Ruby or JRuby, and we recommend
upgrading to the most recent version of RubyGems. If this sounds foreign to
you, don't worry. We'll show you how to install Buildr on Linux, OS/X, Windows
and JRuby in the "Getting Started guide":getting_started.html, we even provide
automated installation scripts.
+The easiest way to install Buildr is using the fabulous RubyGems package
manager. Of course, you will need either Ruby or JRuby, and we recommend
upgrading to the most recent version of RubyGems. If this sounds foreign to
you, don't worry. We'll show you how to install Buildr on Linux, OS X, Windows
and JRuby in the "Getting Started guide":getting_started.html, we even provide
automated installation scripts.
The *official Apache distribution* consists of the digitally signed binaries
(gems) and source packages "available below":#binaries_and_source_code. To
install these binaries, you must first download them to disk and then install
them using the @gem install@ command (or @rake install@ for a source
distribution).
In addition, contributors to this project maintain a separate distribution
over on "RubyForge":http://rubyforge.org/projects/buildr. Using this
distribution, you're able to install Buildr directly from the remote gem
repository and to automatically upgrade when a new release comes out. The
RubyForge distribution is *not* an official Apache distribution.
+The source code is included in both source and binary distribution, the Gem
distribution expands the source code into your local Gem repository. That's in
addition to getting the source code directly from
"SVN":http://svn.apache.org/repos/asf/incubator/buildr or
"GitHub":http://github.com/vic/buildr/tree/master. Learn more about working
with source code and "living on the edge":contributing.html#living_on_the_edge.
+
h2. Binaries and Source Code
Modified: incubator/buildr/trunk/doc/pages/getting_started.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/getting_started.textile?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/getting_started.textile (original)
+++ incubator/buildr/trunk/doc/pages/getting_started.textile Tue Aug 26
17:46:41 2008
@@ -52,9 +52,9 @@
You can also use this script "to install Buildr on
Linux":scripts/install-linux.sh. This script will install Buildr or if already
installed, upgrade to a more recent version. It will also install Ruby 1.8.6
if not already installed (using @yum@ or @apt-get@) and upgrage RubyGems to
1.0.1.
-h3. OS/X
+h3. OS X
-OS/X 10.5 (Leopard) comes with a recent version of Ruby 1.8.6. OS/X 10.4
(Tiger) includes an older version of Ruby, we recommend you first install Ruby
1.8.6 using MacPorts (@sudo port install ruby rb-rubygems@), Fink or the "Ruby
One-Click Installer for OS/X":http://rubyosx.rubyforge.org/.
+OS X 10.5 (Leopard) comes with a recent version of Ruby 1.8.6. OS X 10.4
(Tiger) includes an older version of Ruby, we recommend you first install Ruby
1.8.6 using MacPorts (@sudo port install ruby rb-rubygems@), Fink or the "Ruby
One-Click Installer for OS X":http://rubyosx.rubyforge.org/.
We recommend you first upgrade to the latest version of Ruby gems:
@@ -81,7 +81,7 @@
$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr -v 1.3.0
}}}
-You can also use this script "to install Buildr on
OS/X":scripts/install-osx.sh. This script will install Buildr or if already
installed, upgrade to a more recent version. It will also install Ruby 1.8.6
if not already installed (using MacPorts) and upgrage RubyGems to 1.0.1.
+You can also use this script "to install Buildr on OS
X":scripts/install-osx.sh. This script will install Buildr or if already
installed, upgrade to a more recent version. It will also install Ruby 1.8.6
if not already installed (using MacPorts) and upgrage RubyGems to 1.0.1.
h3. Windows
@@ -116,7 +116,7 @@
After uncompressing JRuby, update your @PATH@ to include both @java@ and
@jruby@ executables.
-For Linux and OS/X:
+For Linux and OS X:
{{{!sh
$ export PATH=$PATH:[path to JRuby]/bin:$JAVA_HOME/bin
Modified: incubator/buildr/trunk/doc/pages/more_stuff.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/more_stuff.textile?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/more_stuff.textile (original)
+++ incubator/buildr/trunk/doc/pages/more_stuff.textile Tue Aug 26 17:46:41 2008
@@ -116,7 +116,7 @@
h2. Growl, Qube
-For OS/X users, Buildr supports "Growl":http://growl.info/ out of the box to
send "completed and "failed" notifications to the user.
+For OS X users, Buildr supports "Growl":http://growl.info/ out of the box to
send "completed and "failed" notifications to the user.
For other platforms or if you want to notify the user differently, Buildr
offers two extension points:
Modified: incubator/buildr/trunk/doc/pages/projects.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/projects.textile?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/projects.textile (original)
+++ incubator/buildr/trunk/doc/pages/projects.textile Tue Aug 26 17:46:41 2008
@@ -231,7 +231,7 @@
But in practice, you'll want to use the @path_to@ method. This method
calculates a path relative to the project, a better way if you ever need to
refactor your code, say turn a ad hoc task into a function you reuse.
-The @path_to@ method takes an array of strings and concatenates them into a
path. Absolute paths are returned as they are, relative paths are expanded
relative to the project's base directory. Slashes, if you don't already know,
work very well on both Windows, Linux and OS/X. And as a shortcut, you can use
@[EMAIL PROTECTED]
+The @path_to@ method takes an array of strings and concatenates them into a
path. Absolute paths are returned as they are, relative paths are expanded
relative to the project's base directory. Slashes, if you don't already know,
work very well on both Windows, Linux and OS X. And as a shortcut, you can use
@[EMAIL PROTECTED]
For example:
Modified: incubator/buildr/trunk/doc/pages/whats_new.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/whats_new.textile?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/whats_new.textile (original)
+++ incubator/buildr/trunk/doc/pages/whats_new.textile Tue Aug 26 17:46:41 2008
@@ -304,7 +304,7 @@
* The "What's new?":whats_new.html page (this one, actually), summarizes all
the important new features and changes in each release.
* The "Recipes":recipes.html page (also available in the PDF) lists recipes
for using Buildr, collected from the mailing list. Feel free to contribute
tips, tricks and techniques.
* The "Troubleshooting":troubleshooting.html page (also available in the PDF)
collects troubleshooting ideas from the mailing list.
-* The "Getting Started":getting_started.html has been rewritten to cover all
you need to know about downloading and installing Buildr on Linux, OS/X,
Windows and with JRuby (1.1 or later).
+* The "Getting Started":getting_started.html has been rewritten to cover all
you need to know about downloading and installing Buildr on Linux, OS X,
Windows and with JRuby (1.1 or later).
* A new "Contributing":contributing.html page has more details on how to file
bugs, policy for submitting patches, running Buildr test cases, and helping
with the documentation.
* A new page for "Settings and Profiles":settings_profiles.html.
* The "Extending Buildr":extending.html page that deals with writing your own
tasks, creating extensions and specifying alternative layouts.
Modified: incubator/buildr/trunk/lib/buildr/java/jruby.rb
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/lib/buildr/java/jruby.rb?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/lib/buildr/java/jruby.rb (original)
+++ incubator/buildr/trunk/lib/buildr/java/jruby.rb Tue Aug 26 17:46:41 2008
@@ -82,7 +82,7 @@
getDeclaredMethod('addURL', [java.net.URL].to_java(java.lang.Class))
add_url_method.setAccessible(true)
add_path = lambda { |path| add_url_method.invoke(sysloader,
[java.io.File.new(path).toURI.toURL].to_java(java.net.URL)) }
- # Include tools (compiler, Javadoc, etc) for all platforms except OS/X.
+ # Include tools (compiler, Javadoc, etc) for all platforms except OS X.
unless Config::CONFIG['host_os'] =~ /darwin/i
home = ENV['JAVA_HOME'] or fail 'Are we forgetting something?
JAVA_HOME not set.'
tools = File.expand_path('lib/tools.jar', home)
Modified: incubator/buildr/trunk/rakelib/doc.rake
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/rakelib/doc.rake?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/rakelib/doc.rake (original)
+++ incubator/buildr/trunk/rakelib/doc.rake Tue Aug 26 17:46:41 2008
@@ -60,7 +60,7 @@
Docter::Rake.generate 'site', collection, template
Docter::Rake.generate 'print',
-
Docter.collection(spec.name).using('doc/print.toc.yaml').include('doc/pages',
'LICENSE'),
+
Docter.collection(spec.name).using('doc/print.toc.yaml').include('doc/pages'),
Docter.template('doc/print.haml').include('doc/css', 'doc/images'),
:one_page
file('print/buildr.pdf'=>'print') do |task|
Modified: incubator/buildr/trunk/rakelib/rspec.rake
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/rakelib/rspec.rake?rev=689305&r1=689304&r2=689305&view=diff
==============================================================================
--- incubator/buildr/trunk/rakelib/rspec.rake (original)
+++ incubator/buildr/trunk/rakelib/rspec.rake Tue Aug 26 17:46:41 2008
@@ -38,14 +38,14 @@
# TODO: Horribly broken! Fix some other time.
desc 'Run RSpec and generate Spec and coverage reports (slow)'
- Spec::Rake::SpecTask.new('rcov') do |task|
- task.spec_files = Dir['spec/**/*spec.rb']
+ Spec::Rake::SpecTask.new('coverage') do |task|
+ task.spec_files = Dir['spec/**/*_spec.rb']
task.spec_opts = %W{--format progress --colour --format
failing_examples:failed --format html:reports/specs.html --backtrace}
task.rcov = true
task.rcov_dir = 'reports/coverage'
task.rcov_opts = %W{--exclude
spec,bin,#{Config::CONFIG['sitedir']},#{Gem.path.join(',')} --text-summary}
end
- file 'reports/coverage'=>'rcov'
+ file 'reports/coverage'=>'coverage'
# Useful for testing with JRuby when using Ruby and vice versa.
namespace 'spec' do
