public
Rubygem
Description: Apache Buildr
Homepage: http://incubator.apache.org/buildr
Clone URL: git://github.com/vic/buildr.git
Search Repo:
Moved download instructions to Getting Started, fixed many PDF styling 
issues

git-svn-id: https://svn.apache.org/repos/asf/incubator/buildr/trunk@629666 
13f79535-47bb-0310-9956-ffa450edef68
Assaf (author)
Wed Feb 20 17:25:16 -0800 2008
commit  af0bed3eeef79c861b5ebf2c54a388063d64241f
tree    323a60e8b504522ad350a083b7a73f451e7934cc
parent  38edf6bb65ebfab91196f7e1d6f1c934b22e0a65
0
...
62
63
64
 
 
 
 
 
 
 
 
...
62
63
64
65
66
67
68
69
70
71
72
0
@@ -62,4 +62,12 @@
0
 * ruwiki (archive-tar-minitar) - http://rubyforge.org/projects/ruwiki/
0
 Licensed under the Ruby License
0
 Copyright 2004 Mauricio Julio Fernández Pradier and Austin Ziegler
0
+
0
+* DejaVu - http://dejavu.sourceforge.net
0
+Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved.
0
+Bitstream Vera is a trademark of Bitstream, Inc.
0
+
0
+* ColorCons - http://www.mouserunner.com/
0
+Licensed under Creative Commons Attribution-ShareAlike 2.5
0
+Copyright (c) 2006 Ken Saunders
...
145
146
147
148
 
149
150
151
...
226
227
228
 
 
 
 
229
230
231
...
145
146
147
 
148
149
150
151
...
226
227
228
229
230
231
232
233
234
235
0
@@ -145,7 +145,7 @@
0
       include('doc/css', 'doc/images', 'doc/scripts', 'html/report.html', 'html/coverage', 'html/rdoc')
0
   }
0
   print_docs = {
0
- :collection => Docter.collection('Buildr — The build system that doesn\'t suck').using('doc/print.toc.yaml').
0
+ :collection => Docter.collection('Buildr').using('doc/print.toc.yaml').
0
       include('doc/pages', 'LICENSE'),
0
     :template => Docter.template('doc/print.haml').include('doc/css', 'doc/images')
0
   }
0
@@ -226,6 +226,10 @@
0
 end
0
 
0
 namespace :release do
0
+
0
+ # TODO: Check that we're using allison.
0
+ # TODO: Check that we can generate PDFs.
0
+
0
   task :ready? do
0
     require 'highline'
0
     require 'highline/import'
...
83
84
85
 
86
87
88
...
83
84
85
86
87
88
89
0
@@ -83,6 +83,7 @@
0
 th {
0
   border-bottom: none;
0
   background-color: #E5E5E5;
0
+ text-align: left;
0
 }
0
 
0
 
...
1
 
2
3
4
5
 
 
6
7
8
9
10
 
 
11
12
13
14
15
16
17
18
 
 
 
 
19
20
21
22
...
30
31
32
33
34
 
 
 
35
36
37
...
44
45
46
47
 
48
49
50
...
68
69
70
71
 
 
72
73
74
...
 
1
2
 
 
 
3
4
5
6
 
 
 
7
8
9
10
 
 
11
12
13
14
15
16
17
18
19
20
21
22
...
30
31
32
 
33
34
35
36
37
38
39
...
46
47
48
 
49
50
51
52
...
70
71
72
 
73
74
75
76
77
0
@@ -1,21 +1,21 @@
0
-@page { margin: 1in 0.5in 2in 0.5in; }
0
+@page { margin: 1in 0.75in 1in 0.75in; }
0
 @page:left {
0
- @bottom-left { content: counter(page); }
0
- @bottom-right { content: string(pagetitle); }
0
- @top-right { content: string(doctitle); }
0
+ @top-left { content: counter(page); }
0
+ @top-right { content: string(pagetitle); }
0
 }
0
 @page:right {
0
- @bottom-right { content: counter(page); }
0
- @bottom-left { content: string(pagetitle); }
0
- @top-left { content: string(doctitle); }
0
+ @top-left { content: string(pagetitle); }
0
+ @top-right { content: counter(page); }
0
 }
