summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorscott Chacon <schacon@agadorsparticus.corp.reactrix.com>2007-11-13 09:58:26 -0800
committerscott Chacon <schacon@agadorsparticus.corp.reactrix.com>2007-11-13 09:58:26 -0800
commitcbf72e3bfd1f62b35cc2db623be531f7f9c9275c (patch)
tree7751484dcc1f5100860c3af1c8cbfd4cb79f876c
parent38f009d6d0aa35b13d19575611db1c724a9d1a5b (diff)
downloadthird_party-ruby-git-cbf72e3bfd1f62b35cc2db623be531f7f9c9275c.tar.gz
third_party-ruby-git-cbf72e3bfd1f62b35cc2db623be531f7f9c9275c.tar.xz
third_party-ruby-git-cbf72e3bfd1f62b35cc2db623be531f7f9c9275c.zip
updated the TODO file with the stuff I'm working on next
-rw-r--r--README15
-rw-r--r--TODO23
-rw-r--r--doc/created.rid2
-rw-r--r--doc/files/README.html26
4 files changed, 55 insertions, 11 deletions
diff --git a/README b/README
index c10117d..908b8cf 100644
--- a/README
+++ b/README
@@ -32,13 +32,20 @@ Git::Diff - returns from a @git.diff command. It is an Enumerable that returns
Git::Diff:DiffFile objects from which you can get per file patches and insertion/deletion
statistics. You can also get total statistics from the Git::Diff object directly.
-Git::Status
+Git::Status - returns from a @git.status command. It is an Enumerable that returns
+Git:Status::StatusFile objects for each object in git, which includes files in the working
+directory, in the index and in the repository. Similar to running 'git status' on the command
+line to determine untracked and changed files.
-Git::Branches
+Git::Branches - Enumerable object that holds Git::Branch objects. You can call .local or .remote
+on it to filter to just your local or remote branches.
-Git::Remote
+Git::Remote - A reference to a remote repository that is tracked by this repository.
-Git::Log
+Git::Log - An Enumerable object that references all the Git::Object::Commit objects that encompass
+your log query, which can be constructed through methods on the Git::Log object, like:
+
+ @git.log(20).object("HEAD^").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] }
= Examples
diff --git a/TODO b/TODO
index 9ae76f5..0a63883 100644
--- a/TODO
+++ b/TODO
@@ -1,13 +1,34 @@
* more documentation
-* compatible with git 1.4
+
+* object.name (git name-rev)
* git archive
+* git revert, stash, rebase
+
+* more low level index actions
+ - (with_index), checkout-index, read-tree, write-tree, update-ref
+
+* submodule support
+
+* diff additions
+ - annotate, blame
+
+* repository admin
+ - prune, fsck, pack-refs, gc, count-objects, unpack-objects
+
+* email/patch integration
+ - request-pull(email_address), git-am, git-apply
+
+
+* compatible with git 1.4
+
* More Error Examples
* More Git::Status methods
+
* Speed up through pure ruby
* Speed up through C bindings to libgit-thin
diff --git a/doc/created.rid b/doc/created.rid
index f9d24d4..c9a65f9 100644
--- a/doc/created.rid
+++ b/doc/created.rid
@@ -1 +1 @@
-Tue Nov 13 07:35:28 PST 2007
+Tue Nov 13 08:54:42 PST 2007
diff --git a/doc/files/README.html b/doc/files/README.html
index 0832d66..69d8471 100644
--- a/doc/files/README.html
+++ b/doc/files/README.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Tue Nov 13 06:53:10 PST 2007</td>
+ <td>Tue Nov 13 08:54:36 PST 2007</td>
</tr>
</table>
</div>
@@ -117,17 +117,33 @@ also get total statistics from the <a
href="../classes/Git/Diff.html">Git::Diff</a> object directly.
</p>
<p>
-<a href="../classes/Git/Status.html">Git::Status</a>
+<a href="../classes/Git/Status.html">Git::Status</a> - returns from a
+@git.status command. It is an Enumerable that returns <a
+href="../classes/Git.html">Git</a>:Status::StatusFile objects for each
+object in git, which includes files in the working directory, in the index
+and in the repository. Similar to running &#8216;git status&#8217; on the
+command line to determine untracked and changed files.
</p>
<p>
-<a href="../classes/Git/Branches.html">Git::Branches</a>
+<a href="../classes/Git/Branches.html">Git::Branches</a> - Enumerable
+object that holds <a href="../classes/Git/Branch.html">Git::Branch</a>
+objects. You can call .local or .remote on it to filter to just your local
+or remote branches.
</p>
<p>
-<a href="../classes/Git/Remote.html">Git::Remote</a>
+<a href="../classes/Git/Remote.html">Git::Remote</a> - A reference to a
+remote repository that is tracked by this repository.
</p>
<p>
-<a href="../classes/Git/Log.html">Git::Log</a>
+<a href="../classes/Git/Log.html">Git::Log</a> - An Enumerable object that
+references all the <a
+href="../classes/Git/Object/Commit.html">Git::Object::Commit</a> objects
+that encompass your log query, which can be constructed through methods on
+the <a href="../classes/Git/Log.html">Git::Log</a> object, like:
</p>
+<pre>
+ @git.log(20).object(&quot;HEAD^&quot;).since(&quot;2 weeks ago&quot;).between('v2.6', 'v2.7').each { |commit| [block] }
+</pre>
<h1>Examples</h1>
<p>
Here are a bunch of examples of how to use the Ruby/<a