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/Base.html | 672 +++++++++++++++++++++++----------------------- 1 file changed, 336 insertions(+), 336 deletions(-) (limited to 'doc/classes/Git/Base.html') diff --git a/doc/classes/Git/Base.html b/doc/classes/Git/Base.html index d3dec3d..b643503 100644 --- a/doc/classes/Git/Base.html +++ b/doc/classes/Git/Base.html @@ -88,62 +88,62 @@

Methods

- add   - add_remote   - add_tag   - archive   - bare   - branch   - branches   - chdir   - checkout   - checkout_index   - clone   - commit   - commit_all   - commit_tree   - config   - current_branch   - diff   - dir   - fetch   - gblob   - gcommit   - grep   - gtree   - index   - init   - lib   - log   - ls_files   - merge   - new   - object   - open   - pull   - push   - read_tree   - remote   - remotes   - remove   - repack   - repo   - repo_size   - reset   - reset_hard   - revparse   - set_index   - set_working   - status   - tag   - tags   - update_ref   - with_index   - with_temp_index   - with_temp_working   - with_working   - write_and_commit_tree   - write_tree   + add   + add_remote   + add_tag   + archive   + bare   + branch   + branches   + chdir   + checkout   + checkout_index   + clone   + commit   + commit_all   + commit_tree   + config   + current_branch   + diff   + dir   + fetch   + gblob   + gcommit   + grep   + gtree   + index   + init   + lib   + log   + ls_files   + merge   + new   + object   + open   + pull   + push   + read_tree   + remote   + remotes   + remove   + repack   + repo   + repo_size   + reset   + reset_hard   + revparse   + set_index   + set_working   + status   + tag   + tags   + update_ref   + with_index   + with_temp_index   + with_temp_working   + with_working   + write_and_commit_tree   + write_tree  
@@ -165,11 +165,11 @@

Public Class methods

-
- +
+
- + bare(git_dir)
@@ -180,8 +180,8 @@ opens a bare Git Repository - no working directory options

[Source]

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

+ 
 # File lib/git/base.rb, line 12
     def self.bare(git_dir)
@@ -192,11 +192,11 @@ href="Repository.html">Repository - no working directory options
-
- +
+
- + clone(repository, name, opts = {})
@@ -221,8 +221,8 @@ options: :index_file

[Source]

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

+ 
 # File lib/git/base.rb, line 60
     def self.clone(repository, name, opts = {})
@@ -234,11 +234,11 @@ options:
-
- +
+
- + init(working_dir, opts = {})
@@ -255,8 +255,8 @@ options: :index_file

[Source]

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

+ 
 # File lib/git/base.rb, line 31
     def self.init(working_dir, opts = {})
@@ -279,19 +279,19 @@ options:
-
- +
+
- + new(options = {})

[Source]

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

+ 
 # File lib/git/base.rb, line 65
     def initialize(options = {})
@@ -309,11 +309,11 @@ options:
-
- +
+
- + open(working_dir, opts={})
@@ -324,8 +324,8 @@ opens a new Git Project from a working directory you can specify non-standard git_dir and index file in the options

[Source]

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

+ 
 # File lib/git/base.rb, line 18
     def self.open(working_dir, opts={})    
@@ -341,11 +341,11 @@ you can specify non-standard git_dir and index file in the options
 
       
Public Instance methods

 
-      

-        
+      

+        
 
         

-          
+          
           add(path = '.')
           
         

@@ -355,8 +355,8 @@ you can specify non-standard git_dir and index file in the options
 adds files from the working directory to the git repository
 

           
[Source]

-          

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

+          

 
 # File lib/git/base.rb, line 234
     def add(path = '.')
@@ -367,11 +367,11 @@ adds files from the working directory to the git repository
         

       

 
-      

-        
+      

+        
 
         

-          
+          
           add_remote(name, url, opts = {})
           
         

@@ -387,8 +387,8 @@ href="Base.html">Git::Base object if it’s a local reference
  @git.merge('scotts_git/master')

[Source]

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

+ 
 # File lib/git/base.rb, line 312
     def add_remote(name, url, opts = {})
@@ -403,11 +403,11 @@ href="Base.html">Git::Base object if it’s a local reference
-
- +
+
- + add_tag(tag_name)
@@ -417,8 +417,8 @@ href="Base.html">Git::Base object if it’s a local reference creates a new git tag (Git::Tag)

[Source]

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

+ 
 # File lib/git/base.rb, line 331
     def add_tag(tag_name)
@@ -430,11 +430,11 @@ creates a new git tag (Git::Tag)
-
- +
+
- + archive(treeish, file = nil, opts = {})
@@ -444,8 +444,8 @@ creates a new git tag (Git::Tag) creates an archive file of the given tree-ish

[Source]

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