0
 @page:first {
0
- @bottom-left { content: normal }
0
- @bottom-right { content: normal }
0
   @top-left { content: normal }
0
   @top-right { content: normal }
0
 }
0
 
0
+title {
0
+ string-set: doctitle content();
0
+}
0
+
0
 body {
0
   font-size: 12pt;
0
   margin: 0;
0
0
@@ -30,8 +30,10 @@
0
 h1:first-child { page-break-before: avoid; }
0
 pre, p, blockquote { page-break-inside: avoid; }
0
 pre {
0
- font-size: 85% !important;
0
   line-height: 1.3em;
0
+ white-space: pre-wrap; /* css-3 */
0
+ padding: 0.3em 0 0.9em 0.6em;
0
+ margin: 0;
0
 }
0
 a:link, a:visited {
0
   background: transparent;
0
@@ -44,7 +46,7 @@
0
   color: black;
0
   background: transparent;
0
   width: auto !important;
0
- margin: 0 5%;
0
+ margin: 0;
0
   padding: 0;
0
   border: 0;
0
 }
0
@@ -68,7 +70,8 @@
0
 
0
 #footer { margin-top: 5%; }
0
 
0
-#license+pre {
0
+#license {
0
+ padding-top: 1in;
0
   page-break-before: none !important;
0
   page-break-inside: always !important;
0
 }
...
308
309
310
 
 
 
 
 
311
312
...
308
309
310
311
312
313
314
315
316
317
0
@@ -308,6 +308,11 @@
0
 upload bean
0
 }}}
0
 
0
+p(tip). Calling the @install@ (and likewise @upload@) method on an artifact
0
+does not install the artifact, it simply adds a task that will execute when you
0
+run @buildr install@. If you need to download and install an artifact, invoke
0
+the task directly with @install(<artifact>).invoke@.
0
+
0
 
0
 Next we're going to "package some artifacts":packaging.html.
...
1
 
2
3
4
5
6
7
 
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
 
 
 
 
225
226
227
...
 
1
2
 
 
 
 
3
4
5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
7
8
9
10
11
12
13
0
@@ -1,227 +1,13 @@
0
-h1. Download and Installation
0
+h1. Download
0
 
0
-The installation instructions are slightly different for each operating system.
0
-If you are using Ruby, pick the one that best matches your operating system.
0
-If you are using JRuby, see the instructions for "JRuby":#jruby and also read
0
-about using "JRuby and Ruby side by side":#using_jruby_and_ruby.
0
 
0
+h2. Installing Buildr
0
 
