Skip to content

Commit cbf72e3

Browse files
author
scott Chacon
committed
updated the TODO file with the stuff I'm working on next
1 parent 38f009d commit cbf72e3

File tree

4 files changed

+55
-11
lines changed

4 files changed

+55
-11
lines changed

README

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,20 @@ Git::Diff - returns from a @git.diff command. It is an Enumerable that returns
3232
Git::Diff:DiffFile objects from which you can get per file patches and insertion/deletion
3333
statistics. You can also get total statistics from the Git::Diff object directly.
3434

35-
Git::Status
35+
Git::Status - returns from a @git.status command. It is an Enumerable that returns
36+
Git:Status::StatusFile objects for each object in git, which includes files in the working
37+
directory, in the index and in the repository. Similar to running 'git status' on the command
38+
line to determine untracked and changed files.
3639

37-
Git::Branches
40+
Git::Branches - Enumerable object that holds Git::Branch objects. You can call .local or .remote
41+
on it to filter to just your local or remote branches.
3842

39-
Git::Remote
43+
Git::Remote - A reference to a remote repository that is tracked by this repository.
4044

41-
Git::Log
45+
Git::Log - An Enumerable object that references all the Git::Object::Commit objects that encompass
46+
your log query, which can be constructed through methods on the Git::Log object, like:
47+
48+
@git.log(20).object("HEAD^").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] }
4249

4350

4451
= Examples

TODO

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,34 @@
11
* more documentation
22

3-
* compatible with git 1.4
3+
4+
* object.name (git name-rev)
45

56
* git archive
67

8+
* git revert, stash, rebase
9+
10+
* more low level index actions
11+
- (with_index), checkout-index, read-tree, write-tree, update-ref
12+
13+
* submodule support
14+
15+
* diff additions
16+
- annotate, blame
17+
18+
* repository admin
19+
- prune, fsck, pack-refs, gc, count-objects, unpack-objects
20+
21+
* email/patch integration
22+
- request-pull(email_address), git-am, git-apply
23+
24+
25+
* compatible with git 1.4
26+
727
* More Error Examples
828

929
* More Git::Status methods
1030

31+
1132
* Speed up through pure ruby
1233

1334
* Speed up through C bindings to libgit-thin

doc/created.rid

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Tue Nov 13 07:35:28 PST 2007
1+
Tue Nov 13 08:54:42 PST 2007

doc/files/README.html

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h1>README</h1>
5656
</tr>
5757
<tr class="top-aligned-row">
5858
<td><strong>Last Update:</strong></td>
59-
<td>Tue Nov 13 06:53:10 PST 2007</td>
59+
<td>Tue Nov 13 08:54:36 PST 2007</td>
6060
</tr>
6161
</table>
6262
</div>
@@ -117,17 +117,33 @@ <h1>Major Objects</h1>
117117
href="../classes/Git/Diff.html">Git::Diff</a> object directly.
118118
</p>
119119
<p>
120-
<a href="../classes/Git/Status.html">Git::Status</a>
120+
<a href="../classes/Git/Status.html">Git::Status</a> - returns from a
121+
@git.status command. It is an Enumerable that returns <a
122+
href="../classes/Git.html">Git</a>:Status::StatusFile objects for each
123+
object in git, which includes files in the working directory, in the index
124+
and in the repository. Similar to running &#8216;git status&#8217; on the
125+
command line to determine untracked and changed files.
121126
</p>
122127
<p>
123-
<a href="../classes/Git/Branches.html">Git::Branches</a>
128+
<a href="../classes/Git/Branches.html">Git::Branches</a> - Enumerable
129+
object that holds <a href="../classes/Git/Branch.html">Git::Branch</a>
130+
objects. You can call .local or .remote on it to filter to just your local
131+
or remote branches.
124132
</p>
125133
<p>
126-
<a href="../classes/Git/Remote.html">Git::Remote</a>
134+
<a href="../classes/Git/Remote.html">Git::Remote</a> - A reference to a
135+
remote repository that is tracked by this repository.
127136
</p>
128137
<p>
129-
<a href="../classes/Git/Log.html">Git::Log</a>
138+
<a href="../classes/Git/Log.html">Git::Log</a> - An Enumerable object that
139+
references all the <a
140+
href="../classes/Git/Object/Commit.html">Git::Object::Commit</a> objects
141+
that encompass your log query, which can be constructed through methods on
142+
the <a href="../classes/Git/Log.html">Git::Log</a> object, like:
130143
</p>
144+
<pre>
145+
@git.log(20).object(&quot;HEAD^&quot;).since(&quot;2 weeks ago&quot;).between('v2.6', 'v2.7').each { |commit| [block] }
146+
</pre>
131147
<h1>Examples</h1>
132148
<p>
133149
Here are a bunch of examples of how to use the Ruby/<a

0 commit comments

Comments
 (0)