+ 
 # File lib/git/base.rb, line 337
     def archive(treeish, file = nil, opts = {})
@@ -456,11 +456,11 @@ creates an archive file of the given tree-ish
-
- +
+
- + branch(branch_name = 'master')
@@ -470,8 +470,8 @@ creates an archive file of the given tree-ish returns a Git::Branch object for branch_name

[Source]

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

+ 
 # File lib/git/base.rb, line 189
     def branch(branch_name = 'master')
@@ -482,11 +482,11 @@ returns a Git::Branch object for branch_name
-
- +
+
- + branches()
@@ -497,8 +497,8 @@ returns a Git::Branches object of all the Git::Branch objects for this repo

[Source]

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

+ 
 # File lib/git/base.rb, line 184
     def branches
@@ -509,11 +509,11 @@ href="Branch.html">Git::Branch objects for this repo
-
- +
+
- + chdir() {|dir.path| ...}
@@ -533,8 +533,8 @@ example end

[Source]

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

+ 
 # File lib/git/base.rb, line 115
     def chdir
@@ -547,11 +547,11 @@ example
-
- +
+
- + checkout(branch = 'master', opts = {})
@@ -561,8 +561,8 @@ example checks out a branch as the new git working directory

[Source]

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

+ 
 # File lib/git/base.rb, line 268
     def checkout(branch = 'master', opts = {})
@@ -573,19 +573,19 @@ checks out a branch as the new git working directory
-
- +
+
- + checkout_index(opts = {})

[Source]

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

+ 
 # File lib/git/base.rb, line 364
     def checkout_index(opts = {})
@@ -596,11 +596,11 @@ checks out a branch as the new git working directory
-
- +
+
- + commit(message, opts = {})
@@ -610,8 +610,8 @@ checks out a branch as the new git working directory commits all pending changes in the index file to the git repository

[Source]

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

+ 
 # File lib/git/base.rb, line 255
     def commit(message, opts = {})
@@ -622,11 +622,11 @@ commits all pending changes in the index file to the git repository
-
- +
+
- + commit_all(message, opts = {})
@@ -638,8 +638,8 @@ automatically adds all modified files without having to explicitly calling @git.add() on them.

[Source]

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

+ 
 # File lib/git/base.rb, line 262
     def commit_all(message, opts = {})
@@ -651,19 +651,19 @@ automatically adds all modified files without having to explicitly calling
-
- +
+
- + commit_tree(tree = nil, opts = {})

[Source]

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

+ 
 # File lib/git/base.rb, line 376
     def commit_tree(tree = nil, opts = {})
@@ -674,11 +674,11 @@ automatically adds all modified files without having to explicitly calling
-
- +
+
- + config(name = nil, value = nil)
@@ -691,8 +691,8 @@ value g.config(‘user.name’) # returns ‘Scott Chacon’ g.config # returns whole config hash

[Source]

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

+ 
 # File lib/git/base.rb, line 134
     def config(name = nil, value = nil)
@@ -712,11 +712,11 @@ Chacon’ g.config # returns whole config hash
-
- +
+
- + current_branch()
@@ -726,8 +726,8 @@ Chacon’ g.config # returns whole config hash returns the name of the branch the working directory is currently on

[Source]

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

+ 
 # File lib/git/base.rb, line 425
     def current_branch
@@ -738,11 +738,11 @@ returns the name of the branch the working directory is currently on
-
- +
+
- + diff(objectish = 'HEAD', obj2 = nil)
@@ -752,8 +752,8 @@ returns the name of the branch the working directory is currently on returns a Git::Diff object

[Source]

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

+ 
 # File lib/git/base.rb, line 229
     def diff(objectish = 'HEAD', obj2 = nil)
@@ -764,11 +764,11 @@ returns a Git::Diff object
-
- +
+
- + dir()
@@ -782,8 +782,8 @@ returns a reference to the working directory @git.dir.writeable?

[Source]

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

+ 
 # File lib/git/base.rb, line 80
     def dir
@@ -794,11 +794,11 @@ returns a reference to the working directory
-
- +
+
- + fetch(remote = 'origin')
@@ -809,8 +809,8 @@ fetches changes from a remote branch - this does not modify the working directory, it just gets the changes from the remote if there are any

[Source]

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

+ 
 # File lib/git/base.rb, line 274
     def fetch(remote = 'origin')
@@ -821,19 +821,19 @@ directory, it just gets the changes from the remote if there are any
-
- +
+
- + gblob(objectish)

[Source]

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

+ 
 # File lib/git/base.rb, line 169
     def gblob(objectish)
@@ -844,19 +844,19 @@ directory, it just gets the changes from the remote if there are any
-
- +
+
- + gcommit(objectish)

[Source]

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

+ 
 # File lib/git/base.rb, line 165
     def gcommit(objectish)