0
-p(note). At the moment it seems that Buildr will not work with Java 6, and can
0
-only be used with Java 1.5 or earlier. If you prefer to use Java 6, consider
0
-installing and using "Buildr for JRuby":jruby.
0
-
0
-
0
-h2. Linux
0
-
0
-To get started you will need a recent version of Ruby, Ruby Gems and build
0
-tools for compiling native libraries (Make and GCC).
0
-
0
-On RedHat/Fedora you can use yum to install Ruby and RubyGems, and then upgrade
0
-to the most recent version of RubyGems:
0
-
0
-{{{!sh
0
-$ sudo yum install ruby rubygems ruby-devel gcc
0
-$ sudo gem update --system
0
-}}}
0
-
0
-On Ubuntu you have to install several packages:
0
-
0
-{{{!sh
0
-$ sudo apt-get install ruby-full ruby1.8-dev libopenssl-ruby build-essential
0
-}}}
0
-
0
-The Debian package for @rubygems@ will not allow you to install Buildr, so you
0
-need to install RubyGems from source:
0
-
0
-{{{!sh
0
-$ curl -OL http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz
0
-$ tar xzf rubygems-1.0.1.tgz
0
-$ cd rubygems-1.0.1
0
-$ sudo ruby setup.rb
0
-$ sudo ln -s /usr/bin/gem1.8 /usr/bin/gem
0
-}}}
0
-
0
-Before installing Buildr, please set the @JAVA_HOME@ environment variable to
0
-point to your JDK distribution. Next, use Ruby Gem to install Buildr:
0
-
0
-{{{!sh
0
-$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr
0
-}}}
0
-
0
-To upgrade to a new version of Buildr:
0
-
0
-{{{!sh
0
-$ sudo env JAVA_HOME=$JAVA_HOME gem update buildr
0
-}}}
0
-
0
-To install a specific version of Buildr:
0
-
0
-{{{!sh
0
-$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr -v 1.3.0
0
-}}}
0
-
0
-You can also use this script "to install Buildr on
0
-Linux":scripts/install-linux.sh. The script will either install or upgrade
0
-Buildr to the latest version. It will also upgrade RubyGems to version 1.0.1
0
-or later, and if necessary install Ruby 1.8.6 using yum (RPM) or apt-get (deb).
0
-
0
-
0
-h2. OS/X
0
-
0
-OS/X 10.5 (Leopard) comes with the latest version of Ruby 1.8. If you are
0
-using an older version of OS/X, you will first need to upgrade to a recent
0
-version of Ruby. You can install Ruby using MacPorts or Fink, or use the
0
-"One-Click Installer":http://rubyosx.rubyforge.org/.
0
-
0
-We recommend you first upgrade to the latest version of Ruby gems:
0
-
0
-{{{!sh
0
-$ sudo gem update --system
0
-}}}
0
-
0
-Before installing Buildr, please set the @JAVA_HOME@ environment variable to
0
-point to your JDK distribution:
0
-
0
-{{{!sh
0
-$ export JAVA_HOME=/Library/Java/Home
0
-}}}
0
-
0
-To install Buildr:
0
-
0
-{{{!sh
0
-$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr
0
-}}}
0
-
0
-To upgrade to a new version of Buildr:
0
-
0
-{{{!sh
0
-$ sudo env JAVA_HOME=$JAVA_HOME gem update buildr
0
-}}}
0
-
0
-To install a specific version of Buildr:
0
-
0
-{{{!sh
0
-$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr -v 1.3.0
0
-}}}
0
-
0
-You can also use this script "to install Buildr on
0
-OS/X":scripts/install-osx.sh. The script will either install or upgrade Buildr
0
-to the latest version. It will also upgrade RubyGems to version 1.0.1 or
0
-later, and if necessary install Ruby 1.8.6 using MacPorts or Fink.
0
-
0
-
0
-h2. Windows
0
-
0
-If you don't already have Ruby installed, now is the time to do it. The
0
-easiest way to install Ruby is using the "one-click
0
-installer":http://rubyinstaller.rubyforge.org/.
0
-
0
-We recommend you first upgrade to the latest version of Ruby gems:
0
-
0
-{{{!sh
0
-> gem update --system
0
-}}}
0
-
0
-Before installing Buildr, please set the @JAVA_HOME@ environment variable to
0
-point to your JDK distribution. Next, use Ruby Gem to install Buildr:
0
-
0
-{{{!sh
0
-> gem install buildr
0
-}}}
0
-
0
-Buildr uses several libraries that include native extensions. During
0
-installation it will ask you to pick a platform for these libraries. By
0
-selecting @mswin32@ it will download and install pre-compiled DLLs for these
0
-extensions.
0
-
0
-To upgrade to a new version of Buildr:
0
-
0
-{{{!sh
0
-> gem update buildr
0
-}}}
0
-
0
-To install a specific version of Buildr:
0
-
0
-{{{!sh
0
-> gem install buildr -v 1.3.0
0
-}}}
0
-
0
-
0
-h2. JRuby
0
-
0
-If you don't already have JRuby 1.1RC2 or later installed, you can download it
0
-from the "JRuby site":http://dist.codehaus.org/jruby/.
0
-
0
-After uncompressing JRuby, update your @PATH@ to include both JRuby and Java
0
-executables, so you can run JRuby with the command @jruby@.
0
-
0
-For Windows:
0
-
0
-{{{!sh
0
-> set JRUBY_HOME=<path to JRuby>
0
-> set PATH=%JRUBY_HOME%/bin;%JAVA_HOME%/bin;%PATH%
0
-> gem install buildr
0
-}}}
0
-
0
-And for Unix:
0
-
0
-{{{!sh
0
-$ export JRUBY_HOME=<path to JRuby>
0
-$ export PATH=$JRUBY_HOME/bin:$JAVA_HOME/bin:$PATH
0
-$ gem install buildr
0
-}}}
0
-
0
-Once installed, you will find the @buildr@ exectuable in the @JRUBY_HOME/bin@
0
-directory.
0
-
0
-To upgrade to a new version of Buildr:
0
-
0
-{{{!sh
0
-$ sudo gem update buildr
0
-}}}
0
-
0
-To install a specific version of Buildr:
0
-
0
-{{{!sh
0
-$ sudo gem install buildr -v 1.3.0
0
-}}}
0
-
0
-You can also use this script "to install Buildr for
0
-JRuby":scripts/install-jruby.sh. The script will either install or upgrade
0
-Buildr to the latest version. If you do not already have JRuby installed, it
0
-will install JRuby 1.1RC2 in @/opt/jruby@ and update the PATH in
0
-@~/.bash_profile@ or @~/.profile@.
0
-
0
-
0
-h2. Using JRuby and Ruby
0
-
0
-Ruby and JRuby maintain separate Gem repositories, and in fact install slightly
0
-different versions of the Buildr Gem (same functionality, different
0
-dependencies). If you want to use Buildr with both, you must install it
0
-separately for each one.
0
-
0
-If you installed JRuby on your machine and do not have Ruby installed, the
0
-@gem@ and @buildr@ commands will default to using JRuby. However, you may
0
-already have Ruby installed (some operating systems come with Ruby
0
-pre-installed), in which case these commands will default to whichever is first
0
-on the path.
0
-
0
-To work exclusively with JRuby, make sure it shows first on the path, for example,
0
-by setting @PATH=/opt/jruby/bin:$PATH@. Alternatively, you can run scripts with a particular version
0
-of Ruby using the @-S@ command line argument. For example:
0
-
0
-{{{!
0
-$ # with Ruby
0
-$ ruby -S gem install buildr
0
-$ ruby -S buildr
0
-$ # with JRuby
0
-$ jruby -S gem install buildr
0
-$ jruby -S buildr
0
-}}}
0
-
0
-To find out which version of Buildr you are using by default, run @buildr
0
---help@. Buildr reports the version number and adds @(JRuby)@ next to it when
0
-running on JRuby.
0
+The easiest way to install Buildr is using the fabulous RubyGems package manager. Of course,
0
+you will need either Ruby or JRuby, and we recommend a recent version of RubyGems and
0
+if this sounds foreign to you, don't worry. We'll show you how to install Buildr on Linux,
0
+OS/X, Windows and JRuby in the "Getting Started guide":getting_started.html, we even provide
0
+automated installation scripts.
0
 
