From 824ab0ec43a3c9306e75e87537f8e2b3bcc3254e Mon Sep 17 00:00:00 2001 From: scott Chacon Date: Mon, 19 Nov 2007 07:34:25 -0800 Subject: updated docs --- doc/classes/Git/Object/Commit.html | 205 ++++++++++++++++++++++++------------- 1 file changed, 131 insertions(+), 74 deletions(-) (limited to 'doc/classes/Git/Object/Commit.html') diff --git a/doc/classes/Git/Object/Commit.html b/doc/classes/Git/Object/Commit.html index 5e8e7bb..18ec570 100644 --- a/doc/classes/Git/Object/Commit.html +++ b/doc/classes/Git/Object/Commit.html @@ -88,17 +88,19 @@

Methods

- author   - author_date   - committer   - committer_date   - date   - diff_parent   - gtree   - message   - name   - parent   - parents   + author   + author_date   + committer   + committer_date   + date   + diff_parent   + gtree   + message   + name   + new   + parent   + parents   + set_commit  
@@ -118,13 +120,41 @@
+

Public Class methods

+ +
+ + +
+ + new(base, sha, init = nil) + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 154
+      def initialize(base, sha, init = nil)
+        super(base, sha)
+        if init
+          set_commit(init)
+        end
+      end
+
+
+
+
+

Public Instance methods

-
- +
+
- + author()
@@ -134,10 +164,10 @@ git author

[Source]

-
+ onclick="toggleCode('M000158-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 179
+# File lib/git/object.rb, line 186
       def author     
         check_commit
         @author
@@ -147,21 +177,21 @@ git author
-
- +
+
- + author_date()

[Source]

-
+ onclick="toggleCode('M000159-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 184
+# File lib/git/object.rb, line 191
       def author_date
         author.date
       end
@@ -170,11 +200,11 @@ git author
-
- +
+
- + committer()
@@ -184,10 +214,10 @@ git author git author

[Source]

-
+ onclick="toggleCode('M000160-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 189
+# File lib/git/object.rb, line 196
       def committer
         check_commit
         @committer
@@ -197,21 +227,21 @@ git author
-
- +
+
- + committer_date()

[Source]

-
+ onclick="toggleCode('M000161-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 194
+# File lib/git/object.rb, line 201
       def committer_date 
         committer.date
       end
@@ -220,8 +250,8 @@ git author
-
- +
+
date() @@ -229,26 +259,26 @@ git author

-Alias for committer_date +Alias for committer_date

-
- +
+
- + diff_parent()

[Source]

-
+ onclick="toggleCode('M000163-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 199
+# File lib/git/object.rb, line 206
       def diff_parent
         diff(parent)
       end
@@ -257,21 +287,21 @@ Alias for committer_date
-
- +
+
- + gtree()

[Source]

-
+ onclick="toggleCode('M000155-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 163
+# File lib/git/object.rb, line 170
       def gtree
         check_commit
         Tree.new(@base, @tree)
@@ -281,21 +311,21 @@ Alias for committer_date
-
- +
+
- + message()

[Source]

-
+ onclick="toggleCode('M000153-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 154
+# File lib/git/object.rb, line 161
       def message
         check_commit
         @message
@@ -305,21 +335,21 @@ Alias for committer_date
-
- +
+
- + name()

[Source]

-
+ onclick="toggleCode('M000154-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 159
+# File lib/git/object.rb, line 166
       def name
         @base.lib.namerev(sha)
       end
@@ -328,21 +358,21 @@ Alias for committer_date
-
- +
+
- + parent()

[Source]

-
+ onclick="toggleCode('M000156-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 168
+# File lib/git/object.rb, line 175
       def parent
         parents.first
       end
@@ -351,11 +381,11 @@ Alias for committer_date
-
- +
+
- + parents()
@@ -365,10 +395,10 @@ Alias for committer_date array of all parent commits

[Source]

-
+ onclick="toggleCode('M000157-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 173
+# File lib/git/object.rb, line 180
       def parents
         check_commit
         @parents        
@@ -378,6 +408,33 @@ array of all parent commits
+
+ + +
+ + set_commit(data) + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 210
+      def set_commit(data)
+        @committer = Git::Author.new(data['committer'])
+        @author = Git::Author.new(data['author'])
+        @tree = Tree.new(@base, data['tree'])
+        @parents = data['parent'].map{ |sha| Commit.new(@base, sha) }
+        @message = data['message'].chomp
+      end
+
+
+
+
+
-- cgit