@@ -867,11 +867,11 @@ directory, it just gets the changes from the remote if there are any
-
- +
+
- + grep(string)
@@ -906,8 +906,8 @@ so you might use it like this: end

[Source]

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

+ 
 # File lib/git/base.rb, line 224
     def grep(string)
@@ -918,19 +918,19 @@ so you might use it like this:
-
- +
+
- + gtree(objectish)

[Source]

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

+ 
 # File lib/git/base.rb, line 161
     def gtree(objectish)
@@ -941,11 +941,11 @@ so you might use it like this:
-
- +
+
- + index()
@@ -955,8 +955,8 @@ so you might use it like this: returns reference to the git index file

[Source]

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

+ 
 # File lib/git/base.rb, line 91
     def index
@@ -967,11 +967,11 @@ returns reference to the git index file
-
- +
+
- + lib()
@@ -984,8 +984,8 @@ replace the Git::Lib class with one that uses native methods or libgit C bindings

[Source]

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

+ 
 # File lib/git/base.rb, line 201
     def lib
@@ -996,11 +996,11 @@ methods or libgit C bindings
-
- +
+
- + log(count = 30)
@@ -1010,8 +1010,8 @@ methods or libgit C bindings returns a Git::Log object with count commits

[Source]

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

+ 
 # File lib/git/base.rb, line 174
     def log(count = 30)
@@ -1022,19 +1022,19 @@ returns a Git::Log object with count commits
-
- +
+
- + ls_files()

[Source]

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

+ 
 # File lib/git/base.rb, line 390
     def ls_files
@@ -1045,11 +1045,11 @@ returns a Git::Log object with count commits
-
- +
+
- + merge(branch, message = 'merge')
@@ -1063,8 +1063,8 @@ you can specify more than one branch to merge by passing an array of branches

[Source]

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

+ 
 # File lib/git/base.rb, line 290
     def merge(branch, message = 'merge')
@@ -1075,11 +1075,11 @@ branches
-
- +
+
- + object(objectish)
@@ -1097,8 +1097,8 @@ objectish and determine the type of the object and return an appropriate object for that type

[Source]

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

+ 
 # File lib/git/base.rb, line 157
     def object(objectish)
@@ -1109,11 +1109,11 @@ object for that type
-
- +
+
- + pull(remote = 'origin', branch = 'master', message = 'origin pull')
@@ -1124,8 +1124,8 @@ fetches a branch from a remote and merges it into the current working branch

[Source]

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

+ 
 # File lib/git/base.rb, line 295
     def pull(remote = 'origin', branch = 'master', message = 'origin pull')
@@ -1137,11 +1137,11 @@ branch
-
- +
+
- + push(remote = 'origin', branch = 'master')
@@ -1156,8 +1156,8 @@ setup the push parameters: @git.config('remote.remote-name.push', 'refs/heads/master:refs/heads/master')

[Source]

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

+ 
 # File lib/git/base.rb, line 283
     def push(remote = 'origin', branch = 'master')
@@ -1168,19 +1168,19 @@ setup the push parameters:
-
- +
+
- + read_tree(treeish, opts = {})

[Source]

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

+ 
 # File lib/git/base.rb, line 368
     def read_tree(treeish, opts = {})
@@ -1191,11 +1191,11 @@ setup the push parameters:
-
- +
+
- + remote(remote_name = 'origin')
@@ -1205,8 +1205,8 @@ setup the push parameters: returns a Git::Remote object

[Source]

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

+ 
 # File lib/git/base.rb, line 194
     def remote(remote_name = 'origin')
@@ -1217,11 +1217,11 @@ returns a Git::Remote object
-
- +
+
- + remotes()
@@ -1232,8 +1232,8 @@ returns an array of Git:Remote objects

[Source]

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

+ 
 # File lib/git/base.rb, line 301
     def remotes
@@ -1244,11 +1244,11 @@ href="Remote.html">Remote objects
-
- +
+
- + remove(path = '.', opts = {})
@@ -1258,8 +1258,8 @@ href="Remote.html">Remote objects removes file(s) from the git repository

[Source]

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

+ 
 # File lib/git/base.rb, line 239
     def remove(path = '.', opts = {})
@@ -1270,11 +1270,11 @@ removes file(s) from the git repository
-
- +
+
- + repack()
@@ -1284,8 +1284,8 @@ removes file(s) from the git repository repacks the repository

[Source]

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

+ 
 # File lib/git/base.rb, line 342
     def repack
@@ -1296,11 +1296,11 @@ repacks the repository
-
- +
+
- + repo()
@@ -1313,8 +1313,8 @@ returns reference to the git repository directory @git.dir.path

[Source]

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

+ 
 # File lib/git/base.rb, line 86
     def repo
