From bdc4f570d6e2edc67161ef4d04afd7fac10cbc18 Mon Sep 17 00:00:00 2001 From: Jim Menard Date: Thu, 4 Dec 2008 16:38:04 -0500 Subject: [PATCH] Rake rdoc task. --- .gitignore | 1 + README | 8 +++++++- Rakefile | 6 ++++++ 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8e695ec --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +doc diff --git a/README b/README index 7570a78..bb2092c 100644 --- a/README +++ b/README @@ -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, diff --git a/Rakefile b/Rakefile index 48e1df6..2b76e40 100644 --- a/Rakefile +++ b/Rakefile @@ -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