From bc60052b519b8b991e50b8ccb30f2b76ad125996 Mon Sep 17 00:00:00 2001 From: scott Chacon Date: Fri, 16 Nov 2007 13:24:30 -0800 Subject: updated the docs --- doc/classes/Git/Object/AbstractObject.html | 305 ++++++++++++++++++++++------- doc/classes/Git/Object/Blob.html | 14 +- doc/classes/Git/Object/Commit.html | 158 ++++++++------- doc/classes/Git/Object/Tag.html | 14 +- doc/classes/Git/Object/Tree.html | 80 ++++---- 5 files changed, 384 insertions(+), 187 deletions(-) (limited to 'doc/classes/Git/Object') diff --git a/doc/classes/Git/Object/AbstractObject.html b/doc/classes/Git/Object/AbstractObject.html index 222bc67..86529df 100644 --- a/doc/classes/Git/Object/AbstractObject.html +++ b/doc/classes/Git/Object/AbstractObject.html @@ -86,14 +86,21 @@

Methods

- contents   - contents_array   - diff   - grep   - log   - new   - setup   - to_s   + archive   + blob?   + commit?   + contents   + contents_array   + diff   + grep   + log   + new   + setup   + sha   + size   + tag?   + to_s   + tree?  
@@ -119,7 +126,7 @@ - sha + objectish  [RW]  @@ -143,25 +150,24 @@

Public Class methods

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

[Source]

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

+ 
-# File lib/git/object.rb, line 14
-      def initialize(base, sha)
+# File lib/git/object.rb, line 17
+      def initialize(base, objectish)
         @base = base
-        @sha = sha.to_s
-        @size = @base.lib.object_size(@sha)
+        @objectish = objectish.to_s
         setup
       end
@@ -171,44 +177,119 @@

Public Instance methods

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

+creates an archive of this object (tree) +

+

[Source]

+
+
+# File lib/git/object.rb, line 63
+      def archive(file = nil, opts = {})
+        @base.lib.archive(@objectish, file, opts)
+      end
+
+
+
+
+ +
+ + +
+ + blob?() + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 71
+      def blob?
+        @type == 'blob'
+      end
+
+
+
+
+ +
+ + +
+ + commit?() + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 75
+      def commit?
+        @type == 'commit'
+      end
+
+
+
+
+ +
+ + +
+ contents()
+

+caches the contents of this call in memory +

[Source]

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

+ 
-# File lib/git/object.rb, line 21
+# File lib/git/object.rb, line 32
       def contents
-        @base.lib.object_contents(@sha)
+        @contents || @contents = @base.lib.object_contents(@objectish)
       end
-
- +
+
- + contents_array()

[Source]

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

+ 
-# File lib/git/object.rb, line 25
+# File lib/git/object.rb, line 36
       def contents_array
         self.contents.split("\n")
       end
@@ -217,46 +298,46 @@
-
- +
+
- + diff(objectish)

[Source]

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

+ 
-# File lib/git/object.rb, line 43
+# File lib/git/object.rb, line 54
       def diff(objectish)
-        Git::Diff.new(@base, @sha, objectish)
+        Git::Diff.new(@base, @objectish, objectish)
       end
-
- +
+
- + grep(string, path_limiter = nil, opts = {})

[Source]

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

+ 
-# File lib/git/object.rb, line 37
+# File lib/git/object.rb, line 48
       def grep(string, path_limiter = nil, opts = {})
-        default = {:object => @sha, :path_limiter => path_limiter}
+        default = {:object => sha, :path_limiter => path_limiter}
         grep_options = default.merge(opts)
         @base.lib.grep(string, grep_options)
       end
@@ -265,44 +346,44 @@
-
- +
+
- + log(count = 30)

[Source]

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

+ 
-# File lib/git/object.rb, line 47
+# File lib/git/object.rb, line 58
       def log(count = 30)
-        Git::Log.new(@base, count).object(@sha)
+        Git::Log.new(@base, count).object(@objectish)
       end
-
- +
+
- + setup()

[Source]

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

