From eqqon

(Difference between revisions)

Jump to: navigation, search

Latest revision as of 20:44, 26 May 2011

Download the latest binary release.

Releases

Documentation

GitSharp online API documentation
/Examples ... a collection of code samples demonstrating the intuitive API.
/Compatibility of git# with respect to original git, .NET and Mono
/Dependencies ... a list of included open source components and tools
/Contributing to gitsharp. Everything you need to know to get started.

Developer Docs

File:Git Index Diagrams by Rolenun.pdf (Beware: IE may freeze)

What is Git?

Git is a free & open source, distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git was initially designed and developed by Linus Torvalds for Linux kernel development.

Every Git clone is a full-fledged repository with complete history and full revision tracking capabilities, not dependent on network access or a central server. Branching and merging are fast and easy to do.

Git is used for version control of files, much like tools such as Mercurial, Bazaar, Subversion, CVS, Perforce, and Visual SourceSafe.

Git's key characteristics make it stand out against the other SCM tools:

Strong and efficient support for non-linear development
Distributed development
Multiple protocol support such as HTTP, FTP, ssh, rsync, etc.
Efficient handling of large projects
Pluggable merge strategy

Popularity

According to a survey by the git community it is rapidly gaining more users. A graph of the survey results clearly demonstrates the trend.

(borrowed from Mauricio Scheffer)

News

October 28th: gitsharp 0.2 released.
October 11th: gitsharp 0.1.3 released.
October 8th: gitsharp 0.1.2 tagged.
September 26th: First release (version 0.1.0).
September 22th: We got a collaboration space where you can see the porting progress and who is working on what.
September 19th: Rolenun significantly improved the command line interface. Caytchen implemented the Commands "git init" and "git clone".
August 25th, 2009: Jim Radford added git# at his TeamCity integration server. We now have automatic builds on both, Windows and Mono. Since the other TeamCity account does not support Mono it can now be viewed as a code mirror ;)
August 15th, 2009: Dan Rigby created the IRC channel #GitSharp on freenode. It's a nice place to chat a little or ask questions about git.
July 2nd, 2009: Mauricio Scheffer has set up git# on the build and integration service teamcity.codebetter.com
July 1st, 2009: Writing of blobs, trees and commits works
June 15th, 2009: Reading of commit history, trees, blobs and tags works. See the demo browser screenshot below.

Public Echo

Most recent first:

GitSharp - Git for .NET and Mono

... a native Windows version of the fast & free open source version control system

GitSharp is an implementation of Git for the Dot.Net Framework and Mono. It is aimed to be fully compatible to the original Git and shall be a light weight library for cool applications that are based on Git as their object database or are reading or manipulating repositories in some way.

Status of the Project

GitSharp is a quite usable and stable library used by several projects to interact with git repositories. To get an idea check out the Demo (see below)! GitSharp development is currently on hold because we believe that the libgit2 project and its C# bindings libgit2sharp are far more promising to work on.

Modules

GitSharp.Core - a manual line by line port of jgit (outdated)
GitSharp.CLI (git.exe) - quite incomplete
GitSharp - a user friendly api designed to be easier to use and learn than GitSharp.Core

Projects using GitSharp

Bonobo Git Server

