Rake rdoc task.

This commit is contained in:
Jim Menard 2008-12-04 16:38:04 -05:00
parent abd65c5c94
commit bdc4f570d6
3 changed files with 14 additions and 1 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
doc

8
README
View File

@ -3,6 +3,10 @@
This is a simple pure-Ruby driver for the 10gen Mongo DB. For more information
about Mongo, see http://www.mongodb.org.
Note: this driver is still alpha quality. The API will change, as will the
data saved to the database (especially primary key values). Do *_not_* use this
for any production data.
= Demo
@ -26,7 +30,9 @@ http://github.com/geir/mongo-java-driver/tree/master.
== Release Notes
If you ran tests using code before relase
I plan to remove the auto-generation of _id primary keys.
If you ran tests using code before release
http://github.com/jimm/mongo-ruby-driver/commit/4244f56ce6c7044a1ce096843eb991856422c0cc
then the DB API tests might fail the first time you run it. If that doesn't
clear up the failed test, you might have to delete your database. To do that,

View File

@ -1,3 +1,4 @@
require 'fileutils'
require 'rake/testtask'
task :default => [:test]
@ -6,3 +7,8 @@ task :default => [:test]
Rake::TestTask.new do |t|
t.test_files = FileList['tests/test*.rb']
end
task :rdoc do
FileUtils.rm_rf('doc')
system "rdoc --main README README `find lib -name '*.rb'`"
end