You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildr.apache.org by as...@apache.org on 2008/07/26 02:07:12 UTC
svn commit: r679934 - in /incubator/buildr/trunk: doc/pages/building.textile
doc/pages/contributing.textile doc/pages/getting_started.textile
doc/pages/index.textile rakelib/apache.rake
Author: assaf
Date: Fri Jul 25 17:07:12 2008
New Revision: 679934
URL: http://svn.apache.org/viewvc?rev=679934&view=rev
Log:
Broke up sections in contributing page, so it's easier to find stuff from the ToC; added plug for using Git.
Added sub-section for using development builds.
Main page now links directly to getting started page and PDF.
Documented --prerequs command line option.
rake apache:snapshot now runs test cases before packaging.
Modified:
incubator/buildr/trunk/doc/pages/building.textile
incubator/buildr/trunk/doc/pages/contributing.textile
incubator/buildr/trunk/doc/pages/getting_started.textile
incubator/buildr/trunk/doc/pages/index.textile
incubator/buildr/trunk/rakelib/apache.rake
Modified: incubator/buildr/trunk/doc/pages/building.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/building.textile?rev=679934&r1=679933&r2=679934&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/building.textile (original)
+++ incubator/buildr/trunk/doc/pages/building.textile Fri Jul 25 17:07:12 2008
@@ -264,7 +264,7 @@
Before using the Groovy compiler, you must first require it on your buildfile:
{{{!ruby
- require 'buildr/java/groovyc'
+require 'buildr/java/groovyc'
}}}
Once loaded, the groovyc compiler will be automatically selected if any .groovy
Modified: incubator/buildr/trunk/doc/pages/contributing.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/contributing.textile?rev=679934&r1=679933&r2=679934&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/contributing.textile (original)
+++ incubator/buildr/trunk/doc/pages/contributing.textile Fri Jul 25 17:07:12 2008
@@ -3,8 +3,14 @@
Buildr is a community effort, and we welcome all contributors. Here's your
chance to get involved and help your fellow developers.
+h2. Getting involved
-h2. Mailing Lists
+All our discussions are done in the open, over "email":mailing_lists.html, and
+that would be the first place to look for answers, raise ideas, etc. For bug
+reports, issues and patches, "see below":#bugs_aka_issues.
+
+
+h3. Mailing Lists
We run two mailing lists, the
"buildr-user":http://mail-archives.apache.org/mod_mbox/incubator-buildr-user/
@@ -19,7 +25,7 @@
subscribing, searching and posting to the mailing list.
-h2. Bugs (aka Issues)
+h3. Bugs (aka Issues)
We really do try to keep bugs to a minimum, and anticipate everything you'll
ever want to do with Buildr. We're also, not perfect. So you may have found a
@@ -43,19 +49,34 @@
$ java --version
}}}
+
+h3. Contributing Code
+
+Yes, please.
+
If you have a patch to submit, do it through
"JIRA":http://issues.apache.org/jira/browse/Buildr. We want to make sure
Apache gets the right to use your contribution, and the JIRA upload form
includes a simple contribution agreement. Lawyer not included.
+If you want to work on a cool new feature, but not quite ready to submit a
+patch, there's still a way you can get the Buildr community involved. We're
+experimenting with using Git for that. You can use Git to maintain a fork
+of Buildr that can keep up with changes in the main branch (tip: use
+@git rebase@), while developing your own changes/features on it.
+
+That way you can get other people involved, checking out the code, and
+eventually merge it back with the main branch. Check out the
+"Git section":#Git below.
-h2. Source Code
+
+h2. Living on the edge
Did we mention Buildr is an open source project? In fact, when you install
Buildr you get all the source code, documentation, test case and everything you
need to use it, extend it and patch it. Have a look in your Gem directory.
-h4. Using SVN
+h3. SVN
But if you want to work with the latest and greatest, you'll want to check out
"Buildr from SVN":http://svn.apache.org/repos/asf/incubator/buildr:
@@ -67,7 +88,7 @@
You can also browse the "Buildr
repository":http://svn.apache.org/repos/asf/incubator/buildr.
-h4. Using Git
+h3. Git
Not a fan SVN? We understand. You can also grab a copy of "Buildr from
GitHub":http://github.com/vic/buildr/tree/master:
@@ -87,10 +108,10 @@
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 handy at
+sheet":http://ktown.kde.org/~zrusin/git/git-cheat-sheet-medium.png close at
hand. Very useful.
-h4. Installing from Source
+h3. Installing from Source
To install Buildr from the source directory:
@@ -107,7 +128,33 @@
}}}
-h2. Testing/Specs
+h3. Using development build
+
+Occasionally we'll make development builds from the current code in trunk/head.
+We appreciate if you can take the time to test those out and report any bugs.
+To install development builds, use the Gem repository at
+@people.apache.org/~assaf/buildr/snapshot@:
+
+{{{!sh
+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.
+
+If you want to go back to using the RubyForge releases:
+
+{{{!sh
+gem source --remove http://people.apache.org/~assaf/buildr/snapshot
+gem install buildr
+}}}
+
+
+h2. Tested and Documented
+
+Two things we definitely encourage!
+
+h3. Testing/Specs
Obviously we won't turn down patches, but we'll love you even more if you
include a test case. One that will fail without the patch, and run
@@ -139,7 +186,7 @@
official specification against which we test each release.
-h2. Documentation
+h3. Documentation
Yes, we do make typos, spelling errors and sometimes we write things that don't
make sense, so if you find a documentation bug, or want to help make the
Modified: incubator/buildr/trunk/doc/pages/getting_started.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/getting_started.textile?rev=679934&r1=679933&r2=679934&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/getting_started.textile (original)
+++ incubator/buildr/trunk/doc/pages/getting_started.textile Fri Jul 25 17:07:12 2008
@@ -264,6 +264,7 @@
| @-r/--require [file]@ | Require MODULE before executing buildfile. |
| @-t/--trace@ | Turn on invoke/execute tracing, enable full backtrace. |
| @-v/--version@ | Display the program version. |
+| @-P/--prereqs@ | Display tasks and dependencies, then exit. |
You can tell Buildr to run specific tasks and the order to run them. For
example:
Modified: incubator/buildr/trunk/doc/pages/index.textile
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/index.textile?rev=679934&r1=679933&r2=679934&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/index.textile (original)
+++ incubator/buildr/trunk/doc/pages/index.textile Fri Jul 25 17:07:12 2008
@@ -1,5 +1,7 @@
h1. Welcome
+h2. What is Buildr?
+
Buildr is a build system for Java applications. We wanted something that's
simple and intuitive to use, so we only need to tell it what to do, and it
takes care of the rest. But also something we can easily extend for those
@@ -27,6 +29,9 @@
* Simple way to upgrade to new versions.
* Did we mention fast?
+So let's get started. You can "read the documentation
+online":getting_started.html, or "download the PDF":buildr.pdf.
+
h2. News
Modified: incubator/buildr/trunk/rakelib/apache.rake
URL: http://svn.apache.org/viewvc/incubator/buildr/trunk/rakelib/apache.rake?rev=679934&r1=679933&r2=679934&view=diff
==============================================================================
--- incubator/buildr/trunk/rakelib/apache.rake (original)
+++ incubator/buildr/trunk/rakelib/apache.rake Fri Jul 25 17:07:12 2008
@@ -22,7 +22,7 @@
namespace 'apache' do
desc 'Upload snapshot packages over to people.apache.org'
- task 'snapshot'=>'package' do
+ task 'snapshot'=>['spec', 'package'] do
rm_rf 'snapshot' # Always start with empty directory
puts "Copying existing gems from Apache"
sh 'rsync', '--progress', '--recursive', 'people.apache.org:public_html/buildr/snapshot', './'