diff options
Diffstat (limited to 'doc/files/EXAMPLES.html')
| -rw-r--r-- | doc/files/EXAMPLES.html | 268 |
1 files changed, 268 insertions, 0 deletions
diff --git a/doc/files/EXAMPLES.html b/doc/files/EXAMPLES.html new file mode 100644 index 0000000..ef92243 --- /dev/null +++ b/doc/files/EXAMPLES.html @@ -0,0 +1,268 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>File: EXAMPLES</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> + <meta http-equiv="Content-Script-Type" content="text/javascript" /> + <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> + <script type="text/javascript"> + // <![CDATA[ + + function popupCode( url ) { + window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") + } + + function toggleCode( id ) { + if ( document.getElementById ) + elem = document.getElementById( id ); + else if ( document.all ) + elem = eval( "document.all." + id ); + else + return false; + + elemStyle = elem.style; + + if ( elemStyle.display != "block" ) { + elemStyle.display = "block" + } else { + elemStyle.display = "none" + } + + return true; + } + + // Make codeblocks hidden by default + document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) + + // ]]> + </script> + +</head> +<body> + + + + <div id="fileHeader"> + <h1>EXAMPLES</h1> + <table class="header-table"> + <tr class="top-aligned-row"> + <td><strong>Path:</strong></td> + <td>EXAMPLES + </td> + </tr> + <tr class="top-aligned-row"> + <td><strong>Last Update:</strong></td> + <td>Sun Nov 11 17:51:57 PST 2007</td> + </tr> + </table> + </div> + <!-- banner header --> + + <div id="bodyContent"> + + + + <div id="contextContent"> + + <div id="description"> + <p> +require ‘git’ +</p> +<p> +# needs read permission only +</p> +<p> +g = <a href="../classes/Git.html#M000002">Git.open</a> (working_dir = +’.’) +</p> +<pre> + (git_dir, index_file) +</pre> +<p> +g.index g.index.readable? g.index.writable? g.repo g.dir +</p> +<p> +g.log # returns array of Git::Commit objects g.log.since(‘2 weeks +ago’) g.log.between(‘v2.5’, ‘v2.6’) +g.log.each {|l| puts l.sha } +g.gblob(‘v2.5:Makefile’).log.since(‘2 weeks ago’) +</p> +<p> +g.object(‘HEAD^’).to_s # git show / git rev-parse +g.object(‘HEAD^’).contents +g.object(‘v2.5:Makefile’).size +g.object(‘v2.5:Makefile’).sha +</p> +<p> +g.gtree(treeish) g.gblob(treeish) g.gcommit(treeish) +</p> +<p> +g.revparse(‘v2.5:Makefile’) +</p> +<p> +g.branches # returns <a href="../classes/Git/Branch.html">Git::Branch</a> +objects g.branches.local g.branches.remote g.branches[:master].gcommit +g.branches[‘origin/master’].gcommit +</p> +<p> +g.grep(‘hello’) # implies HEAD +g.blob(‘v2.5:Makefile’).grep(‘hello’) +g.tag(‘v2.5’).grep(‘hello’, ‘docs/’) +</p> +<p> +g.diff(commit1, commit2).size g.diff(commit1, commit2).stats +g.gtree(‘v2.5’).diff(‘v2.6’).insertions +g.diff(‘gitsearch1’, +‘v2.5’).path(‘lib/’) +g.diff(‘gitsearch1’, @git.gtree(‘v2.5’)) +g.diff(‘gitsearch1’, +‘v2.5’).path(‘docs/’).patch +g.gtree(‘v2.5’).diff(‘v2.6’).patch +</p> +<p> +g.gtree(‘v2.5’).diff(‘v2.6’).each do |file_diff| +</p> +<pre> + puts file_diff.path + puts file_diff.patch + puts file_diff.blob(:src).contents +</pre> +<p> +end +</p> +<p> +g.config(‘user.name’) # returns ‘Scott Chacon’ +g.config # returns whole config hash +</p> +<p> +g.tag # returns array of Git::Tag objects +</p> +<p> +# needs write permission +</p> +<p> +g = <a href="../classes/Git.html#M000003">Git.init</a> +</p> +<pre> + Git.init('project') + Git.init('/home/schacon/proj', + { :git_dir => '/opt/git/proj.git', + :index_file => '/tmp/index'} ) +</pre> +<p> +g = <a href="../classes/Git.html#M000004">Git.clone</a>(URI, :name => +‘name’, :path => ’/tmp/checkout‘ +</p> +<pre> + (git_dir, index_file) +</pre> +<p> +g.config(‘user.name’, ‘Scott Chacon’) +g.config(‘user.email’, ‘email@email.com’) +</p> +<p> +g.add(’.’) g.add([file1, file2]) +</p> +<p> +g.remove(‘file.txt’) g.remove([‘file.txt’, +‘file2.txt’]) +</p> +<p> +g.commit(‘message’) g.commit_all(‘message’) +</p> +<p> +g = <a href="../classes/Git.html#M000004">Git.clone</a>(repo, +‘myrepo’) Dir.chdir(‘myrepo’) do +</p> +<pre> + new_file('test-file', 'blahblahblah') + g.status.untracked.each do |file| + puts file.blob(:index).contents + end +</pre> +<p> +end +</p> +<p> +g.reset # defaults to HEAD g.reset_hard(Git::Commit) +</p> +<p> +g.branch(‘new_branch’) # creates new or fetches existing +g.branch(‘new_branch’).checkout +g.branch(‘new_branch’).delete +g.branch(‘existing_branch’).checkout +</p> +<p> +g.checkout(‘new_branch’) +g.checkout(g.branch(‘new_branch’)) +</p> +<p> +g.branch(name).merge(branch2) g.branch(branch2).merge # merges HEAD with +branch2 +</p> +<p> +g.branch(name).in_branch(message) { # add files } # auto-commits +g.merge(‘new_branch’) +g.merge(‘origin/remote_branch’) +g.merge(b.branch(‘master’)) g.merge([branch1, branch2]) +</p> +<p> +r = g.add_remote(name, uri) # <a +href="../classes/Git/Remote.html">Git::Remote</a> r = g.add_remote(name, <a +href="../classes/Git/Base.html">Git::Base</a>) # <a +href="../classes/Git/Remote.html">Git::Remote</a> +</p> +<p> +g.remotes # array of Git::Remotes g.remote(name).fetch +g.remote(name).remove g.remote(name).merge g.remote(name).merge(branch) +</p> +<p> +g.fetch g.fetch(g.remotes.first) +</p> +<p> +g.pull g.pull(Git::Repo, <a +href="../classes/Git/Branch.html">Git::Branch</a>) # fetch and a merge +</p> +<p> +g.add_tag(‘tag_name’) # returns Git::Tag +</p> +<p> +g.repack +</p> + + </div> + + + </div> + + + </div> + + + <!-- if includes --> + + <div id="section"> + + + + + + + + + <!-- if method_list --> + + + </div> + + +<div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> +</div> + +</body> +</html>
\ No newline at end of file |