From 38f009d6d0aa35b13d19575611db1c724a9d1a5b Mon Sep 17 00:00:00 2001 From: scott Chacon Date: Tue, 13 Nov 2007 07:36:50 -0800 Subject: updated a bunch of the documentation --- doc/classes/Git.html | 93 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 87 insertions(+), 6 deletions(-) (limited to 'doc/classes/Git.html') diff --git a/doc/classes/Git.html b/doc/classes/Git.html index 2fdebb8..523491f 100644 --- a/doc/classes/Git.html +++ b/doc/classes/Git.html @@ -55,6 +55,10 @@ In: + + lib/git/author.rb + +
lib/git/base.rb @@ -124,6 +128,31 @@
+
+

+Git/Ruby Library +

+

+This provides bindings for working with git in complex interactions, +including branching and merging, object inspection and manipulation, +history, patch generation and more. You should be able to do most +fundamental git operations with this library. +

+

+This module provides the basic functions to open a git reference to work +with. You can open a working directory, open a bare repository, initialize +a new repo or clone an existing remote repository. +

+ + + +
Author:Scott Chacon (schacon@gmail.com) + +
License:MIT License + +
+ +
@@ -149,7 +178,8 @@

Classes and Modules

- Class Git::Base
+ Class Git::Author
+Class Git::Base
Class Git::Branch
Class Git::Branches
Class Git::Diff
@@ -175,7 +205,7 @@ Class Git::WorkingDirectory VERSION = - '1.0.1' + '1.0.2'
@@ -200,11 +230,19 @@ Class Git::WorkingDirectory
+

+open a bare repository +

+

+this takes the path to a bare git repo it expects not to be able to use a +working directory so you can’t checkout stuff, commit things, etc. +but you can do most read operations +

[Source]

-# File lib/git.rb, line 36
+# File lib/git.rb, line 51
   def self.bare(git_dir)
     Base.bare(git_dir)
   end
@@ -223,11 +261,28 @@ Class Git::WorkingDirectory
+

+clones a remote repository +

+

+options +

+
+  :bare => true (does a bare clone)
+  :repository => '/path/to/alt_git_dir'
+  :index => '/path/to/alt_index_file'
+
+

+example +

+
+ Git.clone('git://repo.or.cz/rubygit.git', 'clone.git', :bare => true)
+

[Source]

-# File lib/git.rb, line 48
+# File lib/git.rb, line 88
   def self.clone(repository, name, options = {})
     Base.clone(repository, name, options)
   end
@@ -246,11 +301,21 @@ Class Git::WorkingDirectory
+

+initialize a new git repository, defaults to the current working directory +

+

+options +

+
+  :repository => '/path/to/alt_git_dir'
+  :index => '/path/to/alt_index_file'
+

[Source]

-# File lib/git.rb, line 44
+# File lib/git.rb, line 74
   def self.init(working_dir = '.', options = {})
     Base.init(working_dir, options)
   end
@@ -269,11 +334,27 @@ Class Git::WorkingDirectory
+

+open an existing git working directory +

+

+this will most likely be the most common way to create a git reference, +referring to a working directory. if not provided in the options, the +library will assume your git_dir and index are in the default place (.git/, +.git/index) +

+

+options +

+
+  :repository => '/path/to/alt_git_dir'
+  :index => '/path/to/alt_index_file'
+

[Source]

-# File lib/git.rb, line 40
+# File lib/git.rb, line 65
   def self.open(working_dir, options = {})
     Base.open(working_dir, options)
   end
-- 
cgit