+ 
-# File lib/git/object.rb, line 29
+# File lib/git/object.rb, line 40
       def setup
         raise NotImplementedError
       end
@@ -311,23 +392,115 @@
-
- +
+
- + + sha() + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 23
+      def sha
+        @sha || @sha = @base.lib.revparse(@objectish)
+      end
+
+
+
+
+ +
+ + +
+ + size() + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 27
+      def size
+        @size || @size = @base.lib.object_size(@objectish)
+      end
+
+
+
+
+ +
+ + +
+ + tag?() + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 79
+     def tag?
+       @type == 'tag'
+     end
+
+
+
+
+ +
+ + +
+ to_s()

[Source]

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

+ 
-# File lib/git/object.rb, line 33
+# File lib/git/object.rb, line 44
       def to_s
-        @sha
+        sha
+      end
+
+
+
+
+ +
+ + +
+ + tree?() + +
+ +
+

[Source]

+
+
+# File lib/git/object.rb, line 67
+      def tree?
+        @type == 'tree'
       end
diff --git a/doc/classes/Git/Object/Blob.html b/doc/classes/Git/Object/Blob.html index 453a324..bf1551a 100644 --- a/doc/classes/Git/Object/Blob.html +++ b/doc/classes/Git/Object/Blob.html @@ -88,7 +88,7 @@

Methods

- new   + new  
@@ -110,21 +110,21 @@

Public Class methods

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

[Source]

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

+ 
-# File lib/git/object.rb, line 56
+# File lib/git/object.rb, line 88
       def initialize(base, sha, mode = nil)
         super(base, sha)
         @mode = mode
diff --git a/doc/classes/Git/Object/Commit.html b/doc/classes/Git/Object/Commit.html
index 3be4f27..5e8e7bb 100644
--- a/doc/classes/Git/Object/Commit.html
+++ b/doc/classes/Git/Object/Commit.html
@@ -88,16 +88,17 @@
       
Methods

 
       

-      author  
-      author_date  
-      committer  
-      committer_date  
-      date  
-      diff_parent  
-      gtree  
-      message  
-      parent  
-      parents  
+      author  
+      author_date  
+      committer  
+      committer_date  
+      date  
+      diff_parent  
+      gtree  
+      message  
+      name  
+      parent  
+      parents  
@@ -119,11 +120,11 @@

Public Instance methods

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

[Source]

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

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

[Source]

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

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

[Source]

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

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

[Source]

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

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

-Alias for committer_date +Alias for committer_date

-
- +
+
- + diff_parent()

[Source]

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

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

[Source]

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

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

[Source]

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

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

[Source]

+
+
+# File lib/git/object.rb, line 159
+      def name
+        @base.lib.namerev(sha)
+      end
+
+
+
+
+ +
+
- + parent()

[Source]

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

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

[Source]

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

+ 
-# File lib/git/object.rb, line 137
+# File lib/git/object.rb, line 173
       def parents
         check_commit
         @parents        
diff --git a/doc/classes/Git/Object/Tag.html b/doc/classes/Git/Object/Tag.html
index 799baaa..309aa0f 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('M000176-source');return false;">[Source]

+ 
-# File lib/git/object.rb, line 190
+# File lib/git/object.rb, line 226
       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 72a8a61..d21bc9e 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,21 +116,21 @@

Public Class methods

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

[Source]

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

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

 
-      

-        
+      

+        
 
         

-          
+          
           blobs()
           
         

       
         

           
[Source]

-          

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

+          

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

       

 
-      

-        
+      

+        
 
         

-          
+          
           children()
           
         

       
         

           
[Source]

-          

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

+          

 
-# File lib/git/object.rb, line 78
+# File lib/git/object.rb, line 110
       def children
         blobs.merge(subtrees)
       end
@@ -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,26 +226,26 @@ Alias for trees
       
         

           

-Alias for trees
+Alias for trees
 

         

       

 
-      

-        
+      

+        
 
         

-          
+          
           trees()
           
         

       
         

           
[Source]

-          

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

+          

 
-# File lib/git/object.rb, line 88
+# File lib/git/object.rb, line 120
       def trees
         check_tree
         @trees
-- 
cgit