0
 
0
 h2. Binaries and Source Code
...
2
3
4
5
 
 
 
6
 
 
 
7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
9
10
...
96
97
98
99
100
 
 
 
 
101
102
103
...
2
3
4
 
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
...
291
292
293
 
 
294
295
296
297
298
299
300
0
@@ -2,9 +2,204 @@
0
 
0
 h2. Installing Buildr
0
 
0
-More information about "downloading and installing Buildr":download.html.
0
+The installation instructions are slightly different for each operating system.
0
+If you are using Ruby, pick the one that best matches your operating system and
0
+target platform.
0
 
0
+p(note). The current release of Buildr for Ruby does not work with Java 6 and
0
+can only be used with Java 1.5 or earlier. "Buildr for JRuby":#jruby works
0
+nicely with Java 6, consider using that instead.
0
 
0
+
0
+h3. Linux
0
+
0
+To get started you will need a recent version of Ruby, Ruby Gems and build
0
+tools for compiling native libraries (@make@, @gcc@ and standard headers).
0
+
0
+On *RedHat/Fedora* you can use yum to install Ruby and RubyGems, and then
0
+upgrade to the most recent version of RubyGems:
0
+
0
+{{{!sh
0
+$ sudo yum install ruby rubygems ruby-devel gcc
0
+$ sudo gem update --system
0
+}}}
0
+
0
+On *Ubuntu* you have to install several packages:
0
+
0
+{{{!sh
0
+$ sudo apt-get install ruby-full ruby1.8-dev libopenssl-ruby build-essential
0
+}}}
0
+
0
+The Debian package for @rubygems@ will not allow you to install Buildr, so you
0
+need to install RubyGems from source:
0
+
0
+{{{!sh
0
+$ curl -OL http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz
0
+$ tar xzf rubygems-1.0.1.tgz
0
+$ cd rubygems-1.0.1
0
+$ sudo ruby setup.rb
0
+$ sudo ln -s /usr/bin/gem1.8 /usr/bin/gem
0
+}}}
0
+
0
+Before installing Buildr, please set the @JAVA_HOME@ environment variable to
0
+point to your JDK distribution. Next, use Ruby Gem to install Buildr:
0
+
0
+{{{!sh
0
+$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr
0
+}}}
0
+
0
+To upgrade to a new version or install a specific version:
0
+
0
+{{{!sh
0
+$ sudo env JAVA_HOME=$JAVA_HOME gem update buildr
0
+$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr -v 1.3.0
0
+}}}
0
+
0
+You can also use this script "to install Buildr on
0
+Linux":scripts/install-linux.sh. This script will install Buildr or if already
0
+installed, upgrade to a more recent version. It will also install Ruby 1.8.6
0
+if not already installed (using @yum@ or @apt-get@) and upgrage RubyGems to
0
+1.0.1.
0
+
0
+
0
+h3. OS/X
0
+
0
+OS/X 10.5 (Leopard) comes with a recent version of Ruby 1.8.6. OS/X 10.4
0
+(Tiger) includes an older version of Ruby, we recommend you first install Ruby
0
+1.8.6 using MacPorts (@sudo port install ruby rb-rubygems@), Fink or the
0
+"Ruby One-Click Installer for OS/X":http://rubyosx.rubyforge.org/.
0
+
0
+We recommend you first upgrade to the latest version of Ruby gems:
0
+
0
+{{{!sh
0
+$ sudo gem update --system
0
+}}}
0
+
0
+Before installing Buildr, please set the @JAVA_HOME@ environment variable to
0
+point to your JDK distribution:
0
+
0
+{{{!sh
0
+$ export JAVA_HOME=/Library/Java/Home
0
+}}}
0
+
0
+To install Buildr:
0
+
0
+{{{!sh
0
+$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr
0
+}}}
0
+
0
+To upgrade to a new version or install a specific version:
0
+
0
+{{{!sh
0
+$ sudo env JAVA_HOME=$JAVA_HOME gem update buildr
0
+$ sudo env JAVA_HOME=$JAVA_HOME gem install buildr -v 1.3.0
0
+}}}
0
+
0
+You can also use this script "to install Buildr on
0
+OS/X":scripts/install-osx.sh. This script will install Buildr or if already
0
+installed, upgrade to a more recent version. It will also install Ruby 1.8.6
0
+if not already installed (using MacPorts) and upgrage RubyGems to 1.0.1.
0
+
0
+
0
+h3. Windows
0
+
0
+If you don't already have Ruby installed, now is the time to do it. The
0
+easiest way to install Ruby is using the "one-click
0
+installer":http://rubyinstaller.rubyforge.org/.
0
+
0
+We recommend you first upgrade to the latest version of Ruby gems:
0
+
0
+{{{!sh
0
+> gem update --system
0
+}}}
0
+
0
+Before installing Buildr, please set the @JAVA_HOME@ environment variable to
0
+point to your JDK distribution. Next, use Ruby Gem to install Buildr:
0
+
0
+{{{!sh
0
+> gem install buildr
0
+}}}
0
+
0
+Buildr uses several libraries that include native extensions. During
0
+installation it will ask you to pick a platform for these libraries. By
0
+selecting @mswin32@ it will download and install pre-compiled DLLs for these
0
+extensions.
0
+
0
+To upgrade to a new version or install a specific version:
0
+
0
+{{{!sh
0
+> gem update buildr
0
+> gem install buildr -v 1.3.0
0
+}}}
0
+
0
+
0
+h3. JRuby
0
+
0
+If you don't already have JRuby 1.1RC2 or later installed, you can download it
0
+from the "JRuby site":http://dist.codehaus.org/jruby/.
0
+
0
+After uncompressing JRuby, update your @PATH@ to include both @java@ and @jruby@
0
+executables.
0
+
0
+For Linux and OS/X:
0
+
0
+{{{!sh
0
+$ export PATH=$PATH:[path to JRuby]/bin:$JAVA_HOME/bin
0
+$ gem install buildr
0
+}}}
0
+
0
+For Windows:
0
+
0
+{{{!sh
0
+> set PATH=%PATH%;[path to JRuby]/bin;%JAVA_HOME%/bin
0
+> gem install buildr
0
+}}}
0
+
0
+To upgrade to a new version or install a specific version:
0
+
0
+{{{!sh
0
+$ sudo gem update buildr
0
+$ sudo gem install buildr -v 1.3.0
0
+}}}
0
+
0
+You can also use this script "to install Buildr on
0
+JRuby":scripts/install-jruby.sh. This script will install Buildr or if already
0
+installed, upgrade to a more recent version. If necessary, it will also
0
+install JRuby 1.1RC2 in @/opt/jruby@ and update the @PATH@ variable in
0
+@~/.bash_profile@ or @~/.profile@.
0
+
0
+*Important: Running JRuby and Ruby side by side*
0
+
0
+Ruby and JRuby maintain separate Gem repositories, and in fact install
0
+slightly different versions of the Buildr Gem (same functionality, different
0
+dependencies). Installing Buildr for Ruby does not install it for JRuby and
0
+vice versa.
0
+
0
+If you have JRuby installed but not Ruby, the @gem@ and @buildr@ commands will
0
+use JRuby. If you have both JRuby and Ruby installed, follow the instructions
0
+below. To find out if you have Ruby installed (some operating systems include
0
+it by default), run @ruby --version@ from the command line.
0
+
0
+To work exclusively with JRuby, make sure it shows first on the path, for example,
0
+by setting @PATH=/opt/jruby/bin:$PATH@.
0
+
0
+You can use JRuby and Ruby side by side, by running scripts with the @-S@
0
+command line argument. For example:
0
+
0
+{{{!
0
+$ # with Ruby
0
+$ ruby -S gem install buildr
0
+$ ruby -S buildr
0
+$ # with JRuby
0
+$ jruby -S gem install buildr
0
+$ jruby -S buildr
0
+}}}
0
+
0
+Run @buildr --version@ from the command line to find which version of Buildr
0
+you are using by default. If you see @(JRuby ...)@, Buildr is running on that
0
+version of JRuby.
0
+
0
+
0
 h2. Conventions
