Declared in | GITRepo.h |
---|
The GITRepo
class declares the programmatic interface to the repository.
root
propertyPath to the repository root.
bare
propertyFlag indicating if the repo is bare, accessor isBare.
refResolver
propertyRefs Resolver for the repo.
Path to the repository root.
@property NSString *root
GITRepo
.h
Flag indicating if the repo is bare, accessor isBare.
@property BOOL bare
GITRepo
.h
Refs Resolver for the repo.
@property GITRefResolver *refResolver
GITRepo
.h
+ (GITRepo *)repo
repository initialised at the current directory, or nil if an error occurred
Returns a repository using the current working directory as the repository root.
GITRepo
.h
+ (GITRepo *)repoWithRoot:(NSString *)theRoot
Path to the repository root
repository initialised at the specified path, or nil if an error occurred
Returns a repository with theRoot as the repository root.
GITRepo
.h
+ (GITRepo *)repoWithRoot:(NSString *)theRoot error:(NSError **)theError
Path to the repository root
NSError
describing any errors which occurred during initialisation
repository initialised at the specified path, or nil if an error occurred
Returns a repository with theRoot as the repository root.
GITRepo
.h
+ (GITRepo *)createRepoAtPath:(NSString *)path
Path at which to create the repository. A bare repository is created if path ends in .git
.
repository created at the path
Creates a repository at the specified path.
GITRepo
.h
+ (GITRepo *)createRepoAtPath:(NSString *)path error:(NSError **)error
Path at which to create the repository. A bare repository is created if path ends in .git
.
NSError
describing the error which occurred during creation or initialisation.
repository created at the path
Creates a repository at the specified path.
GITRepo
.h
- (id)initWithRoot:(NSString *)theRoot
Path to the repository root
repository initialised at the specified path, or nil if an error occurred
Returns a repository initialised with the root specified by theRoot.
GITRepo
.h
- (id)initWithRoot:(NSString *)theRoot error:(NSError **)theError
Path to the repository root
NSError
describing the error which occurred during initialisation
repository initialised at the specified path, or nil if an error occurred
Returns a repository initialised with the root specified by theRoot.
If the path specified by theRoot ends in ".git" then the repository is assumed to be a bare repository, if it doesn't then ".git" is appended to theRoot as a path component. The directory at the path specified is subjected to the following tests
the path specified exists and is a directory
the path specified is both readable and writable by the current user
the path looks like a git directory, ie has a certain structure and files
NSError
is filled with details.
GITRepo
.h
- (id)initAtPath:(NSString *)path
Path at which to create the repository. A bare repository is created if path ends in .git
.
repository created at the path
Creates a repository at the specified path.
GITRepo
.h
- (id)initAtPath:(NSString *)path error:(NSError **)error
Path at which to create the repository. A bare repository is created if path ends in .git
.
NSError
describing the error which occurred during creation or initialisation.
repository created at the path
Creates a repository at the specified path.
GITRepo
.h
- (NSArray *)branches
array of branches from the receiver
Returns an array containing branches from the receiver.
The GITBranch objects in the array are created from the array of GITRef objects returned by headRefs (GITRefResolver
) processing of refs/heads
.
GITRepo
.h
- (NSArray *)remoteBranches
array of remotes from the receiver
Returns an array containing remotes from the receiver.
The GITRemote objects in the array are created from the array of GITRef objects returned by remoteRefs (GITRefResolver
) processing of refs/remotes
.
GITRepo
.h
- (NSArray *)tags
array of tags from the receiver
Returns an array containing tags from the receiver.
The GITTag objects in the array are created from the array of GITRef objects returned by tagRefs (GITRefResolver
) processing of refs/tags
.
GITRepo
.h
- (GITObject *)objectWithSha1:(GITObjectHash *)objectHash error:(NSError **)error
Hash identifying the object to retrieve
NSError
describing any errors which occur
object identified by objectHash or nil if it can't be found or an error occurred
Returns the GITObject
identified by the objectHash.
Attempts to load the object from the file system first, if this fails then it turns to the packCollection to attempt loading from the repositories PACK files.
GITRepo
.h
- (GITCommit *)head
commit object for the HEAD of the receiver
Returns the commit object for the current HEAD of the receiver.
GITRepo
.h
- (GITCommitEnumerator *)enumerator
enumerator object from the HEAD of the reciever
Returns an enumerator object from the HEAD of the receiver.
GITRepo
.h
- (GITCommitEnumerator *)enumeratorWithMode:(GITCommitEnumeratorMode)mode
Enumerator mode to be used by the returned enumerator
enumerator object from the HEAD of the receiver with the given mode
Returns an enumerator object from the HEAD of the receiver with the given mode.
GITRepo
.h
- (GITRevList *)revList
RevList object based on the HEAD of the receiver.
Returns a RevList object based on the HEAD of the receiver.
GITRepo
.h
- (GITRevList *)revListFromCommit:(GITCommit *)head
RevList object based on the given head.
Returns a RevList object based on the given head.
GITRepo
.h
- (NSArray *)revListSortedByDate
array of commits sorted by date
Returns an array of commit objects sorted by their commit date.
The result of this method is equivalent to git rev-list HEAD
.
Use [[repo revList] arrayOfCommitsSortedByDate] instead
GITRepo
.h
- (NSArray *)revListSortedByTopology
array of commits sorted by topology
Returns an array of commit objects sorted by topology.
The result of this method is equivalent to git rev-list --topo-order HEAD
.
Use [[repo revList] arrayOfCommitsSortedByTopology] instead
GITRepo
.h
- (NSArray *)revListSortedByTopologyAndDate
array of commits sorted by topology and date
Returns an array of commit objects sorted by topology and commit date.
The result of this method is equivalent to git rev-list --date-order HEAD
.
Use [[repo revList] arrayOfCommitsSortedByTopologyAndDate] instead
GITRepo
.h
Last updated: 2011-2-20