@@ -1325,11 +1325,11 @@ returns reference to the git repository directory
-
- +
+
- + repo_size()
@@ -1339,8 +1339,8 @@ returns reference to the git repository directory returns the repository size in bytes

[Source]

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

+ 
 # File lib/git/base.rb, line 122
     def repo_size
@@ -1355,11 +1355,11 @@ returns the repository size in bytes
-
- +
+
- + reset(commitish = nil, opts = {})
@@ -1369,8 +1369,8 @@ returns the repository size in bytes resets the working directory to the provided commitish

[Source]

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

+ 
 # File lib/git/base.rb, line 244
     def reset(commitish = nil, opts = {})
@@ -1381,11 +1381,11 @@ resets the working directory to the provided commitish
-
- +
+
- + reset_hard(commitish = nil, opts = {})
@@ -1396,8 +1396,8 @@ resets the working directory to the commitish with ’—hard’

[Source]

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

+ 
 # File lib/git/base.rb, line 249
     def reset_hard(commitish = nil, opts = {})
@@ -1409,11 +1409,11 @@ resets the working directory to the commitish with
-
- +
+
- + revparse(objectish)
@@ -1428,8 +1428,8 @@ runs git rev-parse to convert the objectish to a full sha @git.revparse('v2.4:/doc/index.html')

[Source]

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

+ 
 # File lib/git/base.rb, line 420
     def revparse(objectish)
@@ -1440,19 +1440,19 @@ runs git rev-parse to convert the objectish to a full sha
-
- +
+
- + set_index(index_file, check = true)

[Source]

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

+ 
 # File lib/git/base.rb, line 101
     def set_index(index_file, check = true)
@@ -1464,19 +1464,19 @@ runs git rev-parse to convert the objectish to a full sha
-
- +
+
- + set_working(work_dir, check = true)

[Source]

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

+ 
 # File lib/git/base.rb, line 96
     def set_working(work_dir, check = true)
@@ -1488,11 +1488,11 @@ runs git rev-parse to convert the objectish to a full sha
-
- +
+
- + status()
@@ -1502,8 +1502,8 @@ runs git rev-parse to convert the objectish to a full sha returns a Git::Status object

[Source]

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

+ 
 # File lib/git/base.rb, line 179
     def status
@@ -1514,11 +1514,11 @@ returns a Git::Status object
-
- +
+
- + tag(tag_name)
@@ -1528,8 +1528,8 @@ returns a Git::Status object returns a Git::Tag object

[Source]

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

+ 
 # File lib/git/base.rb, line 326
     def tag(tag_name)
@@ -1540,11 +1540,11 @@ returns a Git::Tag object
-
- +
+
- + tags()
@@ -1554,8 +1554,8 @@ returns a Git::Tag object returns an array of all Git::Tag objects for this repository

[Source]

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

+ 
 # File lib/git/base.rb, line 321
     def tags
@@ -1566,19 +1566,19 @@ returns an array of all Git::Tag objects for this repository
-
- +
+
- + update_ref(branch, commit)

[Source]

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

+ 
 # File lib/git/base.rb, line 385
     def update_ref(branch, commit)
@@ -1589,11 +1589,11 @@ returns an array of all Git::Tag objects for this repository
-
- +
+
- + with_index(new_index) {|@index| ...}
@@ -1603,8 +1603,8 @@ returns an array of all Git::Tag objects for this repository LOWER LEVEL INDEX OPERATIONS ##

[Source]

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

+ 
 # File lib/git/base.rb, line 349
     def with_index(new_index)
@@ -1619,19 +1619,19 @@ LOWER LEVEL INDEX OPERATIONS ##
-
- +
+
- + with_temp_index(&blk)

[Source]

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

+ 
 # File lib/git/base.rb, line 357
     def with_temp_index &blk
@@ -1645,19 +1645,19 @@ LOWER LEVEL INDEX OPERATIONS ##
-
- +
+
- + with_temp_working(&blk)

[Source]

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

+ 
 # File lib/git/base.rb, line 405
     def with_temp_working &blk
@@ -1672,19 +1672,19 @@ LOWER LEVEL INDEX OPERATIONS ##
-
- +
+
- + with_working(work_dir) {|@working_directory| ...}

[Source]

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

+ 
 # File lib/git/base.rb, line 394
     def with_working(work_dir)
@@ -1702,19 +1702,19 @@ LOWER LEVEL INDEX OPERATIONS ##
-
- +
+
- + write_and_commit_tree(opts = {})

[Source]

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

+ 
 # File lib/git/base.rb, line 380
     def write_and_commit_tree(opts = {})
@@ -1726,19 +1726,19 @@ LOWER LEVEL INDEX OPERATIONS ##
-
- +
+
- + write_tree()

[Source]

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

+ 
 # File lib/git/base.rb, line 372
     def write_tree
-- 
cgit