0
 
0
 Lines that start with @$@ are command lines, for example:
0
@@ -96,8 +291,10 @@
0
 
0
 h2. Help Tasks
0
 
0
-Buildr includes a number of informative tasks. Currently that number stands
0
-at two, but we'll be adding more tasks in future releases.
0
+Buildr includes a number of informative tasks. Currently that number stands at
0
+two, but we'll be adding more tasks in future releases. These tasks report
0
+information from the Buildfile, so you need one to run them. For more general
0
+help (version number, command line arguments, etc) use @buildr --help@.
0
 
0
 To start with, type:
0
 
...
27
28
29
30
31
 
 
 
 
32
33
34
35
36
37
...
38
39
40
41
42
43
 
 
 
44
45
46
47
48
49
50
51
52
53
54
 
 
 
 
 
 
 
55
56
 
 
 
...
27
28
29
 
30
31
32
33
34
35
36
37
38
39
40
...
41
42
43
 
44
 
45
46
47
48
49
50
 
 
 
 
 
 
 
 
51
52
53
54
55
56
57
58
 
59
60
61
0
@@ -27,8 +27,11 @@
0
 * Simple way to upgrade to new versions.
0
 * Did we mention fast?
0
 
0
-h4. Buildr 1.3
0
 
0
+h2. News
0
+
0
+Check out "all that's new in Buildr 1.3":whats_new.html.
0
+
0
 * Building Scala projects
