public
Rubygem
Description: Apache Buildr
Homepage: http://incubator.apache.org/buildr
Clone URL: git://github.com/vic/buildr.git
Typo/Formatting fixes by Lacton

git-svn-id: https://svn.apache.org/repos/asf/incubator/buildr/trunk@628918 
13f79535-47bb-0310-9956-ffa450edef68
vic (author)
Mon Feb 18 15:23:10 -0800 2008
commit  2d659b46b6723c0dde48b362556613beb0f10575
tree    7bb87725f201ffe14eec97e599796ca0e0f60052
parent  300ea12ef3bd16f123318be0829b140230918230
...
22
23
24
25
 
26
27
28
...
103
104
105
106
 
107
108
109
...
22
23
24
 
25
26
27
28
...
103
104
105
 
106
107
108
109
0
@@ -22,7 +22,7 @@ group:id:type:classifier:version
0
 For example, @'org.apache.axis2:axis2:jar:1.2'@ refers to an artifact with
0
 group identifier org.apache.axis2, artifact identifier axis2, a JAR file with
0
 version 1.2. Classifiers are typically used to distinguish between similar
0
-file types, for example, a source distribution and binary distribution that
0
+file types, for example, a source distribution and a binary distribution that
0
 otherwise have the same identifier and are both ZIP files.
0
 
0
 
0
@@ -103,7 +103,7 @@ require '../shared/artifacts'
0
 }}}
0
 
0
 When you use @require@, Ruby always looks for a filename with the @.rb@
0
-extension, so in this case if expects to find @artifacts.rb@ in the @shared@
0
+extension, so in this case it expects to find @artifacts.rb@ in the @shared@
0
 directory.
0
 
0
 One last thing. You can also treat artifact specifications as hashes. For
...
128
129
130
131
 
132
133
134
...
128
129
130
 
131
132
133
134
0
@@ -128,7 +128,7 @@ We use method pairs to give you finer control over the compiler, but also a way
0
 to easily configure it. Methods like @dependencies@ and @sources@ give you a
0
 live array you can manipulate, or iterate over. On the other hand, methods
0
 like @with@ and @from@ accept a wider set of arguments and clean them up for
0
-you. The also all return the same task you're calling, so you can chain
0
+you. They also all return the same task you're calling, so you can chain
0
 methods together.
0
 
0
 For example:
...
20
21
22
23
 
24
25
26
...
111
112
113
114
 
115
116
117
...
20
21
22
 
23
24
25
26
...
111
112
113
 
114
115
116
117
0
@@ -20,7 +20,7 @@ developers working with Buildr, and the
0
 "buildr-dev":mailto:buildr-dev@incubator.apache.org mailing list