Jakub Chodounský created Bonobo Git Server for Windows (Git application server hosted on IIS with many features - based on the gitsharp library.

GitSharp.Demo

GitSharp.Demo is a small repository browser project that demonstrates the use of the GitSharp library and the user oriented API.

The source demonstrates how easy it is to ...

open and interact with a git repository
iterate over the file-tree of a specific revision
get the contents of a single file of a specific revision
get the changes between two commits
display a modification as text diff

TicGit.net

TicGit.net a small distributed issue tracker that uses git to keep track of tickets. It demonstrates the use of gitsharp's commiting API. TicGit is a toy project inspired by Scott Chacon's ruby application "ticgit".

License

Git# is derived from the Java library jgit and is released under the same BSD license as jgit.

Please refer to the LICENSE.txt files for the complete license, and please refer to the individual source file header to determine which license covers it and who contributed and therefor holds copyrights to the files.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Git Development Community nor the GitSharp Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Thanks and Credits

Thanks to all the kind people who contributed in one way or another. These are the credits:

Dave Cameron: for fixing bugs
Björn Carlson (hackerbaloo): for killing bugs that crept into the core
Emeric Fermas (nulltoken): for eliminating some of the hardest to find bugs and for verifying the complete test suite against jgit
Martinho Fernandes (eue): for fixing bugs
Andriano Machado (ammachado): for porting massive amounts of code and tests, also fixing many bugs
Jim Radford: for the continuous integration server account and the support
Gil Ran: for porting and fixing lots of tests and initial efforts on Mono
Meinrad Recheis (henon): I started this project and put all my effort into having it take off
Dan Rigby: for setting up the #GitSharp irc channel as well as porting and fixing tests
rolenun: for the command line interface framework. hey, what is your real name?
Stefan Schake (caytchen): for porting huge parts of the transport layer, and hunting down nasty bugs.
Mauricio Scheffer (mausch): for the testing and build server expertise and CI server trouble shooting
Neil Stalker (nestalk): for caring much about gitsharp's Mono compatibility and squashing bugs
Kevin Thompson: for initially porting large amounts of code and letting me rise the baby

Furthermore, much appreciation and thanks to ...

Linus Torvalds and the git community for creating and maintaining it.
Shawn O. Pearce and the jgit/egit community. Git# is based on their excellent work.

--Henon 22:45, 13 October 2009 (CEST)

Links

@@ Line 2: / Line 2: @@
 [[Category:CSharp]]
 <div style="float:right;margin:10px;">
-<div style="width:400px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
+<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
 [[Image:Gitsharp.png|150px|right]]
-'''[http://cloud.github.com/downloads/henon/GitSharp/GitSharp-0.2.0.0.9eed72f6274a2ba09c492f041fbec9f7f1217b5d-release-net-3.5.zip Download]''' the latest binary release.
+'''[http://github.com/downloads/henon/GitSharp/GitSharp-0.3.0.056f5345c8835fabc1a8f90548a9c5b0abdf9a68-release-net-3.5.zip Download]''' the latest binary release.
 === Releases ===
+* [[/v0.3.0| GitSharp 0.3]]
 * [[/v0.2.0| GitSharp 0.2]]
 * [[/v0.1.3| GitSharp 0.1.3]]
@@ Line 11: / Line 12: @@
 </div>
-<div style="width:400px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
+<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
 === Documentation ===
-* [[/Examples]] is a collection of code samples demonstrating the intuitive API.
+* [http://henon.github.com/GitSharp/ GitSharp online API documentation]
+* [[/Examples]] ... a collection of code samples demonstrating the intuitive API.
 * [[/Compatibility]] of git# with respect to original git, .NET and Mono
 * [[/Dependencies]] ... a list of included open source components and tools
 * [[/Contributing]] to gitsharp. Everything you need to know to get started.
+;Developer Docs
+* [[Image:Git_Index_Diagrams_by_Rolenun.pdf|Git Index Diagrams]] <small>(Beware: IE may freeze)</small>
 </div>
 <div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
@@ Line 39: / Line 46: @@
 '''Popularity'''
-According to [http://git.or.cz/gitwiki/GitSurvey2008 a survey by the git community] it is rapidly gaining more users. This is a graph of the survey results :<br>
+According to [http://git.or.cz/gitwiki/GitSurvey2008 a survey by the git community] it is rapidly gaining more users. A graph of the survey results clearly demonstrates the trend.
 [[Image:Git survey responses (1) thumb-2-.png]]<br>
 <small>(borrowed from [http://bugsquash.blogspot.com/ Mauricio Scheffer])</small>
 </div>
-<div style="width:400px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
+<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
 === News ===
@@ Line 60: / Line 70: @@
 </div>
-<div style="width:400px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
+<div style="width:300px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
 === Public Echo ===
 Most recent first:
+* [http://www.chodounsky.net/bonobo-git-server/bonobo-git-serverscreenshots/ Jakub Chodounsky created Bonobo Git Server]
+* [https://build.opensuse.org/package/show?package=gitsharp&project=home:nestalk Nestalk packaged gitsharp for Suse]
+* [http://www.h-online.com/open/news/item/MonoDevelop-2-4-released-1024208.html MonoDevelop determined to build on GitSharp for git support]
 * [http://bugsquash.blogspot.com/2009/10/git-filter-branch-with-gitsharp.html Mauricio Scheffer shows how to use GitSharp for correcting history]
 * [http://www.linux.org.ru/view-message.jsp?msgid=4130789 Russian Linux magazine reports release of GitSharp] (Russian)
@@ Line 76: / Line 89: @@
 </div>
-<div style="width:400px;margin:20px;padding:10px;border:1px solid;background:white;clear:both;">
-<big><big>Agreed, git support on Windows could be better ...</big></big>
-<h1> ... want to improve the situation?</h1>
-<br>Contribute to GitSharp
-<br>Every little bit helps:
-* Link to the [http://www.eqqon.com/index.php/GitSharp Git# website] to promote the project.
-* Tell your friends ...
-* Code! Contact us and tackle an issue.
-<br>So let's all stop complaining about the situation, start rocking and have fun!
-</div>
 </div>
-= Git# --> Git for .NET and Mono =
+= GitSharp - Git for .NET and Mono =
 <big><big>... a native Windows version of the fast & free open source version control system</big></big>
@@ Line 100: / Line 100: @@
 <br>
-Navigation: [http://github.com/henon/GitSharp/downloads Downloads] | [http://github.com/henon/GitSharp Sources] | [http://code.google.com/p/gitsharp/issues/list Bugs & Issues] | [http://tc.openmv.org/project.html?projectId=project11 Integration Server] | [http://groups.google.com/group/gitsharp/ Mailing List] | [http://github.com/henon/GitSharp.Demo Demo]
+Navigation: [http://github.com/henon/GitSharp/downloads Downloads] | [http://github.com/henon/GitSharp Sources] | [http://henon.github.com/GitSharp/ API Docs] | [http://code.google.com/p/gitsharp/issues/list Bugs & Issues] | [http://tc.openmv.org/project.html?projectId=project11 Integration Server] | [http://groups.google.com/group/gitsharp/ Mailing List] | [http://github.com/henon/GitSharp.Demo GitSharp.Demo]
-== What you could do with Git#  ==
+== Status of the Project ==
-;Git# as object oriented interface to your git repo
+GitSharp is a quite usable and stable library used by several projects to interact with git repositories. To get an idea check out the Demo (see below)! GitSharp development is currently on hold because we believe that the libgit2 project and its C# bindings [https://github.com/libgit2/libgit2sharp/wiki libgit2sharp] are far more promising to work on.
-:Want to manipulate you git repo from C#? Want to calculate statistics or create a beautiful visualization? Use git#'s well designed object oriented API to access and manipulate repositories.
-;Git# as object database
+;Modules:
-:Git is an object database with built-in history and branching. If you need to create snapshots of your application's configuration or your user's data with alternative configuration branches then use git. By moving the HEAD in the repository you can easily implement undo/redo operations. For instance, one could build a wiki on top of git# or a distributed content management system. Write-support is already implemented so you could already give it a try.
+* '''GitSharp.Core''' - a manual line by line port of jgit (outdated)
+* '''GitSharp.CLI''' (git.exe) - quite incomplete
+* '''GitSharp''' - a user friendly api designed to be easier to use and learn than GitSharp.Core
-;Git# as (distributed) file system
+== Projects using GitSharp ==
-:Git has been designed by Linus Torwalds to be a file system that is very good at content-tracking and keeping multiple distributed versions of the same content in sync. If your application needs to implement backup and/or content synchronization routines then it can build on top of git to do that.
+=== Bonobo Git Server ===
+Jakub Chodounský created [http://www.chodounsky.net/bonobo-git-server Bonobo Git Server] for
+Windows (Git application server hosted on IIS with many features - based on the gitsharp library.
-;Git# as peer-to-peer content distribution system
-:If you need to build a content distribution framework that will easily and efficiently transport content to different machines then you can easily build one on top of git.
-;Git# as a future replacement of msysGit?
+=== GitSharp.Demo ===
-:[http://code.google.com/p/msysgit/ msysGit] currently is the most complete and usable native provider for git on Windows. The problem with msysGit is, that it can not be easily extended by or embedded in other applications. Apart from being a lightweight library, in the future git# might also become a real alternative to msysGit but we are still far away from that.
+[http://github.com/henon/GitSharp.Demo GitSharp.Demo] is a small repository browser project that demonstrates the use of the GitSharp library and the user oriented API.
-== Status of the Project ==
-Porting from JGit is done. That means the library GitSharp.Core can be used already. We still need to implement most of the command line interface (git.exe) and many API interfaces. Future jgit commits will be tracked and ported on a regular basis.
-;Development Status:
+The source demonstrates how easy it is to ...
-* '''GitSharp.Core''' (equivalent to jgit) - Beta
+* open and interact with a git repository
-* '''GitSharp.CLI''' (git.exe) - Alpha
+* iterate over the file-tree of a specific revision
-* '''GitSharp''' (a user friendly api) - Alpha
+* get the contents of a single file of a specific revision
+* get the changes between two commits
+* display a modification as text diff
+[[Image:2010.01.31 gitsharp.demo.png|200px]]
-As of October, 20th 2009 all tests are passing, except 6 encoding related corner cases which have been ignored. For more details, see our [http://tc.openmv.org/project.html?projectId=project11 integration server].
+=== TicGit.net ===
+[[TicGit.net]] a small distributed issue tracker that uses git to keep track of tickets. It demonstrates the use of gitsharp's commiting API. TicGit is a toy project inspired by Scott Chacon's ruby application "ticgit".
-== GitSharp.Demo ==
+[[Image:TicGit_Screenshot1.png|200px]]
-GitSharp.Demo is a small repository browser project that should demonstrate the use of the GitSharp library. Get the sources at [http://github.com/henon/GitSharp.Demo github].
-It shows how to ...
-* open a repository
-* get the branches and tags
-* get the commit history for a branch or tag
-* recursive into the tree of a commit
-* get the contents of a single file in a commit's tree (this commit's version of the file)
-* get the changes between two commits (see screenshot of the diff viewer)
-[[Image:2009.06.21 browser.png|200px]]
-[[Image:2009.10.11 commitdiff.png|200px]]
 == License ==
-Git# is derived from the Java library [http://www.jgit.org jgit] and is released under the BSD license like jgit.
+Git# is derived from the Java library [http://www.eclipse.org/jgit jgit] and is released under the same BSD license as jgit.
 Please refer to the LICENSE.txt files for the complete license, and please refer to the individual source file
@@ Line 210: / Line 202: @@
 * [http://git.or.cz/ git]
 * [http://www.kernel.org/pub/software/scm/git/docs/ git online manual]
-* [http://git.or.cz/gitwiki/EclipsePlugin JGit]
+* [http://www.eclipse.org/jgit JGit]
+* [http://www.git-scm.com git - classic package - source documentation and binaries]
+* [http://www.spheredev.org git 4 the lazy tutorial]