0
 * Building Groovy projects
0
 * Running on JRuby
0
0
0
0
@@ -38,20 +41,22 @@
0
 * More documentation
0
 * Other features and bug fixes.
0
 
0
-Check out "what's new in Buildr 1.3":whats_new.html.
0
 
0
-p(tip). The Apache Software Foundation is a non-profit organization, consider
0
+h2. Notices
0
+
0
+The Apache Software Foundation is a non-profit organization, consider
0
 "sponsoring":http://www.apache.org/foundation/sponsorship.html and check the
0
 "thanks":http://www.apache.org/foundation/thanks.html page.
0
 
0
-p(note). Apache Buildr is an effort undergoing incubation at The Apache
0
-Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is
0
-required of all newly accepted projects until a further review indicates that
0
-the infrastructure, communications, and decision making process have stabilized
0
-in a manner consistent with other successful ASF projects. While incubation
0
-status is not necessarily a reflection of the completeness or stability of the
0
-code, it does indicate that the project has yet to be fully endorsed by the
0
-ASF.
0
+Apache Buildr is an effort undergoing incubation at The Apache Software
0
+Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of
0
+all newly accepted projects until a further review indicates that the
0
+infrastructure, communications, and decision making process have stabilized in
0
+a manner consistent with other successful ASF projects. While incubation status
0
+is not necessarily a reflection of the completeness or stability of the code,
0
+it does indicate that the project has yet to be fully endorsed by the ASF.
0
 
