Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Begun work on documentation.
- Loading branch information
Sam
committed
Apr 2, 2011
1 parent
2e6e376
commit ec84d83
Showing
2 changed files
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/** | ||
* This is the namespace of the Gitteh module. | ||
* @namespace | ||
* @example | ||
* var gitteh = require("gitteh"); | ||
*/ | ||
var Gitteh = { }; | ||
|
||
/** | ||
* Opens a Git repository at the location provided. You can either provide a | ||
* path to a Git repository, which will open the repository "bare" (no working | ||
* directory), or you can provide an object containing paths to the various | ||
* critical Git directories needed for Git to operate. | ||
* @param {String|Object} path | ||
* @param {String} path.gitDirectory The path to the Git repository folder (e.g /foo/.git) | ||
* @param {String} [path.workTree] The path to the Git working directory (e.g /foo). Omitting this will assume the repository is bare. | ||
* @param {String} [path.objectDirectory] The path to the ODB directory (e.g /foo/.git/objects). Omitting this will default to path.gitDirectory + "/objects" | ||
* @param {String} [path.indexFile] The path to the repository index file (e.g /foo/.git/index). Omitting this will default to path.gitDirectory + "/index" | ||
* @param {Function} [callback] If provided, the repository will be opened asynchronously, and the provided callback will be fired when the repository has been opened. | ||
* @returns {Repository} | ||
* @throws If the path provided is incorrect, or the repository is corrupt in some way. | ||
*/ | ||
Gitteh.openRepository = function(path) { }; | ||
|
||
/** | ||
* Creates a new Git repository at the provided path. The repository will be | ||
* created at the path provided, unless bare is set to true, in which case the | ||
* repository will be initialized in a <i>.git</i> directory inside the path | ||
* provided. | ||
* @param {String} path The path to initialize the new Git repository in. | ||
* @param {Boolean} [bare] Initialize the repository as bare or "checked out". | ||
* @param {Function} [callback] If provided, the repository will be created asynchronously. The provided callback will be fired when the repository has been created. | ||
Gitteh.initRepository = function(path, bare, callback) { }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/** | ||
* Represents an open Git repository. The majority of the functionality offered | ||
* by Gitteh is contained in here. | ||
* @class | ||
*/ | ||
var Repository = function() {}; |