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/AbstractObject.html | 182 ++++++++++++------------- doc/classes/Git/Object/Blob.html | 12 +- doc/classes/Git/Object/Commit.html | 205 ++++++++++++++++++----------- doc/classes/Git/Object/Tag.html | 14 +- doc/classes/Git/Object/Tree.html | 72 +++++----- 5 files changed, 271 insertions(+), 214 deletions(-) (limited to 'doc/classes/Git/Object') diff --git a/doc/classes/Git/Object/AbstractObject.html b/doc/classes/Git/Object/AbstractObject.html index 86529df..75cb746 100644 --- a/doc/classes/Git/Object/AbstractObject.html +++ b/doc/classes/Git/Object/AbstractObject.html @@ -86,21 +86,21 @@

Methods

- archive   - blob?   - commit?   - contents   - contents_array   - diff   - grep   - log   - new   - setup   - sha   - size   - tag?   - to_s   - tree?   + archive   + blob?   + commit?   + contents   + contents_array   + diff   + grep   + log   + new   + setup   + sha   + size   + tag?   + to_s   + tree?  
@@ -150,19 +150,19 @@

Public Class methods

-
- +
+
- + new(base, objectish)

[Source]

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

+ 
 # File lib/git/object.rb, line 17
       def initialize(base, objectish)
@@ -177,11 +177,11 @@
 
       
Public Instance methods

 
-      

-        
+      

+        
 
         

-          
+          
           archive(file = nil, opts = {})
           
         

@@ -191,8 +191,8 @@
 creates an archive of this object (tree)
 

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 63
       def archive(file = nil, opts = {})
@@ -203,19 +203,19 @@ creates an archive of this object (tree)
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           blob?()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 71
       def blob?
@@ -226,19 +226,19 @@ creates an archive of this object (tree)
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           commit?()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 75
       def commit?
@@ -249,11 +249,11 @@ creates an archive of this object (tree)
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           contents()
           
         

@@ -263,8 +263,8 @@ creates an archive of this object (tree)
 caches the contents of this call in memory
 

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 32
       def contents
@@ -275,19 +275,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           contents_array()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 36
       def contents_array
@@ -298,19 +298,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           diff(objectish)
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 54
       def diff(objectish)
@@ -321,19 +321,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           grep(string, path_limiter = nil, opts = {})
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 48
       def grep(string, path_limiter = nil, opts = {})
@@ -346,19 +346,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           log(count = 30)
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 58
       def log(count = 30)
@@ -369,19 +369,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           setup()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 40
       def setup
@@ -392,19 +392,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           sha()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 23
       def sha
@@ -415,19 +415,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           size()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 27
       def size
@@ -438,19 +438,19 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           tag?()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 79
      def tag?
@@ -461,42 +461,42 @@ caches the contents of this call in memory
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           to_s()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 44
       def to_s
-        sha
+        @objectish
       end
 

           

         

       

 
-      

-        
+      

+        
 
         

-          
+          
           tree?()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 67
       def tree?
diff --git a/doc/classes/Git/Object/Blob.html b/doc/classes/Git/Object/Blob.html
index bf1551a..763183f 100644
--- a/doc/classes/Git/Object/Blob.html
+++ b/doc/classes/Git/Object/Blob.html
@@ -88,7 +88,7 @@
       
Methods

 
       

-      new  
+      new  
       

     

 
@@ -110,19 +110,19 @@
     

       
Public Class methods

 
-      

-        
+      

+        
 
         

-          
+          
           new(base, sha, mode = nil)
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 88
       def initialize(base, sha, mode = nil)
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
+

+          

+        

+      

+
 
     

 
diff --git a/doc/classes/Git/Object/Tag.html b/doc/classes/Git/Object/Tag.html
index 309aa0f..8c9c275 100644
--- a/doc/classes/Git/Object/Tag.html
+++ b/doc/classes/Git/Object/Tag.html
@@ -88,7 +88,7 @@
       
Methods

 
       

-      new  
+      new  
       

     

 
@@ -123,21 +123,21 @@
     

       
Public Class methods

 
-      

-        
+      

+        
 
         

-          
+          
           new(base, sha, name)
           
         

       
         

           
[Source]

-          

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

+          

 
-# File lib/git/object.rb, line 226
+# File lib/git/object.rb, line 237
       def initialize(base, sha, name)
         super(base, sha)
         @name = name
diff --git a/doc/classes/Git/Object/Tree.html b/doc/classes/Git/Object/Tree.html
index d21bc9e..870df37 100644
--- a/doc/classes/Git/Object/Tree.html
+++ b/doc/classes/Git/Object/Tree.html
@@ -88,13 +88,13 @@
       
Methods

 
       

-      blobs  
-      children  
-      files  
-      new  
-      subdirectories  
-      subtrees  
-      trees  
+      blobs  
+      children  
+      files  
+      new  
+      subdirectories  
+      subtrees  
+      trees  
       

     

 
@@ -116,19 +116,19 @@
     

       
Public Class methods

 
-      

-        
+      

+        
 
         

-          
+          
           new(base, sha, mode = nil)
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 105
       def initialize(base, sha, mode = nil)
@@ -142,19 +142,19 @@
 
       
Public Instance methods

 
-      

-        
+      

+        
 
         

-          
+          
           blobs()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 114
       def blobs
@@ -166,19 +166,19 @@
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           children()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 110
       def children
@@ -189,8 +189,8 @@
         

       

 
-      

-        
+      

+        
 
         

           files()
@@ -198,13 +198,13 @@
       
         

           

-Alias for blobs
+Alias for blobs
 

         

       

 
-      

-        
+      

+        
 
         

           subdirectories()
@@ -212,13 +212,13 @@ Alias for blobs
       
         

           

-Alias for trees
+Alias for trees
 

         

       

 
-      

-        
+      

+        
 
         

           subtrees()
@@ -226,24 +226,24 @@ Alias for trees
       
         

           

-Alias for trees
+Alias for trees
 

         

       

 
-      

-        
+      

+        
 
         

-          
+          
           trees()
           
         

       
         

           
[Source]

-          

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

+          

 
 # File lib/git/object.rb, line 120
       def trees
-- 
cgit