0
 ("subscribe":mailto:buildr-dev-subscribe@incubator.apache.org,
0
 "archive":http://mail-archives.apache.org/mod_mbox/incubator-buildr-dev/) for
0
-developement of Buildr itself. We also have a
0
+development of Buildr itself. We also have a
0
 "commits":mailto:buildr-commits@incubator.apache.org mailing list
0
 ("subscribe":mailto:buildr-commits-subscribe@incubator.apache.org) if you want to
0
 stalk us.
0
@@ -111,7 +111,7 @@ $ rake spec
0
 We always @rake spec@ before making a release.
0
 
0
 You can also check out the "RSpec report":report.html and "test coverage
0
-report":coverage/index.html for the current version of Buildr. And if you want to help us on the journey to 100% test coverage, we'll be ever so greatful!
0
+report":coverage/index.html for the current version of Buildr. And if you want to help us on the journey to 100% test coverage, we'll be ever so grateful!
0
 
0
 
0
 h2. Documentation
...
17
18
19
20
 
21
22
23
...
26
27
28
29
30
 
 
31
32
33
34
35
36
37
...
17
18
19
 
20
21
22
23
...
26
27
28
 
 
29
30
31
32
33
 
34
35
36
0
@@ -17,7 +17,7 @@ Compare this:
0
 
0
 {{{!ruby
0
 file('derby.sql') do
0
- requires = [
0
+ REQUIRES = [
0
     'org.apache.openjpa:openjpa-all:jar:0.9.7-incubating',
0
     'commons-collections:commons-collections:jar:3.1',
0
     . . .
0
@@ -26,12 +26,11 @@ file('derby.sql') do
0
     ant.taskdef :name=>'mapping',
0
       :classname=>'org.apache.openjpa.jdbc.ant.MappingToolTask',
0
       :classpath=>REQUIRES.join(File::PATH_SEPARATOR)
0
- ant.mapping :schemaAction=>'build', :sqlFile=>task.name,
0
- :ignoreErrors=>true do
0
+ ant.mapping :schemaAction=>'build', :sqlFile=>task.name,
0
+ :ignoreErrors=>true do
0
         ant.config :propertiesFile=>_(:source, :main, :sql, 'derby.xml')
0
         ant.classpath :path=>projects('store', 'utils' ).
0
           flatten.map(&:to_s).join(File::PATH_SEPARATOR)
0
- end
0
     end
0
   end
0
 end
...
140
141
142
143
 
144
145
146
...
140
141
142
 
143
144
145
146
0
@@ -140,7 +140,7 @@ dependencies into arrays and structures.
0
 
0
 You can use Ruby to perform ad hoc tasks. For example, Buildr doesn't have
0
 any pre-canned task for setting file permissions. But Ruby has a method for
0
-just, so it's just a matter of writing a task:
0
+that, so it's just a matter of writing a task:
0
 
0
 {{{!ruby
0
 bins = file('target/bin'=>FileList[_('src/main/dist/bin/*')]) do |task|
...
8
9
10
11
 
12
13
14
...
159
160
161
162
 
163
164
165
...
176
177
178
179
 
180
181
182
...
218
219
220
221
 
222
223
224
...
256
257
258
259
 
260
261
 
262
263
264
...
305
306
307
308
 
309
310
311
...
336
337
338
339
 
340
341
342
...
371
372
373
374
375
376
 
377
378
379
...
8
9
10
 
11
12
13
14
...
159
160
161
 
162
163
164
165
...
176
177
178
 
179
180
181
182
...
218
219
220
 
221
222
223
224
...
256
257
258
 
259
260
 
261
262
263
264
...
305
306
307
 
308
309
310
311
...
336
337
338
 
339
340
341
342
...
371
372
373
 
 
 
374
375
376
377
0
@@ -8,7 +8,7 @@ package :jar
0
 }}}
0
 
0
 We just told the project to create a JAR file in the @target@ directory,
0
-including all the classes (and resources) that we previously complied into
0
+including all the classes (and resources) that we previously compiled into
0
 @target/classes@. Or we can create a WAR file:
0
 
0
 {{{!ruby
0
@@ -159,7 +159,7 @@ use file pattern to match multiple files and directories. File patterns
0
 include asterisk (@*@) to match any file name or part of a file name, double
0
 asterisk (@**@) to match directories recursively, question mark (@?@) to match
0
 any character, square braces (@[]@) to match a set of characters, and curly
0
-braces (@{}@) to one of several names.
0
+braces (@{}@) to match one of several names.
0
 
0
 And the same way you @include@, you can also @exclude@ specific files you don't
0
 want showing up in the ZIP. For example, to exclude @.draft@ and @.raw@ files:
0
@@ -176,7 +176,7 @@ files under a given path using the @:path@ option:
0
 package(:zip).include 'target/docs', :path=>"#{id}-#{version}"
0
 }}}
0
 
0
-If you need to use the @:path@ option repeatedly, consider using the @path@
0
+If you need to use the @:path@ option repeatedly, consider using the @tap@
0
 method instead. For example:
0
 
0
 {{{!ruby
0
@@ -218,7 +218,7 @@ anything interesting. Your ZIP will come up empty. The second file includes
0
 the directory itself, but strips the path during inclusion. You can define it
0
 now, create these files later, and then ZIP them all up.
0
 
0
-For example, when @package :jar@ decides to include all the files form
0
+For example, when @package :jar@ decides to include all the files from
0
 @target/classes@, it's still working on the project definition, and has yet to
0
 compile anything. Since @target/classes@ may be empty, may not even exist, it
0
 uses @:as=>'.'@.
0
@@ -256,9 +256,9 @@ by default.
0
 
0
 The @services_xml@ attribute points to an Axis2 services configuration file
0
 called @services.xml@ that will be placed in the @META-INF@ directory inside
0
-the archive. the default behavior is to point to the @services.xml@ file in
0
+the archive. The default behavior is to point to the @services.xml@ file in
0
 the project's @src/main/axis2@ directory. In the second example above we set
0
-it explicitly,
0
+it explicitly.
0
 
0
 The @wsdls@ attribute is a collection of file names or glob patterns for WSDL
0
 files that get included in the @META-INF@ directory. In the second example we
0
@@ -305,7 +305,7 @@ package(:ear).add project('commonLib') # By default, the JAR package
0
 Adding a WAR package assumes it's a WAR component and treats it as such, but
0
 JAR packages can be any of three component types, so by default they are all
0
 treated as shared libraries. If you want to add an EJB or Application Client
0
-component, you need to say so explicitly, either passing @type=>package@, or by
0
+component, you need to say so explicitly, either passing @:type=>package@, or by
0
 passing the component type in the @:type@ option.
0
 
0
 Here are three examples:
0
@@ -336,7 +336,7 @@ package(:ear) << project('coolWebService').package(:war)
0
 }}}
0
 
0
 EAR packages include an @application.xml@ file in the @META-INF@ directory that
0
-describes the application and its component. This file is created for you
0
+describes the application and its components. This file is created for you
0
 during packaging, by referencing all the components added to the EAR. There
0
 are a couple of things you will typically want to change.
0
 
0
@@ -371,9 +371,7 @@ package(:tgz).include _('target/docs'), 'README'
0
 }}}
0
 
0
 The first line creates a Tar archive with the extension @.tar@, the second
0
-creates a GZipped Tar archive with the extension @.tgz@. The first creates a
0
-Tar archive with the extension @.tar@, the second creates a GZipped Tar archive
0
-with the extension @.tgz@.
0
+creates a GZipped Tar archive with the extension @.tgz@.
0
 
0
 In addition to packaging that includes the archive in the list of
0
 installed/released files, you can use the method @tar@ to create a @TarTask@.
...
10
11
12
13
 
14
15
16
...
95
96
97
98
 
99
100
101
...
143
144
145
146
147
 
 
148
149
150
...
181
182
183
184
 
 
 
 
185
186
187
...
10
11
12
 
13
14
15
16
...
95
96
97
 
98
99
100
101
...
143
144
145
 
 
146
147
148
149
150
...
181
182
183
 
184
185
186
187
188
189
190
0
@@ -10,7 +10,7 @@ The only thing you need to do is specify the parts that are specific to your
0
 project, like the classpath dependencies, whether you're packaging a JAR or a
0
 WAR, etc.
0
 
0
-The reminder of this guide deals with what it takes to build a project. But
0
+The remainder of this guide deals with what it takes to build a project. But
0
 first, let's pick up a sample project to work with. We'll call it
0
 _killer-app_:
0
 
0
@@ -95,7 +95,7 @@ will compile to @target/flash@. Throughout this document we will show examples
0
 using mostly Java, but you can imagine how this pattern applies to other
0
 languages.
0
 
0
-When projects grow big, you split them own into smaller projects by nesting
0
+When projects grow big, you split them into smaller projects by nesting
0
 projects inside each other. Each sub-project has a sub-directory under the
0
 parent project and follows the same internal directory structure. You can, of
0
 course, change all of that to suite your needs, but if you follow these
0
@@ -143,8 +143,8 @@ Notice the @buildfile@ at the top. That's your project build script, the one
0
 Buildr runs.
0
 
0
 When you run the @buildr@ command, it picks up the @buildfile@ (which here
0
-we'll just call _Buildfile_) from the current directory, or it not there, from
0
-the closest parent directory. So you can run @buildr@ form any directory
0
+we'll just call _Buildfile_) from the current directory, or if not there, from
0
+the closest parent directory. So you can run @buildr@ from any directory
0
 inside your project, and it will always pick up the same Buildfile. That also
0
 happens to be the base directory for the top project. If you have any
0
 sub-projects, Buildr assumes they reflect sub-directories under their parent.
0
@@ -181,7 +181,10 @@ or raise an error. You can also call it with no arguments and it will return
0
 the project itself. It's syntactic sugar that's useful when accessing project
0
 properties.
0
 
0
-The @projects@ method takes a list of names and returns a list of projects. If you call it with no arguments on a project, it returns all its sub-projects. If you call it with no argument in any other context, it returns all the projects defined so far.
0
+The @projects@ method takes a list of names and returns a list of projects. If
0
+you call it with no arguments on a project, it returns all its sub-projects.
0
+If you call it with no argument in any other context, it returns all the
0
+projects defined so far.
0
 
0
 Let's illustrate this with a few examples:
0
 

Comments

    No one has commented yet.