0
-"So let's get started":getting_started.html.
0
+"ColorCons":http://www.mouserunner.com/Spheres_ColoCons1_Free_Icons.html,
0
+copyright of Ken Saunders. "DejaVu fonts":http://dejavu.sourceforge.net,
0
+copyright of Bitstream, Inc.
...
14
15
16
17
 
18
19
20
...
14
15
16
 
17
18
19
20
0
@@ -14,7 +14,7 @@
0
 first, let's pick up a sample project to work with. We'll call it
0
 _killer-app_:
0
 
0
-{{{!ruby,lines
0
+{{{!ruby
0
 require 'buildr'
0
  
0
 VERSION_NUMBER = '1.0'
...
43
44
45
46
47
 
48
49
50
51
52
53
 
 
 
 
 
 
54
55
 
56
57
58
59
...
345
346
347
348
349
350
 
 
 
 
351
352
353
 
354
355
356
...
43
44
45
 
 
46
47
 
 
 
 
 
48
49
50
51
52
53
54
 
55
56
57
58
59
...
345
346
347
 
 
 
348
349
350
351
352
353
 
354
355
356
357
0
@@ -43,16 +43,16 @@
0
 @LogicTest@.
0
 
0
 There are benefits to running test cases in separate VMs. The default forking
0
-mode is @:once@, and you can change it by setting the @:fork@ option. It
0
-accepts the following values:
0
+mode is @:once@, and you can change it by setting the @:fork@ option.
0
 
0
-*@:once@* – Create one VM to run all test classes in the project, separate VMs
0
-for each project.
0
-*@:each@* – Create one VM for each test case class. Slow but provides the best
0
-isolation between test classes.
0
-*@false@* – Without forking, Buildr runs all test cases in a single VM. This
0
+|_. :fork=> |_. Behavior |
0
+| @:once@ | Create one VM to run all test classes in the project, separate
0
+VMs for each project. |
0
+| @:each@ | Create one VM for each test case class. Slow but provides the
0
+best isolation between test classes. |
0
+| @false@ | Without forking, Buildr runs all test cases in a single VM. This
0
 option runs fastest, but at the risk of running out of memory and causing test
0
-cases to interfere with each other.
0
+cases to interfere with each other. |
0
 
0
 You can see your tests running in the console, and if any tests fail, Buildr
0
 will show a list of the failed test classes. In addition, JUnit produces text
0
0
@@ -345,12 +345,13 @@
0
 
0
 Buildr provides the following matchers:
0
 
0
-*exist* – Given a file task checks that the file (or directory) exists.
0
-*empty* – Given a file task checks that the file (or directory) is empty.
0
-*contain* – Given a file task referencing a file, checks its contents, using
0
+|_. Method |_. Checks that ... |
0
+| @exist@ | Given a file task checks that the file (or directory) exists. |
0
+| @empty@ | Given a file task checks that the file (or directory) is empty. |
0
+| @contain@ | Given a file task referencing a file, checks its contents, using
0
 string or regular expression. For a file task referencing a directory, checks
0
 that it contains the specified files; global patterns using @*@ and @**@ are
0
-allowed.
0
+allowed. |
0
 
0
 All these matchers operate against a file task. If you run them against a
0
 ZipTask (including JAR, WAR, etc) they can also check the contents of the ZIP