From 7f659ed2660fe48b28cae7079eb4ea9675ec386f Mon Sep 17 00:00:00 2001 From: "Robert G. Jakabosky" Date: Wed, 20 Jun 2012 09:35:58 -0700 Subject: [PATCH 1/3] Start of luagit2 API docs. --- git2.luadoc | 35 ++ git2/Blob.luadoc | 81 ++++ git2/Commit.luadoc | 137 ++++++ git2/Config.luadoc | 127 ++++++ git2/Index.luadoc | 148 +++++++ git2/IndexEntry.luadoc | 132 ++++++ git2/IndexEntryUnmerged.luadoc | 32 ++ git2/ODB.luadoc | 120 +++++ git2/ODBBackend.luadoc | 16 + git2/OID.luadoc | 55 +++ git2/OID_Shorten.luadoc | 26 ++ git2/Object.luadoc | 56 +++ git2/OdbObject.luadoc | 43 ++ git2/Reference.luadoc | 117 +++++ git2/Repository.luadoc | 132 ++++++ git2/RevWalk.luadoc | 70 +++ git2/Signature.luadoc | 53 +++ git2/StrArray.luadoc | 44 ++ git2/Tag.luadoc | 76 ++++ git2/Tree.luadoc | 70 +++ git2/TreeEntry.luadoc | 39 ++ index.html | 264 +++++++++++ luadoc.css | 286 ++++++++++++ modules/Blob.html | 456 +++++++++++++++++++ modules/Commit.html | 661 ++++++++++++++++++++++++++++ modules/Config.html | 690 +++++++++++++++++++++++++++++ modules/Index.html | 757 ++++++++++++++++++++++++++++++++ modules/IndexEntry.html | 640 +++++++++++++++++++++++++++ modules/IndexEntryUnmerged.html | 270 ++++++++++++ modules/ODB.html | 656 +++++++++++++++++++++++++++ modules/ODBBackend.html | 202 +++++++++ modules/OID.html | 360 +++++++++++++++ modules/OID_Shorten.html | 251 +++++++++++ modules/Object.html | 342 +++++++++++++++ modules/OdbObject.html | 299 +++++++++++++ modules/Reference.html | 616 ++++++++++++++++++++++++++ modules/Repository.html | 668 ++++++++++++++++++++++++++++ modules/RevWalk.html | 428 ++++++++++++++++++ modules/Signature.html | 354 +++++++++++++++ modules/StrArray.html | 308 +++++++++++++ modules/Tag.html | 424 ++++++++++++++++++ modules/Tree.html | 411 +++++++++++++++++ modules/TreeEntry.html | 292 ++++++++++++ modules/git2.html | 202 +++++++++ 44 files changed, 11446 insertions(+) create mode 100644 git2.luadoc create mode 100644 git2/Blob.luadoc create mode 100644 git2/Commit.luadoc create mode 100644 git2/Config.luadoc create mode 100644 git2/Index.luadoc create mode 100644 git2/IndexEntry.luadoc create mode 100644 git2/IndexEntryUnmerged.luadoc create mode 100644 git2/ODB.luadoc create mode 100644 git2/ODBBackend.luadoc create mode 100644 git2/OID.luadoc create mode 100644 git2/OID_Shorten.luadoc create mode 100644 git2/Object.luadoc create mode 100644 git2/OdbObject.luadoc create mode 100644 git2/Reference.luadoc create mode 100644 git2/Repository.luadoc create mode 100644 git2/RevWalk.luadoc create mode 100644 git2/Signature.luadoc create mode 100644 git2/StrArray.luadoc create mode 100644 git2/Tag.luadoc create mode 100644 git2/Tree.luadoc create mode 100644 git2/TreeEntry.luadoc create mode 100644 index.html create mode 100644 luadoc.css create mode 100644 modules/Blob.html create mode 100644 modules/Commit.html create mode 100644 modules/Config.html create mode 100644 modules/Index.html create mode 100644 modules/IndexEntry.html create mode 100644 modules/IndexEntryUnmerged.html create mode 100644 modules/ODB.html create mode 100644 modules/ODBBackend.html create mode 100644 modules/OID.html create mode 100644 modules/OID_Shorten.html create mode 100644 modules/Object.html create mode 100644 modules/OdbObject.html create mode 100644 modules/Reference.html create mode 100644 modules/Repository.html create mode 100644 modules/RevWalk.html create mode 100644 modules/Signature.html create mode 100644 modules/StrArray.html create mode 100644 modules/Tag.html create mode 100644 modules/Tree.html create mode 100644 modules/TreeEntry.html create mode 100644 modules/git2.html diff --git a/git2.luadoc b/git2.luadoc new file mode 100644 index 0000000..4fd140e --- /dev/null +++ b/git2.luadoc @@ -0,0 +1,35 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Module git2. +-- +--
Class StrArray +--
Class Repository +--
Class Config +--
Class OdbObject +--
Class OID +--
Class OID_Shorten +--
Class ODB +--
Class ODBBackend +--
Class Index +--
Class IndexEntry +--
Class IndexEntryUnmerged +--
Class Object +--
Class Blob +--
Class Signature +--
Class Commit +--
Class Tree +--
Class TreeEntry +--
Class Tag +--
Class RevWalk +--
Class Reference +module("git2") + +--- module function +-- +-- @name git2.version +-- @return nil. +function git2.version() +end + diff --git a/git2/Blob.luadoc b/git2/Blob.luadoc new file mode 100644 index 0000000..61bdb8c --- /dev/null +++ b/git2/Blob.luadoc @@ -0,0 +1,81 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Blob". +-- +-- Extends Object
+--
+module("Blob") + +--- Create a new Blob object +-- +-- @name Blob.lookup +-- @param repo Must be of type `Repository`. +-- @param id Must be of type `OID`. +-- @return Blob or nil on error. +-- @return Error string. +function Blob.lookup(repo, id) +end + +--- module function +-- +-- @name Blob.fromfile +-- @param repo Must be of type `Repository`. +-- @param path Must be of type `string`. +-- @return OID or nil on error. +-- @return Error string. +function Blob.fromfile(repo, path) +end + +--- module function +-- +-- @name Blob.frombuffer +-- @param repo Must be of type `Repository`. +-- @param buffer Must be of type `string`. +-- @return OID or nil on error. +-- @return Error string. +function Blob.frombuffer(repo, buffer) +end + +--- object method. +-- +-- @name Blob:rawcontent +-- @return string. +function Blob:rawcontent() +end + +--- object method. +-- +-- @name Blob:rawsize +-- @return integer. +function Blob:rawsize() +end + +--- Destroy this object. +-- +-- @name Object:free +function Object:free() +end + +--- object method. +-- +-- @name Object:id +-- @return OID. +function Object:id() +end + +--- object method. +-- +-- @name Object:type +-- @return string. +function Object:type() +end + +--- object method. +-- +-- @name Object:owner +-- @return Repository. +function Object:owner() +end + diff --git a/git2/Commit.luadoc b/git2/Commit.luadoc new file mode 100644 index 0000000..f987ddb --- /dev/null +++ b/git2/Commit.luadoc @@ -0,0 +1,137 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Commit". +-- +-- Extends Object
+--
+module("Commit") + +--- Create a new Commit object +-- +-- @name Commit.lookup +-- @param repo Must be of type `Repository`. +-- @param id Must be of type `OID`. +-- @return Commit or nil on error. +-- @return Error string. +function Commit.lookup(repo, id) +end + +--- module function +-- +-- @name Commit.create +-- @param oid Must be of type `OID`. +-- @param repo Must be of type `Repository`. +-- @param update_ref Must be of type `string`. +-- @param author Must be of type `Signature`. +-- @param committer Must be of type `Signature`. +-- @param message_encoding Must be of type `string`. +-- @param message Must be of type `string`. +-- @param tree Must be of type `Tree`. +-- @param parent Must be of type `Commit`. +-- @return true if no error. +-- @return Error string. +function Commit.create(oid, repo, update_ref, author, committer, message_encoding, message, tree, parent) +end + +--- object method. +-- +-- @name Commit:id +-- @return OID. +function Commit:id() +end + +--- object method. +-- +-- @name Commit:message_encoding +-- @return string. +function Commit:message_encoding() +end + +--- object method. +-- +-- @name Commit:message +-- @return string. +function Commit:message() +end + +--- object method. +-- +-- @name Commit:time +-- @return integer. +function Commit:time() +end + +--- object method. +-- +-- @name Commit:time_offset +-- @return integer. +function Commit:time_offset() +end + +--- object method. +-- +-- @name Commit:committer +-- @return Signature. +function Commit:committer() +end + +--- object method. +-- +-- @name Commit:author +-- @return Signature. +function Commit:author() +end + +--- object method. +-- +-- @name Commit:tree +-- @return Tree or nil on error. +-- @return Error string. +function Commit:tree() +end + +--- object method. +-- +-- @name Commit:parentcount +-- @return integer. +function Commit:parentcount() +end + +--- object method. +-- +-- @name Commit:parent +-- @param n Must be of type `integer`. +-- @return Commit or nil on error. +-- @return Error string. +function Commit:parent(n) +end + +--- Destroy this object. +-- +-- @name Object:free +function Object:free() +end + +--- object method. +-- +-- @name Object:id +-- @return OID. +function Object:id() +end + +--- object method. +-- +-- @name Object:type +-- @return string. +function Object:type() +end + +--- object method. +-- +-- @name Object:owner +-- @return Repository. +function Object:owner() +end + diff --git a/git2/Config.luadoc b/git2/Config.luadoc new file mode 100644 index 0000000..9c30cb5 --- /dev/null +++ b/git2/Config.luadoc @@ -0,0 +1,127 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Config". +-- +--
+module("Config") + +--- Create a new Config object +-- +-- @name Config.new +-- @return Config or nil on error. +-- @return Error string. +function Config.new() +end + +--- Create a new Config object +-- +-- @name Config.open +-- @param path Must be of type `string`. +-- @return Config or nil on error. +-- @return Error string. +function Config.open(path) +end + +--- Destroy this object. +-- +-- @name Config:free +function Config:free() +end + +--- object method. +-- +-- @name Config:add_file_ondisk +-- @param path Must be of type `string`. +-- @param priority Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function Config:add_file_ondisk(path, priority) +end + +--- object method. +-- +-- @name Config:get_int32 +-- @param name Must be of type `string`. +-- @return integer or nil on error. +-- @return Error string. +function Config:get_int32(name) +end + +--- object method. +-- +-- @name Config:set_int32 +-- @param name Must be of type `string`. +-- @param value Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function Config:set_int32(name, value) +end + +--- object method. +-- +-- @name Config:get_int64 +-- @param name Must be of type `string`. +-- @return integer or nil on error. +-- @return Error string. +function Config:get_int64(name) +end + +--- object method. +-- +-- @name Config:set_int64 +-- @param name Must be of type `string`. +-- @param value Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function Config:set_int64(name, value) +end + +--- object method. +-- +-- @name Config:get_bool +-- @param name Must be of type `string`. +-- @return boolean or nil on error. +-- @return Error string. +function Config:get_bool(name) +end + +--- object method. +-- +-- @name Config:set_bool +-- @param value Must be of type `boolean`. +-- @param name Must be of type `string`. +-- @return true if no error. +-- @return Error string. +function Config:set_bool(value, name) +end + +--- object method. +-- +-- @name Config:get_string +-- @param name Must be of type `string`. +-- @return string or nil on error. +-- @return Error string. +function Config:get_string(name) +end + +--- object method. +-- +-- @name Config:set_string +-- @param name Must be of type `string`. +-- @param value Must be of type `string`. +-- @return true if no error. +-- @return Error string. +function Config:set_string(name, value) +end + +--- object method. +-- +-- @name Config:delete +-- @param name Must be of type `string`. +-- @return true if no error. +-- @return Error string. +function Config:delete(name) +end + diff --git a/git2/Index.luadoc b/git2/Index.luadoc new file mode 100644 index 0000000..e0ec47a --- /dev/null +++ b/git2/Index.luadoc @@ -0,0 +1,148 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Index". +-- +--
+module("Index") + +--- Create a new Index object +-- +-- @name Index.bare +-- @param index_path Must be of type `string`. +-- @return Index or nil on error. +-- @return Error string. +function Index.bare(index_path) +end + +--- object method. +-- +-- @name Index:clear +function Index:clear() +end + +--- object method. +-- +-- @name Index:read +-- @return true if no error. +-- @return Error string. +function Index:read() +end + +--- object method. +-- +-- @name Index:write +-- @return true if no error. +-- @return Error string. +function Index:write() +end + +--- object method. +-- +-- @name Index:find +-- @param path Must be of type `string`. +-- @return integer. +function Index:find(path) +end + +--- object method. +-- +-- @name Index:uniq +function Index:uniq() +end + +--- object method. +-- +-- @name Index:add +-- @param path Must be of type `string`. +-- @param stage Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function Index:add(path, stage) +end + +--- object method. +-- +-- @name Index:add2 +-- @param source_entry Must be of type `IndexEntry`. +-- @return true if no error. +-- @return Error string. +function Index:add2(source_entry) +end + +--- object method. +-- +-- @name Index:append +-- @param path Must be of type `string`. +-- @param stage Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function Index:append(path, stage) +end + +--- object method. +-- +-- @name Index:append2 +-- @param source_entry Must be of type `IndexEntry`. +-- @return true if no error. +-- @return Error string. +function Index:append2(source_entry) +end + +--- object method. +-- +-- @name Index:remove +-- @param position Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function Index:remove(position) +end + +--- object method. +-- +-- @name Index:get +-- @param n Must be of type `integer`. +-- @return IndexEntry. +function Index:get(n) +end + +--- object method. +-- +-- @name Index:entrycount +-- @return integer. +function Index:entrycount() +end + +--- object method. +-- +-- @name Index:entrycount_unmerged +-- @return integer. +function Index:entrycount_unmerged() +end + +--- object method. +-- +-- @name Index:get_unmerged_bypath +-- @param path Must be of type `string`. +-- @return IndexEntryUnmerged. +function Index:get_unmerged_bypath(path) +end + +--- object method. +-- +-- @name Index:get_unmerged_byindex +-- @param n Must be of type `integer`. +-- @return IndexEntryUnmerged. +function Index:get_unmerged_byindex(n) +end + +--- object method. +-- +-- @name Index:read_tree +-- @param tree Must be of type `Tree`. +-- @return true if no error. +-- @return Error string. +function Index:read_tree(tree) +end + diff --git a/git2/IndexEntry.luadoc b/git2/IndexEntry.luadoc new file mode 100644 index 0000000..852a8f5 --- /dev/null +++ b/git2/IndexEntry.luadoc @@ -0,0 +1,132 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "IndexEntry". +-- +--
+module("IndexEntry") + +--- Create a new IndexEntry object +-- +-- @name IndexEntry.new +-- @return IndexEntry. +function IndexEntry.new() +end + +--- object method. +-- +-- @name IndexEntry:stage +-- @return integer. +function IndexEntry:stage() +end + +--- object method. +-- +-- @name IndexEntry:ctime +-- @return integer. +-- @return integer. +function IndexEntry:ctime() +end + +--- object method. +-- +-- @name IndexEntry:set_ctime +-- @param secs Must be of type `integer`. +-- @param nanosecs Must be of type `integer`. +function IndexEntry:set_ctime(secs, nanosecs) +end + +--- object method. +-- +-- @name IndexEntry:mtime +-- @return integer. +-- @return integer. +function IndexEntry:mtime() +end + +--- object method. +-- +-- @name IndexEntry:set_mtime +-- @param secs Must be of type `integer`. +-- @param nanosecs Must be of type `integer`. +function IndexEntry:set_mtime(secs, nanosecs) +end + +--- object method. +-- +-- @name IndexEntry:path +-- @return string. +function IndexEntry:path() +end + +--- object method. +-- +-- @name IndexEntry:set_path +-- @param val Must be of type `string`. +function IndexEntry:set_path(val) +end + +--- object method. +-- +-- @name IndexEntry:dev +-- @return integer. +function IndexEntry:dev() +end + +--- object method. +-- +-- @name IndexEntry:ino +-- @return integer. +function IndexEntry:ino() +end + +--- object method. +-- +-- @name IndexEntry:mode +-- @return integer. +function IndexEntry:mode() +end + +--- object method. +-- +-- @name IndexEntry:uid +-- @return integer. +function IndexEntry:uid() +end + +--- object method. +-- +-- @name IndexEntry:gid +-- @return integer. +function IndexEntry:gid() +end + +--- object method. +-- +-- @name IndexEntry:file_size +-- @return integer. +function IndexEntry:file_size() +end + +--- object method. +-- +-- @name IndexEntry:oid +-- @return OID. +function IndexEntry:oid() +end + +--- object method. +-- +-- @name IndexEntry:flags +-- @return integer. +function IndexEntry:flags() +end + +--- object method. +-- +-- @name IndexEntry:flags_extended +-- @return integer. +function IndexEntry:flags_extended() +end + diff --git a/git2/IndexEntryUnmerged.luadoc b/git2/IndexEntryUnmerged.luadoc new file mode 100644 index 0000000..2cefb9c --- /dev/null +++ b/git2/IndexEntryUnmerged.luadoc @@ -0,0 +1,32 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "IndexEntryUnmerged". +-- +--
+module("IndexEntryUnmerged") + +--- object method. +-- +-- @name IndexEntryUnmerged:mode +-- @param idx Must be of type `integer`. +-- @return integer. +function IndexEntryUnmerged:mode(idx) +end + +--- object method. +-- +-- @name IndexEntryUnmerged:oid +-- @param idx Must be of type `integer`. +-- @return OID. +function IndexEntryUnmerged:oid(idx) +end + +--- object method. +-- +-- @name IndexEntryUnmerged:path +-- @return string. +function IndexEntryUnmerged:path() +end + diff --git a/git2/ODB.luadoc b/git2/ODB.luadoc new file mode 100644 index 0000000..f6ef993 --- /dev/null +++ b/git2/ODB.luadoc @@ -0,0 +1,120 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "ODB". +-- +--
+module("ODB") + +--- Create a new ODB object +-- +-- @name ODB.new +-- @return ODB or nil on error. +-- @return Error string. +function ODB.new() +end + +--- Create a new ODB object +-- +-- @name ODB.open +-- @param object_dir Must be of type `string`. +-- @return ODB or nil on error. +-- @return Error string. +function ODB.open(object_dir) +end + +--- Destroy this object. +-- +-- @name ODB:free +function ODB:free() +end + +--- object method. +-- +-- @name ODB:add_backend +-- @param backend Must be of type `ODBBackend`. +-- @param priority Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function ODB:add_backend(backend, priority) +end + +--- object method. +-- +-- @name ODB:add_alternate +-- @param backend Must be of type `ODBBackend`. +-- @param priority Must be of type `integer`. +-- @return true if no error. +-- @return Error string. +function ODB:add_alternate(backend, priority) +end + +--- object method. +-- +-- @name ODB:read +-- @param id Must be of type `OID`. +-- @return OdbObject or nil on error. +-- @return Error string. +function ODB:read(id) +end + +--- object method. +-- +-- @name ODB:read_prefix +-- @param short_id Must be of type `OID`. +-- @param len Must be of type `integer`. +-- @return OdbObject or nil on error. +-- @return Error string. +function ODB:read_prefix(short_id, len) +end + +--- object method. +-- +-- @name ODB:read_header +-- @param id Must be of type `OID`. +-- @return integer or nil on error. +-- @return string or nil on error. +-- @return Error string. +function ODB:read_header(id) +end + +--- object method. +-- +-- @name ODB:exists +-- @param id Must be of type `OID`. +-- @return true if no error. +-- @return Error string. +function ODB:exists(id) +end + +--- object method. +-- +-- @name ODB:write +-- @param data1 Must be of type `string`. +-- @param type Must be of type `string`. +-- @return OID or nil on error. +-- @return Error string. +function ODB:write(data1, type) +end + +--- module function +-- +-- @name ODB.hash +-- @param data2 Must be of type `string`. +-- @param otype Must be of type `integer`. +-- @return OID or nil on error. +-- @return Error string. +function ODB.hash(data2, otype) +end + +--- module function +-- +-- @name ODB.hashfile +-- @param path Must be of type `string`. +-- @param otype Must be of type `integer`. +-- @return OID or nil on error. +-- @return Error string. +function ODB.hashfile(path, otype) +end + diff --git a/git2/ODBBackend.luadoc b/git2/ODBBackend.luadoc new file mode 100644 index 0000000..aa18cb1 --- /dev/null +++ b/git2/ODBBackend.luadoc @@ -0,0 +1,16 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "ODBBackend". +-- +--
+module("ODBBackend") + +--- Create a new ODBBackend object +-- +-- @name ODBBackend.new +-- @return ODBBackend. +function ODBBackend.new() +end + diff --git a/git2/OID.luadoc b/git2/OID.luadoc new file mode 100644 index 0000000..b8cab6b --- /dev/null +++ b/git2/OID.luadoc @@ -0,0 +1,55 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "OID". +-- +--
+module("OID") + +--- Create a new OID object +-- +-- @name OID.hex +-- @param str Must be of type `string`. +-- @return OID or nil on error. +-- @return Error string. +function OID.hex(str) +end + +--- Create a new OID object +-- +-- @name OID.raw +-- @param raw Must be of type `string`. +-- @return OID. +function OID.raw(raw) +end + +--- object method. +-- +-- @name OID:pathfmt +-- @return string. +function OID:pathfmt() +end + +--- object method. +-- +-- @name OID:fmt +-- @return string. +function OID:fmt() +end + +--- object meta method. +-- +-- @name OID_mt:__tostring +-- @return string. +function OID_mt:__tostring() +end + +--- object meta method. +-- +-- @name OID_mt:__eq +-- @param id Must be of type `OID`. +-- @return integer. +function OID_mt:__eq(id) +end + diff --git a/git2/OID_Shorten.luadoc b/git2/OID_Shorten.luadoc new file mode 100644 index 0000000..9a2e0eb --- /dev/null +++ b/git2/OID_Shorten.luadoc @@ -0,0 +1,26 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "OID_Shorten". +-- +--
+module("OID_Shorten") + +--- Create a new OID_Shorten object +-- +-- @name OID_Shorten.new +-- @param min_length Must be of type `integer`. +-- @return OID_Shorten. +function OID_Shorten.new(min_length) +end + +--- object method. +-- +-- @name OID_Shorten:add +-- @param text_oid Must be of type `string`. +-- @return true if no error. +-- @return Error string. +function OID_Shorten:add(text_oid) +end + diff --git a/git2/Object.luadoc b/git2/Object.luadoc new file mode 100644 index 0000000..20b3b54 --- /dev/null +++ b/git2/Object.luadoc @@ -0,0 +1,56 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Object". +-- +--
+-- Subclass Blob
+-- Subclass Commit
+-- Subclass Tree
+-- Subclass Tag
+module("Object") + +--- Destroy this object. +-- +-- @name Object:free +function Object:free() +end + +--- object method. +-- +-- @name Object:id +-- @return OID. +function Object:id() +end + +--- object method. +-- +-- @name Object:type +-- @return string. +function Object:type() +end + +--- object method. +-- +-- @name Object:owner +-- @return Repository. +function Object:owner() +end + +--- module function +-- +-- @name Object.type2string +-- @param otype Must be of type `integer`. +-- @return string. +function Object.type2string(otype) +end + +--- module function +-- +-- @name Object.string2type +-- @param str Must be of type `string`. +-- @return integer. +function Object.string2type(str) +end + diff --git a/git2/OdbObject.luadoc b/git2/OdbObject.luadoc new file mode 100644 index 0000000..d5616ae --- /dev/null +++ b/git2/OdbObject.luadoc @@ -0,0 +1,43 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "OdbObject". +-- +--
+module("OdbObject") + +--- Destroy this object. +-- +-- @name OdbObject:free +function OdbObject:free() +end + +--- object method. +-- +-- @name OdbObject:id +-- @return OID. +function OdbObject:id() +end + +--- object method. +-- +-- @name OdbObject:data +-- @return string. +function OdbObject:data() +end + +--- object method. +-- +-- @name OdbObject:size +-- @return integer. +function OdbObject:size() +end + +--- object method. +-- +-- @name OdbObject:type +-- @return string. +function OdbObject:type() +end + diff --git a/git2/Reference.luadoc b/git2/Reference.luadoc new file mode 100644 index 0000000..7e45839 --- /dev/null +++ b/git2/Reference.luadoc @@ -0,0 +1,117 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Reference". +-- +--
+module("Reference") + +--- Create a new Reference object +-- +-- @name Reference.lookup +-- @param repo Must be of type `Repository`. +-- @param name Must be of type `string`. +-- @return Reference or nil on error. +-- @return Error string. +function Reference.lookup(repo, name) +end + +--- object method. +-- +-- @name Reference:oid +-- @return OID. +function Reference:oid() +end + +--- object method. +-- +-- @name Reference:set_oid +-- @param oid Must be of type `OID`. +-- @return true if no error. +-- @return Error string. +function Reference:set_oid(oid) +end + +--- object method. +-- +-- @name Reference:target +-- @return string. +function Reference:target() +end + +--- object method. +-- +-- @name Reference:set_target +-- @param target Must be of type `string`. +-- @return true if no error. +-- @return Error string. +function Reference:set_target(target) +end + +--- object method. +-- +-- @name Reference:type +-- @return integer. +function Reference:type() +end + +--- object method. +-- +-- @name Reference:name +-- @return string. +function Reference:name() +end + +--- object method. +-- +-- @name Reference:resolve +-- @return Reference or nil on error. +-- @return Error string. +function Reference:resolve() +end + +--- object method. +-- +-- @name Reference:owner +-- @return Repository. +function Reference:owner() +end + +--- object method. +-- +-- @name Reference:rename +-- @param new_name Must be of type `string`. +-- @param force Must be of type `boolean`. +-- @return true if no error. +-- @return Error string. +function Reference:rename(new_name, force) +end + +--- object method. +-- +-- @name Reference:delete +-- @return true if no error. +-- @return Error string. +function Reference:delete() +end + +--- module function +-- +-- @name Reference.packall +-- @param repo Must be of type `Repository`. +-- @return true if no error. +-- @return Error string. +function Reference.packall(repo) +end + +--- module function +-- +-- @name Reference.list +-- @param repo Must be of type `Repository`. +-- @param list_flags Must be of type `integer`. +-- @return StrArray or nil on error. +-- @return Error string. +function Reference.list(repo, list_flags) +end + diff --git a/git2/Repository.luadoc b/git2/Repository.luadoc new file mode 100644 index 0000000..8cbf366 --- /dev/null +++ b/git2/Repository.luadoc @@ -0,0 +1,132 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Repository". +-- +--
+module("Repository") + +--- Create a new Repository object +-- +-- @name Repository.open +-- @param path Must be of type `string`. +-- @return Repository or nil on error. +-- @return Error string. +function Repository.open(path) +end + +--- Create a new Repository object +-- +-- @name Repository.init +-- @param path Must be of type `string`. +-- @param is_bare Must be of type `integer`. +-- @return Repository or nil on error. +-- @return Error string. +function Repository.init(path, is_bare) +end + +--- object method. +-- +-- @name Repository:head +-- @return Reference or nil on error. +-- @return Error string. +function Repository:head() +end + +--- object method. +-- +-- @name Repository:head_detached +-- @return boolean. +function Repository:head_detached() +end + +--- object method. +-- +-- @name Repository:head_orphan +-- @return boolean. +function Repository:head_orphan() +end + +--- object method. +-- +-- @name Repository:is_empty +-- @return boolean. +function Repository:is_empty() +end + +--- object method. +-- +-- @name Repository:is_bare +-- @return boolean. +function Repository:is_bare() +end + +--- object method. +-- +-- @name Repository:path +-- @return string. +function Repository:path() +end + +--- object method. +-- +-- @name Repository:workdir +-- @return string. +function Repository:workdir() +end + +--- object method. +-- +-- @name Repository:set_workdir +-- @param workdir Must be of type `string`. +-- @return true if no error. +-- @return Error string. +function Repository:set_workdir(workdir) +end + +--- object method. +-- +-- @name Repository:config +-- @return Config or nil on error. +-- @return Error string. +function Repository:config() +end + +--- object method. +-- +-- @name Repository:set_config +-- @param config Must be of type `Config`. +function Repository:set_config(config) +end + +--- object method. +-- +-- @name Repository:odb +-- @return ODB or nil on error. +-- @return Error string. +function Repository:odb() +end + +--- object method. +-- +-- @name Repository:set_odb +-- @param odb Must be of type `ODB`. +function Repository:set_odb(odb) +end + +--- object method. +-- +-- @name Repository:index +-- @return Index or nil on error. +-- @return Error string. +function Repository:index() +end + +--- object method. +-- +-- @name Repository:set_index +-- @param index Must be of type `Index`. +function Repository:set_index(index) +end + diff --git a/git2/RevWalk.luadoc b/git2/RevWalk.luadoc new file mode 100644 index 0000000..5836a1c --- /dev/null +++ b/git2/RevWalk.luadoc @@ -0,0 +1,70 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "RevWalk". +-- +--
+module("RevWalk") + +--- Create a new RevWalk object +-- +-- @name RevWalk.new +-- @param repo Must be of type `Repository`. +-- @return RevWalk or nil on error. +-- @return Error string. +function RevWalk.new(repo) +end + +--- Destroy this object. +-- +-- @name RevWalk:close +function RevWalk:close() +end + +--- object method. +-- +-- @name RevWalk:reset +function RevWalk:reset() +end + +--- object method. +-- +-- @name RevWalk:push +-- @param id Must be of type `OID`. +-- @return true if no error. +-- @return Error string. +function RevWalk:push(id) +end + +--- object method. +-- +-- @name RevWalk:hide +-- @param id Must be of type `OID`. +-- @return true if no error. +-- @return Error string. +function RevWalk:hide(id) +end + +--- object method. +-- +-- @name RevWalk:next +-- @return OID or nil on error. +-- @return Error string. +function RevWalk:next() +end + +--- object method. +-- +-- @name RevWalk:sorting +-- @param sort_mode Must be of type `integer`. +function RevWalk:sorting(sort_mode) +end + +--- object method. +-- +-- @name RevWalk:repository +-- @return Repository. +function RevWalk:repository() +end + diff --git a/git2/Signature.luadoc b/git2/Signature.luadoc new file mode 100644 index 0000000..efe73ba --- /dev/null +++ b/git2/Signature.luadoc @@ -0,0 +1,53 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Signature". +-- +--
+module("Signature") + +--- Create a new Signature object +-- +-- @name Signature.new +-- @param name Must be of type `string`. +-- @param email Must be of type `string`. +-- @param time Must be of type `integer`. +-- @param offset Must be of type `integer`. +-- @return Signature or nil on error. +-- @return Error string. +function Signature.new(name, email, time, offset) +end + +--- Create a new Signature object +-- +-- @name Signature.now +-- @param name Must be of type `string`. +-- @param email Must be of type `string`. +-- @return Signature or nil on error. +-- @return Error string. +function Signature.now(name, email) +end + +--- object method. +-- +-- @name Signature:name +-- @return string. +function Signature:name() +end + +--- object method. +-- +-- @name Signature:email +-- @return string. +function Signature:email() +end + +--- object method. +-- +-- @name Signature:when +-- @return integer. +-- @return integer. +function Signature:when() +end + diff --git a/git2/StrArray.luadoc b/git2/StrArray.luadoc new file mode 100644 index 0000000..7fa9d6c --- /dev/null +++ b/git2/StrArray.luadoc @@ -0,0 +1,44 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "StrArray". +-- +--
+module("StrArray") + +--- Create a new StrArray object +-- +-- @name StrArray.new +-- @return StrArray. +function StrArray.new() +end + +--- Destroy this object. +-- +-- @name StrArray:free +function StrArray:free() +end + +--- object method. +-- +-- @name StrArray:str +-- @param n Must be of type `integer`. +-- @return string. +function StrArray:str(n) +end + +--- object method. +-- +-- @name StrArray:get_array +-- @return nil. +function StrArray:get_array() +end + +--- object method. +-- +-- @name StrArray:count +-- @return integer. +function StrArray:count() +end + diff --git a/git2/Tag.luadoc b/git2/Tag.luadoc new file mode 100644 index 0000000..d28fb98 --- /dev/null +++ b/git2/Tag.luadoc @@ -0,0 +1,76 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Tag". +-- +-- Extends Object
+--
+module("Tag") + +--- Create a new Tag object +-- +-- @name Tag.lookup +-- @param repo Must be of type `Repository`. +-- @param id Must be of type `OID`. +-- @return Tag or nil on error. +-- @return Error string. +function Tag.lookup(repo, id) +end + +--- object method. +-- +-- @name Tag:target +-- @return Object or nil on error. +-- @return Error string. +function Tag:target() +end + +--- object method. +-- +-- @name Tag:name +-- @return string. +function Tag:name() +end + +--- object method. +-- +-- @name Tag:tagger +-- @return Signature. +function Tag:tagger() +end + +--- object method. +-- +-- @name Tag:message +-- @return string. +function Tag:message() +end + +--- Destroy this object. +-- +-- @name Object:free +function Object:free() +end + +--- object method. +-- +-- @name Object:id +-- @return OID. +function Object:id() +end + +--- object method. +-- +-- @name Object:type +-- @return string. +function Object:type() +end + +--- object method. +-- +-- @name Object:owner +-- @return Repository. +function Object:owner() +end + diff --git a/git2/Tree.luadoc b/git2/Tree.luadoc new file mode 100644 index 0000000..58f34a9 --- /dev/null +++ b/git2/Tree.luadoc @@ -0,0 +1,70 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "Tree". +-- +-- Extends Object
+--
+module("Tree") + +--- Create a new Tree object +-- +-- @name Tree.lookup +-- @param repo Must be of type `Repository`. +-- @param id Must be of type `OID`. +-- @return Tree or nil on error. +-- @return Error string. +function Tree.lookup(repo, id) +end + +--- object method. +-- +-- @name Tree:entrycount +-- @return integer. +function Tree:entrycount() +end + +--- object method. +-- +-- @name Tree:entry_byname +-- @param filename Must be of type `string`. +-- @return TreeEntry. +function Tree:entry_byname(filename) +end + +--- object method. +-- +-- @name Tree:entry_byindex +-- @param index Must be of type `integer`. +-- @return TreeEntry. +function Tree:entry_byindex(index) +end + +--- Destroy this object. +-- +-- @name Object:free +function Object:free() +end + +--- object method. +-- +-- @name Object:id +-- @return OID. +function Object:id() +end + +--- object method. +-- +-- @name Object:type +-- @return string. +function Object:type() +end + +--- object method. +-- +-- @name Object:owner +-- @return Repository. +function Object:owner() +end + diff --git a/git2/TreeEntry.luadoc b/git2/TreeEntry.luadoc new file mode 100644 index 0000000..674b1f5 --- /dev/null +++ b/git2/TreeEntry.luadoc @@ -0,0 +1,39 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "TreeEntry". +-- +--
+module("TreeEntry") + +--- object method. +-- +-- @name TreeEntry:name +-- @return string. +function TreeEntry:name() +end + +--- object method. +-- +-- @name TreeEntry:attributes +-- @return integer. +function TreeEntry:attributes() +end + +--- object method. +-- +-- @name TreeEntry:id +-- @return OID. +function TreeEntry:id() +end + +--- object method. +-- +-- @name TreeEntry:object +-- @param repo Must be of type `Repository`. +-- @return Object or nil on error. +-- @return Error string. +function TreeEntry:object(repo) +end + diff --git a/index.html b/index.html new file mode 100644 index 0000000..c6ed799 --- /dev/null +++ b/index.html @@ -0,0 +1,264 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ + + +

Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BlobClass "Blob".
CommitClass "Commit".
ConfigClass "Config".
IndexClass "Index".
IndexEntryClass "IndexEntry".
IndexEntryUnmergedClass "IndexEntryUnmerged".
ODBClass "ODB".
ODBBackendClass "ODBBackend".
OIDClass "OID".
OID_ShortenClass "OID_Shorten".
ObjectClass "Object".
OdbObjectClass "OdbObject".
ReferenceClass "Reference".
RepositoryClass "Repository".
RevWalkClass "RevWalk".
SignatureClass "Signature".
StrArrayClass "StrArray".
TagClass "Tag".
TreeClass "Tree".
TreeEntryClass "TreeEntry".
git2Module git2.
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/luadoc.css b/luadoc.css new file mode 100644 index 0000000..bc0f98a --- /dev/null +++ b/luadoc.css @@ -0,0 +1,286 @@ +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color:#ffffff; margin:0px; +} + +code { + font-family: "Andale Mono", monospace; +} + +tt { + font-family: "Andale Mono", monospace; +} + +body, td, th { font-size: 11pt; } + +h1, h2, h3, h4 { margin-left: 0em; } + +textarea, pre, tt { font-size:10pt; } +body, td, th { color:#000000; } +small { font-size:0.85em; } +h1 { font-size:1.5em; } +h2 { font-size:1.25em; } +h3 { font-size:1.15em; } +h4 { font-size:1.06em; } + +a:link { font-weight:bold; color: #004080; text-decoration: none; } +a:visited { font-weight:bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration:underline; } +hr { color:#cccccc } +img { border-width: 0px; } + + +h3 { padding-top: 1em; } + +p { margin-left: 1em; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; + margin-left: 0em; +} + +blockquote { margin-left: 3em; } + +pre.example { + background-color: rgb(245, 245, 245); + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-style: solid; + border-right-style: solid; + border-bottom-style: solid; + border-left-style: solid; + border-top-color: silver; + border-right-color: silver; + border-bottom-color: silver; + border-left-color: silver; + padding: 1em; + margin-left: 1em; + margin-right: 1em; + font-family: "Andale Mono", monospace; + font-size: smaller; +} + + +hr { + margin-left: 0em; + background: #00007f; + border: 0px; + height: 1px; +} + +ul { list-style-type: disc; } + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } +table.index ul { padding-top: 0em; margin-top: 0em; } + +table { + border: 1px solid black; + border-collapse: collapse; + margin-left: auto; + margin-right: auto; +} +th { + border: 1px solid black; + padding: 0.5em; +} +td { + border: 1px solid black; + padding: 0.5em; +} +div.header, div.footer { margin-left: 0em; } + +#container +{ + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product +{ + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#product_logo +{ +} + +#product_name +{ +} + +#product_description +{ +} + +#main +{ + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation +{ + float: left; + width: 18em; + margin: 0; + vertical-align: top; + background-color: #f0f0f0; + overflow:visible; +} + +#navigation h1 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align:left; + margin:0px; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + padding: 0; + margin: 1px; +} + +#navigation li +{ + text-indent: -1em; + margin: 0em 0em 0em 0.5em; + display: block; + padding: 3px 0px 0px 12px; +} + +#navigation li li a +{ + padding: 0px 3px 0px -1em; +} + +#content +{ + margin-left: 18em; + padding: 1em; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about +{ + clear: both; + margin: 0; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight:bold; color: #004080; text-decoration: underline; } + + #main { background-color: #ffffff; border-left: 0px; } + #container { margin-left: 2%; margin-right: 2%; background-color: #ffffff; } + + #content { margin-left: 0px; padding: 1em; border-left: 0px; border-right: 0px; background-color: #ffffff; } + + #navigation { display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list td +{ + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; } +table.module_list td.summary { width: 100%; } + +table.file_list +{ + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.file_list td +{ + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.file_list td.name { background-color: #f0f0f0; } +table.file_list td.summary { width: 100%; } + + +table.function_list +{ + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td +{ + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; } +table.function_list td.summary { width: 100%; } + + +table.table_list +{ + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.table_list td +{ + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.table_list td.name { background-color: #f0f0f0; } +table.table_list td.summary { width: 100%; } + +dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.function dd {padding-bottom: 1em;} +dl.function h3 {padding: 0; margin: 0; font-size: medium;} + +dl.table dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd {padding-bottom: 1em;} +dl.table h3 {padding: 0; margin: 0; font-size: medium;} + +#TODO: make module_list, file_list, function_list, table_list inherit from a list + diff --git a/modules/Blob.html b/modules/Blob.html new file mode 100644 index 0000000..90e19c5 --- /dev/null +++ b/modules/Blob.html @@ -0,0 +1,456 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Blob

+ +

Class "Blob". Extends Object

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blob.frombuffer (repo, buffer)module function
Blob.fromfile (repo, path)module function
Blob.lookup (repo, id)Create a new Blob object
Blob:rawcontent ()object method.
Blob:rawsize ()object method.
Object:free ()Destroy this object.
Object:id ()object method.
Object:owner ()object method.
Object:type ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Blob.frombuffer (repo, buffer)
+
+module function + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + buffer: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Blob.fromfile (repo, path)
+
+module function + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + path: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Blob.lookup (repo, id)
+
+Create a new Blob object + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Blob or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Blob:rawcontent ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Blob:rawsize ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
Object:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
Object:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Object:owner ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
Object:type ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Commit.html b/modules/Commit.html new file mode 100644 index 0000000..d22ef0a --- /dev/null +++ b/modules/Commit.html @@ -0,0 +1,661 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Commit

+ +

Class "Commit". Extends Object

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Commit.create (oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)module function
Commit.lookup (repo, id)Create a new Commit object
Commit:author ()object method.
Commit:committer ()object method.
Commit:id ()object method.
Commit:message ()object method.
Commit:message_encoding ()object method.
Commit:parent (n)object method.
Commit:parentcount ()object method.
Commit:time ()object method.
Commit:time_offset ()object method.
Commit:tree ()object method.
Object:free ()Destroy this object.
Object:id ()object method.
Object:owner ()object method.
Object:type ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Commit.create (oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)
+
+module function + + +

Parameters

+
    + +
  • + oid: Must be of type `OID`. +
    • + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + update_ref: Must be of type `string`. +
    • + +
  • + author: Must be of type `Signature`. +
    • + +
  • + committer: Must be of type `Signature`. +
    • + +
  • + message_encoding: Must be of type `string`. +
    • + +
  • + message: Must be of type `string`. +
    • + +
  • + tree: Must be of type `Tree`. +
    • + +
  • + parent: Must be of type `Commit`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Commit.lookup (repo, id)
+
+Create a new Commit object + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Commit or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Commit:author ()
+
+object method. + + + + + + + +

Return value:

+Signature. + + + +
+ + + + +
Commit:committer ()
+
+object method. + + + + + + + +

Return value:

+Signature. + + + +
+ + + + +
Commit:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Commit:message ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Commit:message_encoding ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Commit:parent (n)
+
+object method. + + +

Parameters

+
    + +
  • + n: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Commit or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Commit:parentcount ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
Commit:time ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
Commit:time_offset ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
Commit:tree ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. Tree or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Object:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
Object:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Object:owner ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
Object:type ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Config.html b/modules/Config.html new file mode 100644 index 0000000..f2c6a2d --- /dev/null +++ b/modules/Config.html @@ -0,0 +1,690 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Config

+ +

Class "Config".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Config.new ()Create a new Config object
Config.open (path)Create a new Config object
Config:add_file_ondisk (path, priority)object method.
Config:delete (name)object method.
Config:free ()Destroy this object.
Config:get_bool (name)object method.
Config:get_int32 (name)object method.
Config:get_int64 (name)object method.
Config:get_string (name)object method.
Config:set_bool (value, name)object method.
Config:set_int32 (name, value)object method.
Config:set_int64 (name, value)object method.
Config:set_string (name, value)object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Config.new ()
+
+Create a new Config object + + + + + + + +

Return values:

+
    + +
  1. Config or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config.open (path)
+
+Create a new Config object + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Config or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:add_file_ondisk (path, priority)
+
+object method. + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
  • + priority: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:delete (name)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
Config:get_bool (name)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. boolean or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:get_int32 (name)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. integer or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:get_int64 (name)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. integer or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:get_string (name)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. string or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:set_bool (value, name)
+
+object method. + + +

Parameters

+
    + +
  • + value: Must be of type `boolean`. +
    • + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:set_int32 (name, value)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
  • + value: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:set_int64 (name, value)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
  • + value: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Config:set_string (name, value)
+
+object method. + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
  • + value: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Index.html b/modules/Index.html new file mode 100644 index 0000000..e5f1ad5 --- /dev/null +++ b/modules/Index.html @@ -0,0 +1,757 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Index

+ +

Class "Index".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index.bare (index_path)Create a new Index object
Index:add (path, stage)object method.
Index:add2 (source_entry)object method.
Index:append (path, stage)object method.
Index:append2 (source_entry)object method.
Index:clear ()object method.
Index:entrycount ()object method.
Index:entrycount_unmerged ()object method.
Index:find (path)object method.
Index:get (n)object method.
Index:get_unmerged_byindex (n)object method.
Index:get_unmerged_bypath (path)object method.
Index:read ()object method.
Index:read_tree (tree)object method.
Index:remove (position)object method.
Index:uniq ()object method.
Index:write ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Index.bare (index_path)
+
+Create a new Index object + + +

Parameters

+
    + +
  • + index_path: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Index or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:add (path, stage)
+
+object method. + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
  • + stage: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:add2 (source_entry)
+
+object method. + + +

Parameters

+
    + +
  • + source_entry: Must be of type `IndexEntry`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:append (path, stage)
+
+object method. + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
  • + stage: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:append2 (source_entry)
+
+object method. + + +

Parameters

+
    + +
  • + source_entry: Must be of type `IndexEntry`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:clear ()
+
+object method. + + + + + + + + + +
+ + + + +
Index:entrycount ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
Index:entrycount_unmerged ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
Index:find (path)
+
+object method. + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
+ + + + + + +

Return value:

+integer. + + + +
+ + + + +
Index:get (n)
+
+object method. + + +

Parameters

+
    + +
  • + n: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+IndexEntry. + + + +
+ + + + +
Index:get_unmerged_byindex (n)
+
+object method. + + +

Parameters

+
    + +
  • + n: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+IndexEntryUnmerged. + + + +
+ + + + +
Index:get_unmerged_bypath (path)
+
+object method. + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
+ + + + + + +

Return value:

+IndexEntryUnmerged. + + + +
+ + + + +
Index:read ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:read_tree (tree)
+
+object method. + + +

Parameters

+
    + +
  • + tree: Must be of type `Tree`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:remove (position)
+
+object method. + + +

Parameters

+
    + +
  • + position: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Index:uniq ()
+
+object method. + + + + + + + + + +
+ + + + +
Index:write ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/IndexEntry.html b/modules/IndexEntry.html new file mode 100644 index 0000000..153ac8e --- /dev/null +++ b/modules/IndexEntry.html @@ -0,0 +1,640 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module IndexEntry

+ +

Class "IndexEntry".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IndexEntry.new ()Create a new IndexEntry object
IndexEntry:ctime ()object method.
IndexEntry:dev ()object method.
IndexEntry:file_size ()object method.
IndexEntry:flags ()object method.
IndexEntry:flags_extended ()object method.
IndexEntry:gid ()object method.
IndexEntry:ino ()object method.
IndexEntry:mode ()object method.
IndexEntry:mtime ()object method.
IndexEntry:oid ()object method.
IndexEntry:path ()object method.
IndexEntry:set_ctime (secs, nanosecs)object method.
IndexEntry:set_mtime (secs, nanosecs)object method.
IndexEntry:set_path (val)object method.
IndexEntry:stage ()object method.
IndexEntry:uid ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
IndexEntry.new ()
+
+Create a new IndexEntry object + + + + + + + +

Return value:

+IndexEntry. + + + +
+ + + + +
IndexEntry:ctime ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. integer. + +
  2. integer. + +
+ + + +
+ + + + +
IndexEntry:dev ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:file_size ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:flags ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:flags_extended ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:gid ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:ino ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:mode ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:mtime ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. integer. + +
  2. integer. + +
+ + + +
+ + + + +
IndexEntry:oid ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
IndexEntry:path ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
IndexEntry:set_ctime (secs, nanosecs)
+
+object method. + + +

Parameters

+
    + +
  • + secs: Must be of type `integer`. +
    • + +
  • + nanosecs: Must be of type `integer`. +
    • + +
+ + + + + + + + +
+ + + + +
IndexEntry:set_mtime (secs, nanosecs)
+
+object method. + + +

Parameters

+
    + +
  • + secs: Must be of type `integer`. +
    • + +
  • + nanosecs: Must be of type `integer`. +
    • + +
+ + + + + + + + +
+ + + + +
IndexEntry:set_path (val)
+
+object method. + + +

Parameters

+
    + +
  • + val: Must be of type `string`. +
    • + +
+ + + + + + + + +
+ + + + +
IndexEntry:stage ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntry:uid ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/IndexEntryUnmerged.html b/modules/IndexEntryUnmerged.html new file mode 100644 index 0000000..2a39d7a --- /dev/null +++ b/modules/IndexEntryUnmerged.html @@ -0,0 +1,270 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module IndexEntryUnmerged

+ +

Class "IndexEntryUnmerged".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + +
IndexEntryUnmerged:mode (idx)object method.
IndexEntryUnmerged:oid (idx)object method.
IndexEntryUnmerged:path ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
IndexEntryUnmerged:mode (idx)
+
+object method. + + +

Parameters

+
    + +
  • + idx: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+integer. + + + +
+ + + + +
IndexEntryUnmerged:oid (idx)
+
+object method. + + +

Parameters

+
    + +
  • + idx: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+OID. + + + +
+ + + + +
IndexEntryUnmerged:path ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/ODB.html b/modules/ODB.html new file mode 100644 index 0000000..a14188a --- /dev/null +++ b/modules/ODB.html @@ -0,0 +1,656 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module ODB

+ +

Class "ODB".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ODB.hash (data2, otype)module function
ODB.hashfile (path, otype)module function
ODB.new ()Create a new ODB object
ODB.open (object_dir)Create a new ODB object
ODB:add_alternate (backend, priority)object method.
ODB:add_backend (backend, priority)object method.
ODB:exists (id)object method.
ODB:free ()Destroy this object.
ODB:read (id)object method.
ODB:read_header (id)object method.
ODB:read_prefix (short_id, len)object method.
ODB:write (data1, type)object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
ODB.hash (data2, otype)
+
+module function + + +

Parameters

+
    + +
  • + data2: Must be of type `string`. +
    • + +
  • + otype: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB.hashfile (path, otype)
+
+module function + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
  • + otype: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB.new ()
+
+Create a new ODB object + + + + + + + +

Return values:

+
    + +
  1. ODB or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB.open (object_dir)
+
+Create a new ODB object + + +

Parameters

+
    + +
  • + object_dir: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. ODB or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB:add_alternate (backend, priority)
+
+object method. + + +

Parameters

+
    + +
  • + backend: Must be of type `ODBBackend`. +
    • + +
  • + priority: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB:add_backend (backend, priority)
+
+object method. + + +

Parameters

+
    + +
  • + backend: Must be of type `ODBBackend`. +
    • + +
  • + priority: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB:exists (id)
+
+object method. + + +

Parameters

+
    + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
ODB:read (id)
+
+object method. + + +

Parameters

+
    + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OdbObject or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB:read_header (id)
+
+object method. + + +

Parameters

+
    + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. integer or nil on error. + +
  2. string or nil on error. + +
  3. Error string. + +
+ + + +
+ + + + +
ODB:read_prefix (short_id, len)
+
+object method. + + +

Parameters

+
    + +
  • + short_id: Must be of type `OID`. +
    • + +
  • + len: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OdbObject or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
ODB:write (data1, type)
+
+object method. + + +

Parameters

+
    + +
  • + data1: Must be of type `string`. +
    • + +
  • + type: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/ODBBackend.html b/modules/ODBBackend.html new file mode 100644 index 0000000..9796daf --- /dev/null +++ b/modules/ODBBackend.html @@ -0,0 +1,202 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module ODBBackend

+ +

Class "ODBBackend".

+ + + + + +

Functions

+ + + + + + + +
ODBBackend.new ()Create a new ODBBackend object
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
ODBBackend.new ()
+
+Create a new ODBBackend object + + + + + + + +

Return value:

+ODBBackend. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/OID.html b/modules/OID.html new file mode 100644 index 0000000..3ded39f --- /dev/null +++ b/modules/OID.html @@ -0,0 +1,360 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module OID

+ +

Class "OID".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OID.hex (str)Create a new OID object
OID.raw (raw)Create a new OID object
OID:fmt ()object method.
OID:pathfmt ()object method.
OID_mt:__eq (id)object meta method.
OID_mt:__tostring ()object meta method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
OID.hex (str)
+
+Create a new OID object + + +

Parameters

+
    + +
  • + str: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
OID.raw (raw)
+
+Create a new OID object + + +

Parameters

+
    + +
  • + raw: Must be of type `string`. +
    • + +
+ + + + + + +

Return value:

+OID. + + + +
+ + + + +
OID:fmt ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
OID:pathfmt ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
OID_mt:__eq (id)
+
+object meta method. + + +

Parameters

+
    + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return value:

+integer. + + + +
+ + + + +
OID_mt:__tostring ()
+
+object meta method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/OID_Shorten.html b/modules/OID_Shorten.html new file mode 100644 index 0000000..43bc985 --- /dev/null +++ b/modules/OID_Shorten.html @@ -0,0 +1,251 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module OID_Shorten

+ +

Class "OID_Shorten".

+ + + + + +

Functions

+ + + + + + + + + + + + +
OID_Shorten.new (min_length)Create a new OID_Shorten object
OID_Shorten:add (text_oid)object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
OID_Shorten.new (min_length)
+
+Create a new OID_Shorten object + + +

Parameters

+
    + +
  • + min_length: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+OID_Shorten. + + + +
+ + + + +
OID_Shorten:add (text_oid)
+
+object method. + + +

Parameters

+
    + +
  • + text_oid: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Object.html b/modules/Object.html new file mode 100644 index 0000000..15077e6 --- /dev/null +++ b/modules/Object.html @@ -0,0 +1,342 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Object

+ +

Class "Object".
Subclass Blob
Subclass Commit
Subclass Tree
Subclass Tag

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object.string2type (str)module function
Object.type2string (otype)module function
Object:free ()Destroy this object.
Object:id ()object method.
Object:owner ()object method.
Object:type ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Object.string2type (str)
+
+module function + + +

Parameters

+
    + +
  • + str: Must be of type `string`. +
    • + +
+ + + + + + +

Return value:

+integer. + + + +
+ + + + +
Object.type2string (otype)
+
+module function + + +

Parameters

+
    + +
  • + otype: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+string. + + + +
+ + + + +
Object:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
Object:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Object:owner ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
Object:type ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/OdbObject.html b/modules/OdbObject.html new file mode 100644 index 0000000..80a4a14 --- /dev/null +++ b/modules/OdbObject.html @@ -0,0 +1,299 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module OdbObject

+ +

Class "OdbObject".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
OdbObject:data ()object method.
OdbObject:free ()Destroy this object.
OdbObject:id ()object method.
OdbObject:size ()object method.
OdbObject:type ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
OdbObject:data ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
OdbObject:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
OdbObject:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
OdbObject:size ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
OdbObject:type ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Reference.html b/modules/Reference.html new file mode 100644 index 0000000..0718d5f --- /dev/null +++ b/modules/Reference.html @@ -0,0 +1,616 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Reference

+ +

Class "Reference".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Reference.list (repo, list_flags)module function
Reference.lookup (repo, name)Create a new Reference object
Reference.packall (repo)module function
Reference:delete ()object method.
Reference:name ()object method.
Reference:oid ()object method.
Reference:owner ()object method.
Reference:rename (new_name, force)object method.
Reference:resolve ()object method.
Reference:set_oid (oid)object method.
Reference:set_target (target)object method.
Reference:target ()object method.
Reference:type ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Reference.list (repo, list_flags)
+
+module function + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + list_flags: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. StrArray or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference.lookup (repo, name)
+
+Create a new Reference object + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + name: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Reference or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference.packall (repo)
+
+module function + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference:delete ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference:name ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Reference:oid ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Reference:owner ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
Reference:rename (new_name, force)
+
+object method. + + +

Parameters

+
    + +
  • + new_name: Must be of type `string`. +
    • + +
  • + force: Must be of type `boolean`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference:resolve ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. Reference or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference:set_oid (oid)
+
+object method. + + +

Parameters

+
    + +
  • + oid: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference:set_target (target)
+
+object method. + + +

Parameters

+
    + +
  • + target: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Reference:target ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Reference:type ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Repository.html b/modules/Repository.html new file mode 100644 index 0000000..742e64e --- /dev/null +++ b/modules/Repository.html @@ -0,0 +1,668 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Repository

+ +

Class "Repository".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Repository.init (path, is_bare)Create a new Repository object
Repository.open (path)Create a new Repository object
Repository:config ()object method.
Repository:head ()object method.
Repository:head_detached ()object method.
Repository:head_orphan ()object method.
Repository:index ()object method.
Repository:is_bare ()object method.
Repository:is_empty ()object method.
Repository:odb ()object method.
Repository:path ()object method.
Repository:set_config (config)object method.
Repository:set_index (index)object method.
Repository:set_odb (odb)object method.
Repository:set_workdir (workdir)object method.
Repository:workdir ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Repository.init (path, is_bare)
+
+Create a new Repository object + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
  • + is_bare: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Repository or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository.open (path)
+
+Create a new Repository object + + +

Parameters

+
    + +
  • + path: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Repository or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository:config ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. Config or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository:head ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. Reference or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository:head_detached ()
+
+object method. + + + + + + + +

Return value:

+boolean. + + + +
+ + + + +
Repository:head_orphan ()
+
+object method. + + + + + + + +

Return value:

+boolean. + + + +
+ + + + +
Repository:index ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. Index or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository:is_bare ()
+
+object method. + + + + + + + +

Return value:

+boolean. + + + +
+ + + + +
Repository:is_empty ()
+
+object method. + + + + + + + +

Return value:

+boolean. + + + +
+ + + + +
Repository:odb ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. ODB or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository:path ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Repository:set_config (config)
+
+object method. + + +

Parameters

+
    + +
  • + config: Must be of type `Config`. +
    • + +
+ + + + + + + + +
+ + + + +
Repository:set_index (index)
+
+object method. + + +

Parameters

+
    + +
  • + index: Must be of type `Index`. +
    • + +
+ + + + + + + + +
+ + + + +
Repository:set_odb (odb)
+
+object method. + + +

Parameters

+
    + +
  • + odb: Must be of type `ODB`. +
    • + +
+ + + + + + + + +
+ + + + +
Repository:set_workdir (workdir)
+
+object method. + + +

Parameters

+
    + +
  • + workdir: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
Repository:workdir ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/RevWalk.html b/modules/RevWalk.html new file mode 100644 index 0000000..1d31ed8 --- /dev/null +++ b/modules/RevWalk.html @@ -0,0 +1,428 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module RevWalk

+ +

Class "RevWalk".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RevWalk.new (repo)Create a new RevWalk object
RevWalk:close ()Destroy this object.
RevWalk:hide (id)object method.
RevWalk:next ()object method.
RevWalk:push (id)object method.
RevWalk:repository ()object method.
RevWalk:reset ()object method.
RevWalk:sorting (sort_mode)object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
RevWalk.new (repo)
+
+Create a new RevWalk object + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. RevWalk or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
RevWalk:close ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
RevWalk:hide (id)
+
+object method. + + +

Parameters

+
    + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
RevWalk:next ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. OID or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
RevWalk:push (id)
+
+object method. + + +

Parameters

+
    + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. true if no error. + +
  2. Error string. + +
+ + + +
+ + + + +
RevWalk:repository ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
RevWalk:reset ()
+
+object method. + + + + + + + + + +
+ + + + +
RevWalk:sorting (sort_mode)
+
+object method. + + +

Parameters

+
    + +
  • + sort_mode: Must be of type `integer`. +
    • + +
+ + + + + + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Signature.html b/modules/Signature.html new file mode 100644 index 0000000..6b1bb44 --- /dev/null +++ b/modules/Signature.html @@ -0,0 +1,354 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Signature

+ +

Class "Signature".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Signature.new (name, email, time, offset)Create a new Signature object
Signature.now (name, email)Create a new Signature object
Signature:email ()object method.
Signature:name ()object method.
Signature:when ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Signature.new (name, email, time, offset)
+
+Create a new Signature object + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
  • + email: Must be of type `string`. +
    • + +
  • + time: Must be of type `integer`. +
    • + +
  • + offset: Must be of type `integer`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Signature or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Signature.now (name, email)
+
+Create a new Signature object + + +

Parameters

+
    + +
  • + name: Must be of type `string`. +
    • + +
  • + email: Must be of type `string`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Signature or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Signature:email ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Signature:name ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Signature:when ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. integer. + +
  2. integer. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/StrArray.html b/modules/StrArray.html new file mode 100644 index 0000000..05e7ef8 --- /dev/null +++ b/modules/StrArray.html @@ -0,0 +1,308 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module StrArray

+ +

Class "StrArray".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
StrArray.new ()Create a new StrArray object
StrArray:count ()object method.
StrArray:free ()Destroy this object.
StrArray:get_array ()object method.
StrArray:str (n)object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
StrArray.new ()
+
+Create a new StrArray object + + + + + + + +

Return value:

+StrArray. + + + +
+ + + + +
StrArray:count ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
StrArray:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
StrArray:get_array ()
+
+object method. + + + + + + + +

Return value:

+nil. + + + +
+ + + + +
StrArray:str (n)
+
+object method. + + +

Parameters

+
    + +
  • + n: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+string. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Tag.html b/modules/Tag.html new file mode 100644 index 0000000..8630fb2 --- /dev/null +++ b/modules/Tag.html @@ -0,0 +1,424 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Tag

+ +

Class "Tag". Extends Object

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object:free ()Destroy this object.
Object:id ()object method.
Object:owner ()object method.
Object:type ()object method.
Tag.lookup (repo, id)Create a new Tag object
Tag:message ()object method.
Tag:name ()object method.
Tag:tagger ()object method.
Tag:target ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Object:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
Object:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Object:owner ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
Object:type ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Tag.lookup (repo, id)
+
+Create a new Tag object + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Tag or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Tag:message ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Tag:name ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Tag:tagger ()
+
+object method. + + + + + + + +

Return value:

+Signature. + + + +
+ + + + +
Tag:target ()
+
+object method. + + + + + + + +

Return values:

+
    + +
  1. Object or nil on error. + +
  2. Error string. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/Tree.html b/modules/Tree.html new file mode 100644 index 0000000..281e795 --- /dev/null +++ b/modules/Tree.html @@ -0,0 +1,411 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module Tree

+ +

Class "Tree". Extends Object

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object:free ()Destroy this object.
Object:id ()object method.
Object:owner ()object method.
Object:type ()object method.
Tree.lookup (repo, id)Create a new Tree object
Tree:entry_byindex (index)object method.
Tree:entry_byname (filename)object method.
Tree:entrycount ()object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
Object:free ()
+
+Destroy this object. + + + + + + + + + +
+ + + + +
Object:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
Object:owner ()
+
+object method. + + + + + + + +

Return value:

+Repository. + + + +
+ + + + +
Object:type ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
Tree.lookup (repo, id)
+
+Create a new Tree object + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
  • + id: Must be of type `OID`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Tree or nil on error. + +
  2. Error string. + +
+ + + +
+ + + + +
Tree:entry_byindex (index)
+
+object method. + + +

Parameters

+
    + +
  • + index: Must be of type `integer`. +
    • + +
+ + + + + + +

Return value:

+TreeEntry. + + + +
+ + + + +
Tree:entry_byname (filename)
+
+object method. + + +

Parameters

+
    + +
  • + filename: Must be of type `string`. +
    • + +
+ + + + + + +

Return value:

+TreeEntry. + + + +
+ + + + +
Tree:entrycount ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/TreeEntry.html b/modules/TreeEntry.html new file mode 100644 index 0000000..fde987d --- /dev/null +++ b/modules/TreeEntry.html @@ -0,0 +1,292 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module TreeEntry

+ +

Class "TreeEntry".

+ + + + + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + +
TreeEntry:attributes ()object method.
TreeEntry:id ()object method.
TreeEntry:name ()object method.
TreeEntry:object (repo)object method.
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
TreeEntry:attributes ()
+
+object method. + + + + + + + +

Return value:

+integer. + + + +
+ + + + +
TreeEntry:id ()
+
+object method. + + + + + + + +

Return value:

+OID. + + + +
+ + + + +
TreeEntry:name ()
+
+object method. + + + + + + + +

Return value:

+string. + + + +
+ + + + +
TreeEntry:object (repo)
+
+object method. + + +

Parameters

+
    + +
  • + repo: Must be of type `Repository`. +
    • + +
+ + + + + + +

Return values:

+
    + +
  1. Object or nil on error. + +
  2. Error string. + +
+ + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + diff --git a/modules/git2.html b/modules/git2.html new file mode 100644 index 0000000..80d83be --- /dev/null +++ b/modules/git2.html @@ -0,0 +1,202 @@ + + + + Codestin Search App + + + + + +
+ +
+ +
+
+
+ +
+ + + +
+ +

Module git2

+ +

Module git2.
Class StrArray
Class Repository
Class Config
Class OdbObject
Class OID
Class OID_Shorten
Class ODB
Class ODBBackend
Class Index
Class IndexEntry
Class IndexEntryUnmerged
Class Object
Class Blob
Class Signature
Class Commit
Class Tree
Class TreeEntry
Class Tag
Class RevWalk
Class Reference

+ + + + + +

Functions

+ + + + + + + +
git2.version ()module function
+ + + + + + +
+
+ + + +

Functions

+
+ + + +
git2.version ()
+
+module function + + + + + + + +

Return value:

+nil. + + + +
+ + +
+ + + + + + +
+ +
+ +
+

Valid XHTML 1.0!

+
+ +
+ + From 6aa325f208a398420e5bdd4ebd0b4e5cdad39d17 Mon Sep 17 00:00:00 2001 From: "Robert G. Jakabosky" Date: Thu, 21 Jun 2012 10:33:59 -0700 Subject: [PATCH 2/3] Copied details from libgit2 API docs. --- git2.luadoc | 6 +- git2/Blob.luadoc | 64 +++++++++++------ git2/Commit.luadoc | 91 ++++++++++++++--------- git2/Config.luadoc | 90 ++++++++++++++--------- git2/Index.luadoc | 88 +++++++++++++++-------- git2/IndexEntry.luadoc | 43 +++++------ git2/IndexEntryUnmerged.luadoc | 11 ++- git2/ODB.luadoc | 123 +++++++++++++++++++++----------- git2/ODBBackend.luadoc | 5 +- git2/OID.luadoc | 29 ++++---- git2/OID_Shorten.luadoc | 22 ++++-- git2/Object.luadoc | 37 ++++++---- git2/OdbObject.luadoc | 21 ++++-- git2/Reference.luadoc | 89 +++++++++++++++-------- git2/Repository.luadoc | 103 ++++++++++++++++++-------- git2/RevWalk.luadoc | 54 ++++++++++---- git2/Signature.luadoc | 35 ++++----- git2/StrArray.luadoc | 15 ++-- git2/Tag.luadoc | 47 ++++++++---- git2/Tree.luadoc | 45 ++++++++---- git2/TreeEntry.luadoc | 16 +++-- modules/Blob.html | 50 ++++++------- modules/Commit.html | 80 ++++++++++----------- modules/Config.html | 62 ++++++++-------- modules/Index.html | 68 +++++++++--------- modules/IndexEntry.html | 22 +++--- modules/IndexEntryUnmerged.html | 8 +-- modules/ODB.html | 86 +++++++++++----------- modules/ODBBackend.html | 8 +-- modules/OID.html | 22 +++--- modules/OID_Shorten.html | 14 ++-- modules/Object.html | 28 ++++---- modules/OdbObject.html | 16 ++--- modules/Reference.html | 62 ++++++++-------- modules/Repository.html | 64 ++++++++--------- modules/RevWalk.html | 36 +++++----- modules/Signature.html | 26 +++---- modules/StrArray.html | 14 ++-- modules/Tag.html | 38 +++++----- modules/Tree.html | 40 +++++------ modules/TreeEntry.html | 20 +++--- modules/git2.html | 6 +- 42 files changed, 1051 insertions(+), 753 deletions(-) diff --git a/git2.luadoc b/git2.luadoc index 4fd140e..d0e5848 100644 --- a/git2.luadoc +++ b/git2.luadoc @@ -4,6 +4,8 @@ --- Module git2. -- +-- See libgit2 API docs. +-- --
Class StrArray --
Class Repository --
Class Config @@ -26,10 +28,10 @@ --
Class Reference module("git2") ---- module function +--- module function. -- --- @name git2.version -- @return nil. +-- @name git2.version function git2.version() end diff --git a/git2/Blob.luadoc b/git2/Blob.luadoc index 61bdb8c..b694f46 100644 --- a/git2/Blob.luadoc +++ b/git2/Blob.luadoc @@ -5,77 +5,97 @@ --- Class "Blob". -- -- Extends Object
---
module("Blob") ---- Create a new Blob object +--- Create a new Blob object. -- --- @name Blob.lookup --- @param repo Must be of type `Repository`. --- @param id Must be of type `OID`. --- @return Blob or nil on error. +--

Calls git_blob_lookup:

+-- @param repo the repo to use when locating the blob.. Must be of type Repository. +-- @param id identity of the blob to locate.. Must be of type OID. +-- @return Blob or nil on error. -- @return Error string. +-- @name Blob.lookup function Blob.lookup(repo, id) end ---- module function +--- module function. -- --- @name Blob.fromfile --- @param repo Must be of type `Repository`. --- @param path Must be of type `string`. --- @return OID or nil on error. +--

Calls git_blob_create_fromfile:

+-- @param repo repository where the blob will be written. this repository cannot be bare. Must be of type Repository. +-- @param path file from which the blob will be created, relative to the repository's working dir. Must be of type string. +-- @return OID or nil on error. -- @return Error string. +-- @name Blob.fromfile function Blob.fromfile(repo, path) end ---- module function +--- module function. -- --- @name Blob.frombuffer --- @param repo Must be of type `Repository`. --- @param buffer Must be of type `string`. --- @return OID or nil on error. +--

Calls git_blob_create_frombuffer:

+-- @param repo repository where to blob will be written. Must be of type Repository. +-- @param buffer data to be written into the blob. Must be of type string. +-- @return OID or nil on error. -- @return Error string. +-- @name Blob.frombuffer function Blob.frombuffer(repo, buffer) end --- object method. -- --- @name Blob:rawcontent +--

Calls git_blob_rawcontent:

A pointer to the raw content of a blob is returned; +-- this pointer is owned internally by the object and shall +-- not be free'd. The pointer may be invalidated at a later +-- time. +--

Calls git_blob_rawsize:

-- @return string. +-- @name Blob:rawcontent function Blob:rawcontent() end --- object method. -- --- @name Blob:rawsize +--

Calls git_blob_rawsize:

-- @return integer. +-- @name Blob:rawsize function Blob:rawsize() end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_object_free:

This method instructs the library to close an existing +-- object; note that git_objects are owned and cached by the repository +-- so the object may or may not be freed after this library call, +-- depending on how agressive is the caching mechanism used +-- by the repository.

IMPORTANT: +-- It *is* necessary to call this method when you stop using +-- an object. Failure to do so will cause a memory leak. -- @name Object:free function Object:free() end --- object method. -- +--

Calls git_object_id:

+-- @return OID. -- @name Object:id --- @return OID. function Object:id() end --- object method. -- --- @name Object:type +--

Calls git_object_type:

-- @return string. +-- @name Object:type function Object:type() end --- object method. -- +--

Calls git_object_owner:

Freeing or calling `git_repository_close` on the +-- returned pointer will invalidate the actual object.

Any other operation may be run on the repository without +-- affecting the object. +-- @return Repository. -- @name Object:owner --- @return Repository. function Object:owner() end diff --git a/git2/Commit.luadoc b/git2/Commit.luadoc index f987ddb..436fb4a 100644 --- a/git2/Commit.luadoc +++ b/git2/Commit.luadoc @@ -5,133 +5,156 @@ --- Class "Commit". -- -- Extends Object
---
module("Commit") ---- Create a new Commit object +--- Create a new Commit object. -- --- @name Commit.lookup --- @param repo Must be of type `Repository`. --- @param id Must be of type `OID`. --- @return Commit or nil on error. +--

Calls git_commit_lookup:

+-- @param repo the repo to use when locating the commit.. Must be of type Repository. +-- @param id identity of the commit to locate. If the object is an annotated tag it will be peeled back to the commit.. Must be of type OID. +-- @return Commit or nil on error. -- @return Error string. +-- @name Commit.lookup function Commit.lookup(repo, id) end ---- module function +--- module function. -- --- @name Commit.create --- @param oid Must be of type `OID`. --- @param repo Must be of type `Repository`. --- @param update_ref Must be of type `string`. --- @param author Must be of type `Signature`. --- @param committer Must be of type `Signature`. --- @param message_encoding Must be of type `string`. --- @param message Must be of type `string`. --- @param tree Must be of type `Tree`. --- @param parent Must be of type `Commit`. +-- @param oid Must be of type OID. +-- @param repo Must be of type Repository. +-- @param update_ref Must be of type string. +-- @param author Must be of type Signature. +-- @param committer Must be of type Signature. +-- @param message_encoding Must be of type string. +-- @param message Must be of type string. +-- @param tree Must be of type Tree. +-- @param parent Must be of type Commit. -- @return true if no error. -- @return Error string. +-- @name Commit.create function Commit.create(oid, repo, update_ref, author, committer, message_encoding, message, tree, parent) end --- object method. -- +--

Calls git_commit_id:

+-- @return OID. -- @name Commit:id --- @return OID. function Commit:id() end --- object method. -- --- @name Commit:message_encoding +--

Calls git_commit_message_encoding:

The encoding may be NULL if the `encoding` header +-- in the commit is missing; in that case UTF-8 is assumed. -- @return string. +-- @name Commit:message_encoding function Commit:message_encoding() end --- object method. -- --- @name Commit:message +--

Calls git_commit_message:

-- @return string. +-- @name Commit:message function Commit:message() end --- object method. -- --- @name Commit:time +--

Calls git_commit_time:

-- @return integer. +-- @name Commit:time function Commit:time() end --- object method. -- --- @name Commit:time_offset +--

Calls git_commit_time_offset:

-- @return integer. +-- @name Commit:time_offset function Commit:time_offset() end --- object method. -- +--

Calls git_commit_committer:

+-- @return Signature. -- @name Commit:committer --- @return Signature. function Commit:committer() end --- object method. -- +--

Calls git_commit_author:

+-- @return Signature. -- @name Commit:author --- @return Signature. function Commit:author() end --- object method. -- --- @name Commit:tree --- @return Tree or nil on error. +--

Calls git_commit_tree:

+-- @return Tree or nil on error. -- @return Error string. +-- @name Commit:tree function Commit:tree() end --- object method. -- --- @name Commit:parentcount +--

Calls git_commit_parentcount:

-- @return integer. +-- @name Commit:parentcount function Commit:parentcount() end --- object method. -- --- @name Commit:parent --- @param n Must be of type `integer`. --- @return Commit or nil on error. +--

Calls git_commit_parent:

+-- @param n the position of the parent (from 0 to `parentcount`). Must be of type integer. +-- @return Commit or nil on error. -- @return Error string. +-- @name Commit:parent function Commit:parent(n) end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_object_free:

This method instructs the library to close an existing +-- object; note that git_objects are owned and cached by the repository +-- so the object may or may not be freed after this library call, +-- depending on how agressive is the caching mechanism used +-- by the repository.

IMPORTANT: +-- It *is* necessary to call this method when you stop using +-- an object. Failure to do so will cause a memory leak. -- @name Object:free function Object:free() end --- object method. -- +--

Calls git_object_id:

+-- @return OID. -- @name Object:id --- @return OID. function Object:id() end --- object method. -- --- @name Object:type +--

Calls git_object_type:

-- @return string. +-- @name Object:type function Object:type() end --- object method. -- +--

Calls git_object_owner:

Freeing or calling `git_repository_close` on the +-- returned pointer will invalidate the actual object.

Any other operation may be run on the repository without +-- affecting the object. +-- @return Repository. -- @name Object:owner --- @return Repository. function Object:owner() end diff --git a/git2/Config.luadoc b/git2/Config.luadoc index 9c30cb5..37a53f4 100644 --- a/git2/Config.luadoc +++ b/git2/Config.luadoc @@ -4,124 +4,144 @@ --- Class "Config". -- ---
module("Config") ---- Create a new Config object +--- Create a new Config object. -- --- @name Config.new --- @return Config or nil on error. +--

Calls git_config_new:

This object is empty, so you have to add a file to it before you +-- can do anything with it. +-- @return Config or nil on error. -- @return Error string. +-- @name Config.new function Config.new() end ---- Create a new Config object --- --- @name Config.open --- @param path Must be of type `string`. --- @return Config or nil on error. +--- Create a new Config object. +-- +--

Calls git_config_open_ondisk:

This method is a simple utility wrapper for the following sequence +-- of calls: +-- - git_config_new +-- - git_config_add_file_ondisk +-- @param path Path to the on-disk file to open. Must be of type string. +-- @return Config or nil on error. -- @return Error string. +-- @name Config.open function Config.open(path) end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_config_free:

-- @name Config:free function Config:free() end --- object method. -- --- @name Config:add_file_ondisk --- @param path Must be of type `string`. --- @param priority Must be of type `integer`. +--

Calls git_config_add_file_ondisk:

The on-disk file pointed at by `path` will be opened and +-- parsed; it's expected to be a native Git config file following +-- the default Git config syntax (see man git-config).

Note that the configuration object will free the file +-- automatically.

Further queries on this config object will access each +-- of the config file instances in order (instances with +-- a higher priority will be accessed first). +-- @param path path to the configuration file (backend) to add. Must be of type string. +-- @param priority the priority the backend should have. Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name Config:add_file_ondisk function Config:add_file_ondisk(path, priority) end --- object method. -- --- @name Config:get_int32 --- @param name Must be of type `string`. +-- @param name Must be of type string. -- @return integer or nil on error. -- @return Error string. +-- @name Config:get_int32 function Config:get_int32(name) end --- object method. -- --- @name Config:set_int32 --- @param name Must be of type `string`. --- @param value Must be of type `integer`. +-- @param name Must be of type string. +-- @param value Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name Config:set_int32 function Config:set_int32(name, value) end --- object method. -- --- @name Config:get_int64 --- @param name Must be of type `string`. +-- @param name Must be of type string. -- @return integer or nil on error. -- @return Error string. +-- @name Config:get_int64 function Config:get_int64(name) end --- object method. -- --- @name Config:set_int64 --- @param name Must be of type `string`. --- @param value Must be of type `integer`. +-- @param name Must be of type string. +-- @param value Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name Config:set_int64 function Config:set_int64(name, value) end --- object method. -- --- @name Config:get_bool --- @param name Must be of type `string`. +--

Calls git_config_get_bool:

This function uses the usual C convention of 0 being false and +-- anything else true. +-- @param name the variable's name. Must be of type string. -- @return boolean or nil on error. -- @return Error string. +-- @name Config:get_bool function Config:get_bool(name) end --- object method. -- --- @name Config:set_bool --- @param value Must be of type `boolean`. --- @param name Must be of type `string`. +--

Calls git_config_set_bool:

+-- @param value the value to store. Must be of type boolean. +-- @param name the variable's name. Must be of type string. -- @return true if no error. -- @return Error string. +-- @name Config:set_bool function Config:set_bool(value, name) end --- object method. -- --- @name Config:get_string --- @param name Must be of type `string`. +--

Calls git_config_get_string:

The string is owned by the variable and should not be freed by the +-- user. +-- @param name the variable's name. Must be of type string. -- @return string or nil on error. -- @return Error string. +-- @name Config:get_string function Config:get_string(name) end --- object method. -- --- @name Config:set_string --- @param name Must be of type `string`. --- @param value Must be of type `string`. +--

Calls git_config_set_string:

A copy of the string is made and the user is free to use it +-- afterwards. +-- @param name the variable's name. Must be of type string. +-- @param value the string to store.. Must be of type string. -- @return true if no error. -- @return Error string. +-- @name Config:set_string function Config:set_string(name, value) end --- object method. -- --- @name Config:delete --- @param name Must be of type `string`. +--

Calls git_config_delete:

+-- @param name the variable to delete. Must be of type string. -- @return true if no error. -- @return Error string. +-- @name Config:delete function Config:delete(name) end diff --git a/git2/Index.luadoc b/git2/Index.luadoc index e0ec47a..bfa51cc 100644 --- a/git2/Index.luadoc +++ b/git2/Index.luadoc @@ -4,145 +4,171 @@ --- Class "Index". -- ---
module("Index") ---- Create a new Index object +--- Create a new Index object. -- --- @name Index.bare --- @param index_path Must be of type `string`. --- @return Index or nil on error. +--

Calls git_index_open:

Since there is no ODB or working directory behind this index, +-- any Index methods which rely on these (e.g. index_add) will +-- fail with the GIT_EBAREINDEX error code.

If you need to access the index of an actual repository, +-- use the `git_repository_index` wrapper.

The index must be freed once it's no longer in use. +-- @param index_path the path to the index file in disk. Must be of type string. +-- @return Index or nil on error. -- @return Error string. +-- @name Index.bare function Index.bare(index_path) end --- object method. -- +--

Calls git_index_clear:

-- @name Index:clear function Index:clear() end --- object method. -- --- @name Index:read +--

Calls git_index_read:

-- @return true if no error. -- @return Error string. +-- @name Index:read function Index:read() end --- object method. -- --- @name Index:write +--

Calls git_index_write:

-- @return true if no error. -- @return Error string. +-- @name Index:write function Index:write() end --- object method. -- --- @name Index:find --- @param path Must be of type `string`. +--

Calls git_index_find:

+-- @param path path to search. Must be of type string. -- @return integer. +-- @name Index:find function Index:find(path) end --- object method. -- +--

Calls git_index_uniq:

-- @name Index:uniq function Index:uniq() end --- object method. -- --- @name Index:add --- @param path Must be of type `string`. --- @param stage Must be of type `integer`. +--

Calls git_index_add:

The file `path` must be relative to the repository's +-- working folder and must be readable.

This method will fail in bare index instances.

This forces the file to be added to the index, not looking +-- at gitignore rules. Those rules can be evaluated through +-- the git_status APIs (in status.h) before calling this. +-- @param path filename to add. Must be of type string. +-- @param stage stage for the entry. Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name Index:add function Index:add(path, stage) end --- object method. -- --- @name Index:add2 --- @param source_entry Must be of type `IndexEntry`. +-- @param source_entry Must be of type IndexEntry. -- @return true if no error. -- @return Error string. +-- @name Index:add2 function Index:add2(source_entry) end --- object method. -- --- @name Index:append --- @param path Must be of type `string`. --- @param stage Must be of type `integer`. +--

Calls git_index_append:

A new entry will always be inserted into the index; +-- if the index already contains an entry for such +-- path, the old entry will **not** be replaced.

The file `path` must be relative to the repository's +-- working folder and must be readable.

This method will fail in bare index instances. +-- @param path filename to add. Must be of type string. +-- @param stage stage for the entry. Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name Index:append function Index:append(path, stage) end --- object method. -- --- @name Index:append2 --- @param source_entry Must be of type `IndexEntry`. +-- @param source_entry Must be of type IndexEntry. -- @return true if no error. -- @return Error string. +-- @name Index:append2 function Index:append2(source_entry) end --- object method. -- --- @name Index:remove --- @param position Must be of type `integer`. +--

Calls git_index_remove:

+-- @param position position of the entry to remove. Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name Index:remove function Index:remove(position) end --- object method. -- +--

Calls git_index_get:

This entry can be modified, and the changes will be written +-- back to disk on the next write() call.

The entry should not be freed by the caller. +-- @param n the position of the entry. Must be of type integer. +-- @return IndexEntry. -- @name Index:get --- @param n Must be of type `integer`. --- @return IndexEntry. function Index:get(n) end --- object method. -- --- @name Index:entrycount +--

Calls git_index_entrycount:

-- @return integer. +-- @name Index:entrycount function Index:entrycount() end --- object method. -- --- @name Index:entrycount_unmerged +--

Calls git_index_entrycount_unmerged:

-- @return integer. +-- @name Index:entrycount_unmerged function Index:entrycount_unmerged() end --- object method. -- +--

Calls git_index_get_unmerged_bypath:

The returned entry is read-only and should not be modified +-- of freed by the caller. +-- @param path path to search. Must be of type string. +-- @return IndexEntryUnmerged. -- @name Index:get_unmerged_bypath --- @param path Must be of type `string`. --- @return IndexEntryUnmerged. function Index:get_unmerged_bypath(path) end --- object method. -- +--

Calls git_index_get_unmerged_byindex:

The returned entry is read-only and should not be modified +-- of freed by the caller. +-- @param n the position of the entry. Must be of type integer. +-- @return IndexEntryUnmerged. -- @name Index:get_unmerged_byindex --- @param n Must be of type `integer`. --- @return IndexEntryUnmerged. function Index:get_unmerged_byindex(n) end --- object method. -- --- @name Index:read_tree --- @param tree Must be of type `Tree`. +--

Calls git_index_read_tree:

The current index contents will be replaced by the specified tree. +-- @param tree tree to read. Must be of type Tree. -- @return true if no error. -- @return Error string. +-- @name Index:read_tree function Index:read_tree(tree) end diff --git a/git2/IndexEntry.luadoc b/git2/IndexEntry.luadoc index 852a8f5..8900db6 100644 --- a/git2/IndexEntry.luadoc +++ b/git2/IndexEntry.luadoc @@ -4,129 +4,130 @@ --- Class "IndexEntry". -- ---
module("IndexEntry") ---- Create a new IndexEntry object +--- Create a new IndexEntry object. -- +-- @return IndexEntry. -- @name IndexEntry.new --- @return IndexEntry. function IndexEntry.new() end --- object method. -- --- @name IndexEntry:stage +--

Calls git_index_entry_stage:

This entry is calculated from the entrie's flag +-- attribute like this:

(entry->flags & GIT_IDXENTRY_STAGEMASK) >> GIT_IDXENTRY_STAGESHIFT

@returns the stage number -- @return integer. +-- @name IndexEntry:stage function IndexEntry:stage() end --- object method. -- --- @name IndexEntry:ctime -- @return integer. -- @return integer. +-- @name IndexEntry:ctime function IndexEntry:ctime() end --- object method. -- +-- @param secs Must be of type integer. +-- @param nanosecs Must be of type integer. -- @name IndexEntry:set_ctime --- @param secs Must be of type `integer`. --- @param nanosecs Must be of type `integer`. function IndexEntry:set_ctime(secs, nanosecs) end --- object method. -- --- @name IndexEntry:mtime -- @return integer. -- @return integer. +-- @name IndexEntry:mtime function IndexEntry:mtime() end --- object method. -- +-- @param secs Must be of type integer. +-- @param nanosecs Must be of type integer. -- @name IndexEntry:set_mtime --- @param secs Must be of type `integer`. --- @param nanosecs Must be of type `integer`. function IndexEntry:set_mtime(secs, nanosecs) end --- object method. -- --- @name IndexEntry:path -- @return string. +-- @name IndexEntry:path function IndexEntry:path() end --- object method. -- +-- @param val Must be of type string. -- @name IndexEntry:set_path --- @param val Must be of type `string`. function IndexEntry:set_path(val) end --- object method. -- --- @name IndexEntry:dev -- @return integer. +-- @name IndexEntry:dev function IndexEntry:dev() end --- object method. -- --- @name IndexEntry:ino -- @return integer. +-- @name IndexEntry:ino function IndexEntry:ino() end --- object method. -- --- @name IndexEntry:mode -- @return integer. +-- @name IndexEntry:mode function IndexEntry:mode() end --- object method. -- --- @name IndexEntry:uid -- @return integer. +-- @name IndexEntry:uid function IndexEntry:uid() end --- object method. -- --- @name IndexEntry:gid -- @return integer. +-- @name IndexEntry:gid function IndexEntry:gid() end --- object method. -- --- @name IndexEntry:file_size -- @return integer. +-- @name IndexEntry:file_size function IndexEntry:file_size() end --- object method. -- +-- @return OID. -- @name IndexEntry:oid --- @return OID. function IndexEntry:oid() end --- object method. -- --- @name IndexEntry:flags -- @return integer. +-- @name IndexEntry:flags function IndexEntry:flags() end --- object method. -- --- @name IndexEntry:flags_extended -- @return integer. +-- @name IndexEntry:flags_extended function IndexEntry:flags_extended() end diff --git a/git2/IndexEntryUnmerged.luadoc b/git2/IndexEntryUnmerged.luadoc index 2cefb9c..bc70e12 100644 --- a/git2/IndexEntryUnmerged.luadoc +++ b/git2/IndexEntryUnmerged.luadoc @@ -4,29 +4,28 @@ --- Class "IndexEntryUnmerged". -- ---
module("IndexEntryUnmerged") --- object method. -- --- @name IndexEntryUnmerged:mode --- @param idx Must be of type `integer`. +-- @param idx Must be of type integer. -- @return integer. +-- @name IndexEntryUnmerged:mode function IndexEntryUnmerged:mode(idx) end --- object method. -- +-- @param idx Must be of type integer. +-- @return OID. -- @name IndexEntryUnmerged:oid --- @param idx Must be of type `integer`. --- @return OID. function IndexEntryUnmerged:oid(idx) end --- object method. -- --- @name IndexEntryUnmerged:path -- @return string. +-- @name IndexEntryUnmerged:path function IndexEntryUnmerged:path() end diff --git a/git2/ODB.luadoc b/git2/ODB.luadoc index f6ef993..6e060ee 100644 --- a/git2/ODB.luadoc +++ b/git2/ODB.luadoc @@ -4,117 +4,156 @@ --- Class "ODB". -- ---
module("ODB") ---- Create a new ODB object +--- Create a new ODB object. -- --- @name ODB.new --- @return ODB or nil on error. +--

Calls git_odb_new:

Before the ODB can be used for read/writing, a custom database +-- backend must be manually added using `git_odb_add_backend()` +-- @return ODB or nil on error. -- @return Error string. +-- @name ODB.new function ODB.new() end ---- Create a new ODB object +--- Create a new ODB object. -- --- @name ODB.open --- @param object_dir Must be of type `string`. --- @return ODB or nil on error. +--

Calls git_odb_open:

- git_odb_backend_loose: read and write loose object files +-- from disk, assuming `objects_dir` as the Objects folder

- git_odb_backend_pack: read objects from packfiles, +-- assuming `objects_dir` as the Objects folder which +-- contains a 'pack/' folder with the corresponding data +-- @param object_dir Must be of type string. +-- @return ODB or nil on error. -- @return Error string. +-- @name ODB.open function ODB.open(object_dir) end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_odb_free:

-- @name ODB:free function ODB:free() end --- object method. -- --- @name ODB:add_backend --- @param backend Must be of type `ODBBackend`. --- @param priority Must be of type `integer`. +-- @param backend Must be of type ODBBackend. +-- @param priority Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name ODB:add_backend function ODB:add_backend(backend, priority) end --- object method. -- --- @name ODB:add_alternate --- @param backend Must be of type `ODBBackend`. --- @param priority Must be of type `integer`. +-- @param backend Must be of type ODBBackend. +-- @param priority Must be of type integer. -- @return true if no error. -- @return Error string. +-- @name ODB:add_alternate function ODB:add_alternate(backend, priority) end --- object method. -- --- @name ODB:read --- @param id Must be of type `OID`. --- @return OdbObject or nil on error. +--

Calls git_odb_read:

This method queries all available ODB backends +-- trying to read the given OID.

The returned object is reference counted and +-- internally cached, so it should be closed +-- by the user once it's no longer in use.

@return +-- - 0 if the object was read; +-- - GIT_ENOTFOUND if the object is not in the database. +-- @param id identity of the object to read.. Must be of type OID. +-- @return OdbObject or nil on error. -- @return Error string. +-- @name ODB:read function ODB:read(id) end --- object method. -- --- @name ODB:read_prefix --- @param short_id Must be of type `OID`. --- @param len Must be of type `integer`. --- @return OdbObject or nil on error. +--

Calls git_odb_read_prefix:

This method queries all available ODB backends +-- trying to match the 'len' first hexadecimal +-- characters of the 'short_id'. +-- The remaining (GIT_OID_HEXSZ-len)*4 bits of +-- 'short_id' must be 0s. +-- 'len' must be at least GIT_OID_MINPREFIXLEN, +-- and the prefix must be long enough to identify +-- a unique object in all the backends; the +-- method will fail otherwise.

The returned object is reference counted and +-- internally cached, so it should be closed +-- by the user once it's no longer in use. +-- @param short_id a prefix of the id of the object to read.. Must be of type OID. +-- @param len the length of the prefix. Must be of type integer. +-- @return OdbObject or nil on error. -- @return Error string. +-- @name ODB:read_prefix function ODB:read_prefix(short_id, len) end --- object method. -- --- @name ODB:read_header --- @param id Must be of type `OID`. +--

Calls git_odb_read_header:

The header includes the length and the type of an object.

Note that most backends do not support reading only the header +-- of an object, so the whole object will be read and then the +-- header will be returned.

@return +-- - 0 if the object was read; +-- - GIT_ENOTFOUND if the object is not in the database. +-- @param id identity of the object to read.. Must be of type OID. -- @return integer or nil on error. -- @return string or nil on error. -- @return Error string. +-- @name ODB:read_header function ODB:read_header(id) end --- object method. -- --- @name ODB:exists --- @param id Must be of type `OID`. +--

Calls git_odb_exists:

@return +-- - 1, if the object was found +-- - 0, otherwise +-- @param id the object to search for.. Must be of type OID. -- @return true if no error. -- @return Error string. +-- @name ODB:exists function ODB:exists(id) end --- object method. -- --- @name ODB:write --- @param data1 Must be of type `string`. --- @param type Must be of type `string`. --- @return OID or nil on error. +--

Calls git_odb_write:

This method writes a full object straight into the ODB. +-- For most cases, it is preferred to write objects through a write +-- stream, which is both faster and less memory intensive, specially +-- for big objects.

This method is provided for compatibility with custom backends +-- which are not able to support streaming writes +-- @param data buffer with the data to storr. Must be of type string. +-- @param type type of the data to store. Must be of type string. +-- @return OID or nil on error. -- @return Error string. -function ODB:write(data1, type) +-- @name ODB:write +function ODB:write(data, type) end ---- module function +--- module function. -- --- @name ODB.hash --- @param data2 Must be of type `string`. --- @param otype Must be of type `integer`. --- @return OID or nil on error. +--

Calls git_odb_hash:

The resulting SHA-1 OID will the itentifier for the data +-- buffer as if the data buffer it were to written to the ODB. +-- @param data data to hash. Must be of type string. +-- @param otype Must be of type integer. +-- @return OID or nil on error. -- @return Error string. -function ODB.hash(data2, otype) +-- @name ODB.hash +function ODB.hash(data, otype) end ---- module function +--- module function. -- --- @name ODB.hashfile --- @param path Must be of type `string`. --- @param otype Must be of type `integer`. --- @return OID or nil on error. +--

Calls git_odb_hashfile:

+-- @param path file to read and determine object id for. Must be of type string. +-- @param otype Must be of type integer. +-- @return OID or nil on error. -- @return Error string. +-- @name ODB.hashfile function ODB.hashfile(path, otype) end diff --git a/git2/ODBBackend.luadoc b/git2/ODBBackend.luadoc index aa18cb1..6823b2e 100644 --- a/git2/ODBBackend.luadoc +++ b/git2/ODBBackend.luadoc @@ -4,13 +4,12 @@ --- Class "ODBBackend". -- ---
module("ODBBackend") ---- Create a new ODBBackend object +--- Create a new ODBBackend object. -- +-- @return ODBBackend. -- @name ODBBackend.new --- @return ODBBackend. function ODBBackend.new() end diff --git a/git2/OID.luadoc b/git2/OID.luadoc index b8cab6b..87e86a1 100644 --- a/git2/OID.luadoc +++ b/git2/OID.luadoc @@ -4,52 +4,55 @@ --- Class "OID". -- ---
module("OID") ---- Create a new OID object +--- Create a new OID object. -- --- @name OID.hex --- @param str Must be of type `string`. --- @return OID or nil on error. +--

Calls git_oid_fromstrn:

If N is odd, N-1 characters will be parsed instead. +-- The remaining space in the git_oid will be set to zero. +-- @param str input hex string of at least size `length`. Must be of type string. +-- @return OID or nil on error. -- @return Error string. +-- @name OID.hex function OID.hex(str) end ---- Create a new OID object +--- Create a new OID object. -- +--

Calls git_oid_fromraw:

+-- @param raw the raw input bytes to be copied.. Must be of type string. +-- @return OID. -- @name OID.raw --- @param raw Must be of type `string`. --- @return OID. function OID.raw(raw) end --- object method. -- --- @name OID:pathfmt -- @return string. +-- @name OID:pathfmt function OID:pathfmt() end --- object method. -- --- @name OID:fmt -- @return string. +-- @name OID:fmt function OID:fmt() end --- object meta method. -- --- @name OID_mt:__tostring -- @return string. +-- @name OID_mt:__tostring function OID_mt:__tostring() end --- object meta method. -- --- @name OID_mt:__eq --- @param id Must be of type `OID`. +--

Calls git_oid_cmp:

+-- @param id Must be of type OID. -- @return integer. +-- @name OID_mt:__eq function OID_mt:__eq(id) end diff --git a/git2/OID_Shorten.luadoc b/git2/OID_Shorten.luadoc index 9a2e0eb..5311517 100644 --- a/git2/OID_Shorten.luadoc +++ b/git2/OID_Shorten.luadoc @@ -4,23 +4,33 @@ --- Class "OID_Shorten". -- ---
module("OID_Shorten") ---- Create a new OID_Shorten object +--- Create a new OID_Shorten object. -- +--

Calls git_oid_shorten_new:

The OID shortener is used to process a list of OIDs +-- in text form and return the shortest length that would +-- uniquely identify all of them.

E.g. look at the result of `git log --abbrev`. +-- @param min_length The minimal length for all identifiers, which will be used even if shorter OIDs would still be unique.. Must be of type integer. +-- @return OID_Shorten. -- @name OID_Shorten.new --- @param min_length Must be of type `integer`. --- @return OID_Shorten. function OID_Shorten.new(min_length) end --- object method. -- --- @name OID_Shorten:add --- @param text_oid Must be of type `string`. +--

Calls git_oid_shorten_add:

The OID is expected to be a 40-char hexadecimal string. +-- The OID is owned by the user and will not be modified +-- or freed.

For performance reasons, there is a hard-limit of how many +-- OIDs can be added to a single set (around ~22000, assuming +-- a mostly randomized distribution), which should be enough +-- for any kind of program, and keeps the algorithm fast and +-- memory-efficient.

Attempting to add more than those OIDs will result in a +-- GIT_ENOMEM error +-- @param text_oid an OID in text form. Must be of type string. -- @return true if no error. -- @return Error string. +-- @name OID_Shorten:add function OID_Shorten:add(text_oid) end diff --git a/git2/Object.luadoc b/git2/Object.luadoc index 20b3b54..9af2cb6 100644 --- a/git2/Object.luadoc +++ b/git2/Object.luadoc @@ -4,53 +4,60 @@ --- Class "Object". -- ---
--- Subclass Blob
--- Subclass Commit
--- Subclass Tree
--- Subclass Tag
module("Object") ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_object_free:

This method instructs the library to close an existing +-- object; note that git_objects are owned and cached by the repository +-- so the object may or may not be freed after this library call, +-- depending on how agressive is the caching mechanism used +-- by the repository.

IMPORTANT: +-- It *is* necessary to call this method when you stop using +-- an object. Failure to do so will cause a memory leak. -- @name Object:free function Object:free() end --- object method. -- +--

Calls git_object_id:

+-- @return OID. -- @name Object:id --- @return OID. function Object:id() end --- object method. -- --- @name Object:type +--

Calls git_object_type:

-- @return string. +-- @name Object:type function Object:type() end --- object method. -- +--

Calls git_object_owner:

Freeing or calling `git_repository_close` on the +-- returned pointer will invalidate the actual object.

Any other operation may be run on the repository without +-- affecting the object. +-- @return Repository. -- @name Object:owner --- @return Repository. function Object:owner() end ---- module function +--- module function. -- --- @name Object.type2string --- @param otype Must be of type `integer`. +-- @param otype Must be of type integer. -- @return string. +-- @name Object.type2string function Object.type2string(otype) end ---- module function +--- module function. -- --- @name Object.string2type --- @param str Must be of type `string`. +-- @param str Must be of type string. -- @return integer. +-- @name Object.string2type function Object.string2type(str) end diff --git a/git2/OdbObject.luadoc b/git2/OdbObject.luadoc index d5616ae..b08dd12 100644 --- a/git2/OdbObject.luadoc +++ b/git2/OdbObject.luadoc @@ -4,40 +4,49 @@ --- Class "OdbObject". -- ---
module("OdbObject") ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_odb_object_free:

This method must always be called once a `git_odb_object` is no +-- longer needed, otherwise memory will leak. -- @name OdbObject:free function OdbObject:free() end --- object method. -- +--

Calls git_odb_object_id:

This is the OID from which the object was read from +-- @return OID. -- @name OdbObject:id --- @return OID. function OdbObject:id() end --- object method. -- --- @name OdbObject:data +--

Calls git_odb_object_data:

This is the uncompressed, raw data as read from the ODB, +-- without the leading header.

This pointer is owned by the object and shall not be free'd. +--

Calls git_odb_object_size:

This is the real size of the `data` buffer, not the +-- actual size of the object. -- @return string. +-- @name OdbObject:data function OdbObject:data() end --- object method. -- --- @name OdbObject:size +--

Calls git_odb_object_size:

This is the real size of the `data` buffer, not the +-- actual size of the object. -- @return integer. +-- @name OdbObject:size function OdbObject:size() end --- object method. -- --- @name OdbObject:type +--

Calls git_odb_object_type:

-- @return string. +-- @name OdbObject:type function OdbObject:type() end diff --git a/git2/Reference.luadoc b/git2/Reference.luadoc index 7e45839..4c4fae9 100644 --- a/git2/Reference.luadoc +++ b/git2/Reference.luadoc @@ -4,114 +4,145 @@ --- Class "Reference". -- ---
module("Reference") ---- Create a new Reference object +--- Create a new Reference object. -- --- @name Reference.lookup --- @param repo Must be of type `Repository`. --- @param name Must be of type `string`. --- @return Reference or nil on error. +--

Calls git_reference_lookup:

The generated reference must be freed by the user. +-- @param repo the repository to look up the reference. Must be of type Repository. +-- @param name the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...). Must be of type string. +-- @return Reference or nil on error. -- @return Error string. +-- @name Reference.lookup function Reference.lookup(repo, name) end --- object method. -- +--

Calls git_reference_oid:

Only available if the reference is direct (i.e. not symbolic) +-- @return OID. -- @name Reference:oid --- @return OID. function Reference:oid() end --- object method. -- --- @name Reference:set_oid --- @param oid Must be of type `OID`. +--

Calls git_reference_set_oid:

The reference must be a direct reference, otherwise +-- this method will fail.

The reference will be automatically updated in +-- memory and on disk. +-- @param oid Must be of type OID. -- @return true if no error. -- @return Error string. +-- @name Reference:set_oid function Reference:set_oid(oid) end --- object method. -- --- @name Reference:target +--

Calls git_reference_target:

Only available if the reference is symbolic -- @return string. +-- @name Reference:target function Reference:target() end --- object method. -- --- @name Reference:set_target --- @param target Must be of type `string`. +--

Calls git_reference_set_target:

The reference must be a symbolic reference, otherwise +-- this method will fail.

The reference will be automatically updated in +-- memory and on disk. +-- @param target The new target for the reference. Must be of type string. -- @return true if no error. -- @return Error string. +-- @name Reference:set_target function Reference:set_target(target) end --- object method. -- --- @name Reference:type +--

Calls git_reference_type:

Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) -- @return integer. +-- @name Reference:type function Reference:type() end --- object method. -- --- @name Reference:name +--

Calls git_reference_name:

-- @return string. +-- @name Reference:name function Reference:name() end --- object method. -- --- @name Reference:resolve --- @return Reference or nil on error. +--

Calls git_reference_resolve:

Thie method iteratively peels a symbolic reference +-- until it resolves to a direct reference to an OID.

The peeled reference is returned in the `resolved_ref` +-- argument, and must be freed manually once it's no longer +-- needed.

If a direct reference is passed as an argument, +-- a copy of that reference is returned. This copy must +-- be manually freed too. +-- @return Reference or nil on error. -- @return Error string. +-- @name Reference:resolve function Reference:resolve() end --- object method. -- +--

Calls git_reference_owner:

+-- @return Repository. -- @name Reference:owner --- @return Repository. function Reference:owner() end --- object method. -- --- @name Reference:rename --- @param new_name Must be of type `string`. --- @param force Must be of type `boolean`. +--

Calls git_reference_rename:

This method works for both direct and symbolic references. +-- The new name will be checked for validity and may be +-- modified into a normalized form.

The given git_reference will be updated in place.

The reference will be immediately renamed in-memory +-- and on disk.

If the `force` flag is not enabled, and there's already +-- a reference with the given name, the renaming will fail.

IMPORTANT: +-- The user needs to write a proper reflog entry if the +-- reflog is enabled for the repository. We only rename +-- the reflog if it exists. +-- @param new_name The new name for the reference. Must be of type string. +-- @param force Overwrite an existing reference. Must be of type boolean. -- @return true if no error. -- @return Error string. +-- @name Reference:rename function Reference:rename(new_name, force) end --- object method. -- --- @name Reference:delete +--

Calls git_reference_delete:

This method works for both direct and symbolic references.

The reference will be immediately removed on disk and from +-- memory. The given reference pointer will no longer be valid. -- @return true if no error. -- @return Error string. +-- @name Reference:delete function Reference:delete() end ---- module function +--- module function. -- --- @name Reference.packall --- @param repo Must be of type `Repository`. +--

Calls git_reference_packall:

This method will load into the cache all the loose +-- references on the repository and update the +-- `packed-refs` file with them.

Once the `packed-refs` file has been written properly, +-- the loose references will be removed from disk. +-- @param repo Repository where the loose refs will be packed. Must be of type Repository. -- @return true if no error. -- @return Error string. +-- @name Reference.packall function Reference.packall(repo) end ---- module function +--- module function. -- --- @name Reference.list --- @param repo Must be of type `Repository`. --- @param list_flags Must be of type `integer`. --- @return StrArray or nil on error. +-- @param repo Must be of type Repository. +-- @param list_flags Must be of type integer. +-- @return StrArray or nil on error. -- @return Error string. +-- @name Reference.list function Reference.list(repo, list_flags) end diff --git a/git2/Repository.luadoc b/git2/Repository.luadoc index 8cbf366..3be21a3 100644 --- a/git2/Repository.luadoc +++ b/git2/Repository.luadoc @@ -4,129 +4,174 @@ --- Class "Repository". -- ---
module("Repository") ---- Create a new Repository object +--- Create a new Repository object. -- --- @name Repository.open --- @param path Must be of type `string`. --- @return Repository or nil on error. +--

Calls git_repository_open:

The 'path' argument must point to either a git repository +-- folder, or an existing work dir.

The method will automatically detect if 'path' is a normal +-- or bare repository or fail is 'path' is neither. +-- @param path the path to the repository. Must be of type string. +-- @return Repository or nil on error. -- @return Error string. +-- @name Repository.open function Repository.open(path) end ---- Create a new Repository object +--- Create a new Repository object. -- --- @name Repository.init --- @param path Must be of type `string`. --- @param is_bare Must be of type `integer`. --- @return Repository or nil on error. +--

Calls git_repository_init:

TODO: +-- - Reinit the repository +-- @param path the path to the repository. Must be of type string. +-- @param is_bare if true, a Git repository without a working directory is created at the pointed path. If false, provided path will be considered as the working directory into which the .git directory will be created.. Must be of type integer. +-- @return Repository or nil on error. -- @return Error string. +-- @name Repository.init function Repository.init(path, is_bare) end --- object method. -- --- @name Repository:head --- @return Reference or nil on error. +--

Calls git_repository_head:

+-- @return Reference or nil on error. -- @return Error string. +-- @name Repository:head function Repository:head() end --- object method. -- --- @name Repository:head_detached +--

Calls git_repository_head_detached:

A repository's HEAD is detached when it points directly to a commit +-- instead of a branch. -- @return boolean. +-- @name Repository:head_detached function Repository:head_detached() end --- object method. -- --- @name Repository:head_orphan +--

Calls git_repository_head_orphan:

An orphan branch is one named from HEAD but which doesn't exist in +-- the refs namespace, because it doesn't have any commit to point to. -- @return boolean. +-- @name Repository:head_orphan function Repository:head_orphan() end --- object method. -- --- @name Repository:is_empty +--

Calls git_repository_is_empty:

An empty repository has just been initialized and contains +-- no commits. -- @return boolean. +-- @name Repository:is_empty function Repository:is_empty() end --- object method. -- --- @name Repository:is_bare +--

Calls git_repository_is_bare:

-- @return boolean. +-- @name Repository:is_bare function Repository:is_bare() end --- object method. -- --- @name Repository:path +--

Calls git_repository_path:

This is the path of the `.git` folder for normal repositories, +-- or of the repository itself for bare repositories. -- @return string. +-- @name Repository:path function Repository:path() end --- object method. -- --- @name Repository:workdir +--

Calls git_repository_workdir:

If the repository is bare, this function will always return +-- NULL. -- @return string. +-- @name Repository:workdir function Repository:workdir() end --- object method. -- --- @name Repository:set_workdir --- @param workdir Must be of type `string`. +--

Calls git_repository_set_workdir:

The working directory doesn't need to be the same one +-- that contains the `.git` folder for this repository.

If this repository is bare, setting its working directory +-- will turn it into a normal repository, capable of performing +-- all the common workdir operations (checkout, status, index +-- manipulation, etc). +-- @param workdir The path to a working directory. Must be of type string. -- @return true if no error. -- @return Error string. +-- @name Repository:set_workdir function Repository:set_workdir(workdir) end --- object method. -- --- @name Repository:config --- @return Config or nil on error. +--

Calls git_repository_config:

If a configuration file has not been set, the default +-- config set for the repository will be returned, including +-- global and system configurations (if they are available).

The configuration file must be freed once it's no longer +-- being used by the user. +-- @return Config or nil on error. -- @return Error string. +-- @name Repository:config function Repository:config() end --- object method. -- +--

Calls git_repository_set_config:

This configuration file will be used for all configuration +-- queries involving this repository.

The repository will keep a reference to the config file; +-- the user must still free the config after setting it +-- to the repository, or it will leak. +-- @param config A Config object. Must be of type Config. -- @name Repository:set_config --- @param config Must be of type `Config`. function Repository:set_config(config) end --- object method. -- --- @name Repository:odb --- @return ODB or nil on error. +--

Calls git_repository_odb:

If a custom ODB has not been set, the default +-- database for the repository will be returned (the one +-- located in `.git/objects`).

The ODB must be freed once it's no longer being used by +-- the user. +-- @return ODB or nil on error. -- @return Error string. +-- @name Repository:odb function Repository:odb() end --- object method. -- +--

Calls git_repository_set_odb:

The ODB will be used for all object-related operations +-- involving this repository.

The repository will keep a reference to the ODB; the user +-- must still free the ODB object after setting it to the +-- repository, or it will leak. +-- @param odb An ODB object. Must be of type ODB. -- @name Repository:set_odb --- @param odb Must be of type `ODB`. function Repository:set_odb(odb) end --- object method. -- --- @name Repository:index --- @return Index or nil on error. +--

Calls git_repository_index:

If a custom index has not been set, the default +-- index for the repository will be returned (the one +-- located in `.git/index`).

The index must be freed once it's no longer being used by +-- the user. +-- @return Index or nil on error. -- @return Error string. +-- @name Repository:index function Repository:index() end --- object method. -- +--

Calls git_repository_set_index:

This index will be used for all index-related operations +-- involving this repository.

The repository will keep a reference to the index file; +-- the user must still free the index after setting it +-- to the repository, or it will leak. +-- @param index An index object. Must be of type Index. -- @name Repository:set_index --- @param index Must be of type `Index`. function Repository:set_index(index) end diff --git a/git2/RevWalk.luadoc b/git2/RevWalk.luadoc index 5836a1c..c0c8794 100644 --- a/git2/RevWalk.luadoc +++ b/git2/RevWalk.luadoc @@ -4,67 +4,93 @@ --- Class "RevWalk". -- ---
module("RevWalk") ---- Create a new RevWalk object +--- Create a new RevWalk object. -- --- @name RevWalk.new --- @param repo Must be of type `Repository`. --- @return RevWalk or nil on error. +--

Calls git_revwalk_new:

This revision walker uses a custom memory pool and an internal +-- commit cache, so it is relatively expensive to allocate.

For maximum performance, this revision walker should be +-- reused for different walks.

This revision walker is *not* thread safe: it may only be +-- used to walk a repository on a single thread; however, +-- it is possible to have several revision walkers in +-- several different threads walking the same repository. +-- @param repo the repo to walk through. Must be of type Repository. +-- @return RevWalk or nil on error. -- @return Error string. +-- @name RevWalk.new function RevWalk.new(repo) end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_revwalk_free:

-- @name RevWalk:close function RevWalk:close() end --- object method. -- +--

Calls git_revwalk_reset:

This will clear all the pushed and hidden commits, and +-- leave the walker in a blank state (just like at +-- creation) ready to receive new commit pushes and +-- start a new walk.

The revision walk is automatically reset when a walk +-- is over. -- @name RevWalk:reset function RevWalk:reset() end --- object method. -- --- @name RevWalk:push --- @param id Must be of type `OID`. +--

Calls git_revwalk_push:

The given OID must belong to a commit on the walked +-- repository.

The given commit will be used as one of the roots +-- when starting the revision walk. At least one commit +-- must be pushed the repository before a walk can +-- be started. +-- @param id Must be of type OID. -- @return true if no error. -- @return Error string. +-- @name RevWalk:push function RevWalk:push(id) end --- object method. -- --- @name RevWalk:hide --- @param id Must be of type `OID`. +--

Calls git_revwalk_hide:

The given OID must belong to a commit on the walked +-- repository.

The resolved commit and all its parents will be hidden from the +-- output on the revision walk. +-- @param id Must be of type OID. -- @return true if no error. -- @return Error string. +-- @name RevWalk:hide function RevWalk:hide(id) end --- object method. -- --- @name RevWalk:next --- @return OID or nil on error. +--

Calls git_revwalk_next:

The initial call to this method is *not* blocking when +-- iterating through a repo with a time-sorting mode.

Iterating with Topological or inverted modes makes the initial +-- call blocking to preprocess the commit list, but this block should be +-- mostly unnoticeable on most repositories (topological preprocessing +-- times at 0.3s on the git.git repo).

The revision walker is reset when the walk is over. +-- @return OID or nil on error. -- @return Error string. +-- @name RevWalk:next function RevWalk:next() end --- object method. -- +--

Calls git_revwalk_sorting:

Changing the sorting mode resets the walker. +-- @param sort_mode combination of GIT_SORT_XXX flags. Must be of type integer. -- @name RevWalk:sorting --- @param sort_mode Must be of type `integer`. function RevWalk:sorting(sort_mode) end --- object method. -- +--

Calls git_revwalk_repository:

+-- @return Repository. -- @name RevWalk:repository --- @return Repository. function RevWalk:repository() end diff --git a/git2/Signature.luadoc b/git2/Signature.luadoc index efe73ba..e8802f5 100644 --- a/git2/Signature.luadoc +++ b/git2/Signature.luadoc @@ -4,50 +4,51 @@ --- Class "Signature". -- ---
module("Signature") ---- Create a new Signature object --- --- @name Signature.new --- @param name Must be of type `string`. --- @param email Must be of type `string`. --- @param time Must be of type `integer`. --- @param offset Must be of type `integer`. --- @return Signature or nil on error. +--- Create a new Signature object. +-- +--

Calls git_signature_new:

+-- @param name name of the person. Must be of type string. +-- @param email email of the person. Must be of type string. +-- @param time time when the action happened. Must be of type integer. +-- @param offset timezone offset in minutes for the time. Must be of type integer. +-- @return Signature or nil on error. -- @return Error string. +-- @name Signature.new function Signature.new(name, email, time, offset) end ---- Create a new Signature object +--- Create a new Signature object. -- --- @name Signature.now --- @param name Must be of type `string`. --- @param email Must be of type `string`. --- @return Signature or nil on error. +--

Calls git_signature_now:

+-- @param name name of the person. Must be of type string. +-- @param email email of the person. Must be of type string. +-- @return Signature or nil on error. -- @return Error string. +-- @name Signature.now function Signature.now(name, email) end --- object method. -- --- @name Signature:name -- @return string. +-- @name Signature:name function Signature:name() end --- object method. -- --- @name Signature:email -- @return string. +-- @name Signature:email function Signature:email() end --- object method. -- --- @name Signature:when -- @return integer. -- @return integer. +-- @name Signature:when function Signature:when() end diff --git a/git2/StrArray.luadoc b/git2/StrArray.luadoc index 7fa9d6c..1be8f9c 100644 --- a/git2/StrArray.luadoc +++ b/git2/StrArray.luadoc @@ -4,17 +4,16 @@ --- Class "StrArray". -- ---
module("StrArray") ---- Create a new StrArray object +--- Create a new StrArray object. -- +-- @return StrArray. -- @name StrArray.new --- @return StrArray. function StrArray.new() end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- -- @name StrArray:free function StrArray:free() @@ -22,23 +21,23 @@ end --- object method. -- --- @name StrArray:str --- @param n Must be of type `integer`. +-- @param n Must be of type integer. -- @return string. +-- @name StrArray:str function StrArray:str(n) end --- object method. -- --- @name StrArray:get_array -- @return nil. +-- @name StrArray:get_array function StrArray:get_array() end --- object method. -- --- @name StrArray:count -- @return integer. +-- @name StrArray:count function StrArray:count() end diff --git a/git2/Tag.luadoc b/git2/Tag.luadoc index d28fb98..653cc9e 100644 --- a/git2/Tag.luadoc +++ b/git2/Tag.luadoc @@ -5,72 +5,89 @@ --- Class "Tag". -- -- Extends Object
---
module("Tag") ---- Create a new Tag object +--- Create a new Tag object. -- --- @name Tag.lookup --- @param repo Must be of type `Repository`. --- @param id Must be of type `OID`. --- @return Tag or nil on error. +--

Calls git_tag_lookup:

+-- @param repo the repo to use when locating the tag.. Must be of type Repository. +-- @param id identity of the tag to locate.. Must be of type OID. +-- @return Tag or nil on error. -- @return Error string. +-- @name Tag.lookup function Tag.lookup(repo, id) end --- object method. -- --- @name Tag:target --- @return Object or nil on error. +--

Calls git_tag_target:

This method performs a repository lookup for the +-- given object and returns it +-- @return Object or nil on error. -- @return Error string. +-- @name Tag:target function Tag:target() end --- object method. -- --- @name Tag:name +--

Calls git_tag_name:

-- @return string. +-- @name Tag:name function Tag:name() end --- object method. -- +--

Calls git_tag_tagger:

+-- @return Signature. -- @name Tag:tagger --- @return Signature. function Tag:tagger() end --- object method. -- --- @name Tag:message +--

Calls git_tag_message:

-- @return string. +-- @name Tag:message function Tag:message() end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_object_free:

This method instructs the library to close an existing +-- object; note that git_objects are owned and cached by the repository +-- so the object may or may not be freed after this library call, +-- depending on how agressive is the caching mechanism used +-- by the repository.

IMPORTANT: +-- It *is* necessary to call this method when you stop using +-- an object. Failure to do so will cause a memory leak. -- @name Object:free function Object:free() end --- object method. -- +--

Calls git_object_id:

+-- @return OID. -- @name Object:id --- @return OID. function Object:id() end --- object method. -- --- @name Object:type +--

Calls git_object_type:

-- @return string. +-- @name Object:type function Object:type() end --- object method. -- +--

Calls git_object_owner:

Freeing or calling `git_repository_close` on the +-- returned pointer will invalidate the actual object.

Any other operation may be run on the repository without +-- affecting the object. +-- @return Repository. -- @name Object:owner --- @return Repository. function Object:owner() end diff --git a/git2/Tree.luadoc b/git2/Tree.luadoc index 58f34a9..7f0831b 100644 --- a/git2/Tree.luadoc +++ b/git2/Tree.luadoc @@ -5,66 +5,81 @@ --- Class "Tree". -- -- Extends Object
---
module("Tree") ---- Create a new Tree object +--- Create a new Tree object. -- --- @name Tree.lookup --- @param repo Must be of type `Repository`. --- @param id Must be of type `OID`. --- @return Tree or nil on error. +--

Calls git_tree_lookup:

+-- @param repo the repo to use when locating the tree.. Must be of type Repository. +-- @param id identity of the tree to locate.. Must be of type OID. +-- @return Tree or nil on error. -- @return Error string. +-- @name Tree.lookup function Tree.lookup(repo, id) end --- object method. -- --- @name Tree:entrycount +--

Calls git_tree_entrycount:

-- @return integer. +-- @name Tree:entrycount function Tree:entrycount() end --- object method. -- +--

Calls git_tree_entry_byname:

+-- @param filename the filename of the desired entry. Must be of type string. +-- @return TreeEntry. -- @name Tree:entry_byname --- @param filename Must be of type `string`. --- @return TreeEntry. function Tree:entry_byname(filename) end --- object method. -- +--

Calls git_tree_entry_byindex:

+-- @param index Must be of type integer. +-- @return TreeEntry. -- @name Tree:entry_byindex --- @param index Must be of type `integer`. --- @return TreeEntry. function Tree:entry_byindex(index) end ---- Destroy this object. +--- Destroy this object (will be called by Garbage Collector). -- +--

Calls git_object_free:

This method instructs the library to close an existing +-- object; note that git_objects are owned and cached by the repository +-- so the object may or may not be freed after this library call, +-- depending on how agressive is the caching mechanism used +-- by the repository.

IMPORTANT: +-- It *is* necessary to call this method when you stop using +-- an object. Failure to do so will cause a memory leak. -- @name Object:free function Object:free() end --- object method. -- +--

Calls git_object_id:

+-- @return OID. -- @name Object:id --- @return OID. function Object:id() end --- object method. -- --- @name Object:type +--

Calls git_object_type:

-- @return string. +-- @name Object:type function Object:type() end --- object method. -- +--

Calls git_object_owner:

Freeing or calling `git_repository_close` on the +-- returned pointer will invalidate the actual object.

Any other operation may be run on the repository without +-- affecting the object. +-- @return Repository. -- @name Object:owner --- @return Repository. function Object:owner() end diff --git a/git2/TreeEntry.luadoc b/git2/TreeEntry.luadoc index 674b1f5..7fb85ea 100644 --- a/git2/TreeEntry.luadoc +++ b/git2/TreeEntry.luadoc @@ -4,36 +4,38 @@ --- Class "TreeEntry". -- ---
module("TreeEntry") --- object method. -- --- @name TreeEntry:name +--

Calls git_tree_entry_name:

-- @return string. +-- @name TreeEntry:name function TreeEntry:name() end --- object method. -- --- @name TreeEntry:attributes +--

Calls git_tree_entry_attributes:

-- @return integer. +-- @name TreeEntry:attributes function TreeEntry:attributes() end --- object method. -- +-- @return OID. -- @name TreeEntry:id --- @return OID. function TreeEntry:id() end --- object method. -- --- @name TreeEntry:object --- @param repo Must be of type `Repository`. --- @return Object or nil on error. +--

Calls git_tree_entry_to_object:

@param object pointer to the converted object +-- @param repo repository where to lookup the pointed object. Must be of type Repository. +-- @return Object or nil on error. -- @return Error string. +-- @name TreeEntry:object function TreeEntry:object(repo) end diff --git a/modules/Blob.html b/modules/Blob.html index 90e19c5..5e01c97 100644 --- a/modules/Blob.html +++ b/modules/Blob.html @@ -133,7 +133,7 @@

Modules

Module Blob

-

Class "Blob". Extends Object

+

Class "Blob". Extends Object

@@ -144,17 +144,17 @@

Functions

Blob.frombuffer (repo, buffer) - module function + module function. Blob.fromfile (repo, path) - module function + module function. Blob.lookup (repo, id) - Create a new Blob object + Create a new Blob object. @@ -169,7 +169,7 @@

Functions

Object:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -206,18 +206,18 @@

Functions

Blob.frombuffer (repo, buffer)
-module function +module function.

Calls git_blob_create_frombuffer:

Parameters

  • - repo: Must be of type `Repository`. + repo: repository where to blob will be written. Must be of type Repository.
  • - buffer: Must be of type `string`. + buffer: data to be written into the blob. Must be of type string.
@@ -230,7 +230,7 @@

Parameters

Return values:

    -
  1. OID or nil on error. +
  2. OID or nil on error.
  3. Error string. @@ -245,18 +245,18 @@

    Return values:

    Blob.fromfile (repo, path)
    -module function +module function.

    Calls git_blob_create_fromfile:

    Parameters

    • - repo: Must be of type `Repository`. + repo: repository where the blob will be written. this repository cannot be bare. Must be of type Repository.
    • - path: Must be of type `string`. + path: file from which the blob will be created, relative to the repository's working dir. Must be of type string.
    @@ -269,7 +269,7 @@

    Parameters

    Return values:

      -
    1. OID or nil on error. +
    2. OID or nil on error.
    3. Error string. @@ -284,18 +284,18 @@

      Return values:

      Blob.lookup (repo, id)
      -Create a new Blob object +Create a new Blob object.

      Calls git_blob_lookup:

      Parameters

      • - repo: Must be of type `Repository`. + repo: the repo to use when locating the blob.. Must be of type Repository.
      • - id: Must be of type `OID`. + id: identity of the blob to locate.. Must be of type OID.
      @@ -308,7 +308,7 @@

      Parameters

      Return values:

        -
      1. Blob or nil on error. +
      2. Blob or nil on error.
      3. Error string. @@ -323,7 +323,7 @@

        Return values:

        Blob:rawcontent ()
        -object method. +object method.

        Calls git_blob_rawcontent:

        A pointer to the raw content of a blob is returned; this pointer is owned internally by the object and shall not be free'd. The pointer may be invalidated at a later time.

        Calls git_blob_rawsize:

        @@ -343,7 +343,7 @@

        Return value:

        Blob:rawsize ()
        -object method. +object method.

        Calls git_blob_rawsize:

        @@ -363,7 +363,7 @@

        Return value:

        Object:free ()
        -Destroy this object. +Destroy this object (will be called by Garbage Collector).

        Calls git_object_free:

        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -380,7 +380,7 @@

        Return value:

        Object:id ()
        -object method. +object method.

        Calls git_object_id:

        @@ -389,7 +389,7 @@

        Return value:

        Return value:

        -OID. +OID. @@ -400,7 +400,7 @@

        Return value:

        Object:owner ()
        -object method. +object method.

        Calls git_object_owner:

        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

        Any other operation may be run on the repository without affecting the object. @@ -409,7 +409,7 @@

        Return value:

        Return value:

        -Repository. +Repository. @@ -420,7 +420,7 @@

        Return value:

        Object:type ()
        -object method. +object method.

        Calls git_object_type:

        diff --git a/modules/Commit.html b/modules/Commit.html index d22ef0a..ab884fb 100644 --- a/modules/Commit.html +++ b/modules/Commit.html @@ -133,7 +133,7 @@

        Modules

        Module Commit

        -

        Class "Commit". Extends Object

        +

        Class "Commit". Extends Object

        @@ -144,12 +144,12 @@

        Functions

        Commit.create (oid, repo, update_ref, author, committer, message_encoding, message, tree, parent) - module function + module function. Commit.lookup (repo, id) - Create a new Commit object + Create a new Commit object. @@ -204,7 +204,7 @@

        Functions

        Object:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -241,46 +241,46 @@

        Functions

        Commit.create (oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)
        -module function +module function.

        Parameters

        • - oid: Must be of type `OID`. + oid: Must be of type OID.
        • - repo: Must be of type `Repository`. + repo: Must be of type Repository.
        • - update_ref: Must be of type `string`. + update_ref: Must be of type string.
        • - author: Must be of type `Signature`. + author: Must be of type Signature.
        • - committer: Must be of type `Signature`. + committer: Must be of type Signature.
        • - message_encoding: Must be of type `string`. + message_encoding: Must be of type string.
        • - message: Must be of type `string`. + message: Must be of type string.
        • - tree: Must be of type `Tree`. + tree: Must be of type Tree.
        • - parent: Must be of type `Commit`. + parent: Must be of type Commit.
        @@ -308,18 +308,18 @@

        Return values:

        Commit.lookup (repo, id)
        -Create a new Commit object +Create a new Commit object.

        Calls git_commit_lookup:

        Parameters

        • - repo: Must be of type `Repository`. + repo: the repo to use when locating the commit.. Must be of type Repository.
        • - id: Must be of type `OID`. + id: identity of the commit to locate. If the object is an annotated tag it will be peeled back to the commit.. Must be of type OID.
        @@ -332,7 +332,7 @@

        Parameters

        Return values:

          -
        1. Commit or nil on error. +
        2. Commit or nil on error.
        3. Error string. @@ -347,7 +347,7 @@

          Return values:

          Commit:author ()
          -object method. +object method.

          Calls git_commit_author:

          @@ -356,7 +356,7 @@

          Return values:

          Return value:

          -Signature. +Signature. @@ -367,7 +367,7 @@

          Return value:

          Commit:committer ()
          -object method. +object method.

          Calls git_commit_committer:

          @@ -376,7 +376,7 @@

          Return value:

          Return value:

          -Signature. +Signature. @@ -387,7 +387,7 @@

          Return value:

          Commit:id ()
          -object method. +object method.

          Calls git_commit_id:

          @@ -396,7 +396,7 @@

          Return value:

          Return value:

          -OID. +OID. @@ -407,7 +407,7 @@

          Return value:

          Commit:message ()
          -object method. +object method.

          Calls git_commit_message:

          @@ -427,7 +427,7 @@

          Return value:

          Commit:message_encoding ()
          -object method. +object method.

          Calls git_commit_message_encoding:

          The encoding may be NULL if the `encoding` header in the commit is missing; in that case UTF-8 is assumed. @@ -447,14 +447,14 @@

          Return value:

          Commit:parent (n)
          -object method. +object method.

          Calls git_commit_parent:

          Parameters

          • - n: Must be of type `integer`. + n: the position of the parent (from 0 to `parentcount`). Must be of type integer.
          @@ -467,7 +467,7 @@

          Parameters

          Return values:

            -
          1. Commit or nil on error. +
          2. Commit or nil on error.
          3. Error string. @@ -482,7 +482,7 @@

            Return values:

            Commit:parentcount ()
            -object method. +object method.

            Calls git_commit_parentcount:

            @@ -502,7 +502,7 @@

            Return value:

            Commit:time ()
            -object method. +object method.

            Calls git_commit_time:

            @@ -522,7 +522,7 @@

            Return value:

            Commit:time_offset ()
            -object method. +object method.

            Calls git_commit_time_offset:

            @@ -542,7 +542,7 @@

            Return value:

            Commit:tree ()
            -object method. +object method.

            Calls git_commit_tree:

            @@ -553,7 +553,7 @@

            Return value:

            Return values:

              -
            1. Tree or nil on error. +
            2. Tree or nil on error.
            3. Error string. @@ -568,7 +568,7 @@

              Return values:

              Object:free ()
              -Destroy this object. +Destroy this object (will be called by Garbage Collector).

              Calls git_object_free:

              This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

              IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -585,7 +585,7 @@

              Return values:

              Object:id ()
              -object method. +object method.

              Calls git_object_id:

              @@ -594,7 +594,7 @@

              Return values:

              Return value:

              -OID. +OID. @@ -605,7 +605,7 @@

              Return value:

              Object:owner ()
              -object method. +object method.

              Calls git_object_owner:

              Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

              Any other operation may be run on the repository without affecting the object. @@ -614,7 +614,7 @@

              Return value:

              Return value:

              -Repository. +Repository. @@ -625,7 +625,7 @@

              Return value:

              Object:type ()
              -object method. +object method.

              Calls git_object_type:

              diff --git a/modules/Config.html b/modules/Config.html index f2c6a2d..213b179 100644 --- a/modules/Config.html +++ b/modules/Config.html @@ -133,7 +133,7 @@

              Modules

              Module Config

              -

              Class "Config".

              +

              Class "Config".

              @@ -144,12 +144,12 @@

              Functions

              Config.new () - Create a new Config object + Create a new Config object. Config.open (path) - Create a new Config object + Create a new Config object. @@ -164,7 +164,7 @@

              Functions

              Config:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -226,7 +226,7 @@

              Functions

              Config.new ()
              -Create a new Config object +Create a new Config object.

              Calls git_config_new:

              This object is empty, so you have to add a file to it before you can do anything with it. @@ -237,7 +237,7 @@

              Functions

              Return values:

                -
              1. Config or nil on error. +
              2. Config or nil on error.
              3. Error string. @@ -252,14 +252,14 @@

                Return values:

                Config.open (path)
                -Create a new Config object +Create a new Config object.

                Calls git_config_open_ondisk:

                This method is a simple utility wrapper for the following sequence of calls: - git_config_new - git_config_add_file_ondisk

                Parameters

                • - path: Must be of type `string`. + path: Path to the on-disk file to open. Must be of type string.
                @@ -272,7 +272,7 @@

                Parameters

                Return values:

                  -
                1. Config or nil on error. +
                2. Config or nil on error.
                3. Error string. @@ -287,18 +287,18 @@

                  Return values:

                  Config:add_file_ondisk (path, priority)
                  -object method. +object method.

                  Calls git_config_add_file_ondisk:

                  The on-disk file pointed at by `path` will be opened and parsed; it's expected to be a native Git config file following the default Git config syntax (see man git-config).

                  Note that the configuration object will free the file automatically.

                  Further queries on this config object will access each of the config file instances in order (instances with a higher priority will be accessed first).

                  Parameters

                  • - path: Must be of type `string`. + path: path to the configuration file (backend) to add. Must be of type string.
                  • - priority: Must be of type `integer`. + priority: the priority the backend should have. Must be of type integer.
                  @@ -326,14 +326,14 @@

                  Return values:

                  Config:delete (name)
                  -object method. +object method.

                  Calls git_config_delete:

                  Parameters

                  • - name: Must be of type `string`. + name: the variable to delete. Must be of type string.
                  @@ -361,7 +361,7 @@

                  Return values:

                  Config:free ()
                  -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                  Calls git_config_free:

                  @@ -378,14 +378,14 @@

                  Return values:

                  Config:get_bool (name)
                  -object method. +object method.

                  Calls git_config_get_bool:

                  This function uses the usual C convention of 0 being false and anything else true.

                  Parameters

                  • - name: Must be of type `string`. + name: the variable's name. Must be of type string.
                  @@ -420,7 +420,7 @@

                  Parameters

                  • - name: Must be of type `string`. + name: Must be of type string.
                  @@ -455,7 +455,7 @@

                  Parameters

                  • - name: Must be of type `string`. + name: Must be of type string.
                  @@ -483,14 +483,14 @@

                  Return values:

                  Config:get_string (name)
                  -object method. +object method.

                  Calls git_config_get_string:

                  The string is owned by the variable and should not be freed by the user.

                  Parameters

                  • - name: Must be of type `string`. + name: the variable's name. Must be of type string.
                  @@ -518,18 +518,18 @@

                  Return values:

                  Config:set_bool (value, name)
                  -object method. +object method.

                  Calls git_config_set_bool:

                  Parameters

                  • - value: Must be of type `boolean`. + value: the value to store. Must be of type boolean.
                  • - name: Must be of type `string`. + name: the variable's name. Must be of type string.
                  @@ -564,11 +564,11 @@

                  Parameters

                  • - name: Must be of type `string`. + name: Must be of type string.
                  • - value: Must be of type `integer`. + value: Must be of type integer.
                  @@ -603,11 +603,11 @@

                  Parameters

                  • - name: Must be of type `string`. + name: Must be of type string.
                  • - value: Must be of type `integer`. + value: Must be of type integer.
                  @@ -635,18 +635,18 @@

                  Return values:

                  Config:set_string (name, value)
                  -object method. +object method.

                  Calls git_config_set_string:

                  A copy of the string is made and the user is free to use it afterwards.

                  Parameters

                  • - name: Must be of type `string`. + name: the variable's name. Must be of type string.
                  • - value: Must be of type `string`. + value: the string to store.. Must be of type string.
                  diff --git a/modules/Index.html b/modules/Index.html index e5f1ad5..8857b39 100644 --- a/modules/Index.html +++ b/modules/Index.html @@ -133,7 +133,7 @@

                  Modules

                  Module Index

                  -

                  Class "Index".

                  +

                  Class "Index".

                  @@ -144,7 +144,7 @@

                  Functions

                  Index.bare (index_path) - Create a new Index object + Create a new Index object. @@ -246,14 +246,14 @@

                  Functions

                  Index.bare (index_path)
                  -Create a new Index object +Create a new Index object.

                  Calls git_index_open:

                  Since there is no ODB or working directory behind this index, any Index methods which rely on these (e.g. index_add) will fail with the GIT_EBAREINDEX error code.

                  If you need to access the index of an actual repository, use the `git_repository_index` wrapper.

                  The index must be freed once it's no longer in use.

                  Parameters

                  • - index_path: Must be of type `string`. + index_path: the path to the index file in disk. Must be of type string.
                  @@ -266,7 +266,7 @@

                  Parameters

                  Return values:

                    -
                  1. Index or nil on error. +
                  2. Index or nil on error.
                  3. Error string. @@ -281,18 +281,18 @@

                    Return values:

                    Index:add (path, stage)
                    -object method. +object method.

                    Calls git_index_add:

                    The file `path` must be relative to the repository's working folder and must be readable.

                    This method will fail in bare index instances.

                    This forces the file to be added to the index, not looking at gitignore rules. Those rules can be evaluated through the git_status APIs (in status.h) before calling this.

                    Parameters

                    • - path: Must be of type `string`. + path: filename to add. Must be of type string.
                    • - stage: Must be of type `integer`. + stage: stage for the entry. Must be of type integer.
                    @@ -327,7 +327,7 @@

                    Parameters

                    • - source_entry: Must be of type `IndexEntry`. + source_entry: Must be of type IndexEntry.
                    @@ -355,18 +355,18 @@

                    Return values:

                    Index:append (path, stage)
                    -object method. +object method.

                    Calls git_index_append:

                    A new entry will always be inserted into the index; if the index already contains an entry for such path, the old entry will **not** be replaced.

                    The file `path` must be relative to the repository's working folder and must be readable.

                    This method will fail in bare index instances.

                    Parameters

                    • - path: Must be of type `string`. + path: filename to add. Must be of type string.
                    • - stage: Must be of type `integer`. + stage: stage for the entry. Must be of type integer.
                    @@ -401,7 +401,7 @@

                    Parameters

                    • - source_entry: Must be of type `IndexEntry`. + source_entry: Must be of type IndexEntry.
                    @@ -429,7 +429,7 @@

                    Return values:

                    Index:clear ()
                    -object method. +object method.

                    Calls git_index_clear:

                    @@ -446,7 +446,7 @@

                    Return values:

                    Index:entrycount ()
                    -object method. +object method.

                    Calls git_index_entrycount:

                    @@ -466,7 +466,7 @@

                    Return value:

                    Index:entrycount_unmerged ()
                    -object method. +object method.

                    Calls git_index_entrycount_unmerged:

                    @@ -486,14 +486,14 @@

                    Return value:

                    Index:find (path)
                    -object method. +object method.

                    Calls git_index_find:

                    Parameters

                    • - path: Must be of type `string`. + path: path to search. Must be of type string.
                    @@ -515,14 +515,14 @@

                    Return value:

                    Index:get (n)
                    -object method. +object method.

                    Calls git_index_get:

                    This entry can be modified, and the changes will be written back to disk on the next write() call.

                    The entry should not be freed by the caller.

                    Parameters

                    • - n: Must be of type `integer`. + n: the position of the entry. Must be of type integer.
                    @@ -533,7 +533,7 @@

                    Parameters

                    Return value:

                    -IndexEntry. +IndexEntry. @@ -544,14 +544,14 @@

                    Return value:

                    Index:get_unmerged_byindex (n)
                    -object method. +object method.

                    Calls git_index_get_unmerged_byindex:

                    The returned entry is read-only and should not be modified of freed by the caller.

                    Parameters

                    • - n: Must be of type `integer`. + n: the position of the entry. Must be of type integer.
                    @@ -562,7 +562,7 @@

                    Parameters

                    Return value:

                    -IndexEntryUnmerged. +IndexEntryUnmerged. @@ -573,14 +573,14 @@

                    Return value:

                    Index:get_unmerged_bypath (path)
                    -object method. +object method.

                    Calls git_index_get_unmerged_bypath:

                    The returned entry is read-only and should not be modified of freed by the caller.

                    Parameters

                    • - path: Must be of type `string`. + path: path to search. Must be of type string.
                    @@ -591,7 +591,7 @@

                    Parameters

                    Return value:

                    -IndexEntryUnmerged. +IndexEntryUnmerged. @@ -602,7 +602,7 @@

                    Return value:

                    Index:read ()
                    -object method. +object method.

                    Calls git_index_read:

                    @@ -628,14 +628,14 @@

                    Return values:

                    Index:read_tree (tree)
                    -object method. +object method.

                    Calls git_index_read_tree:

                    The current index contents will be replaced by the specified tree.

                    Parameters

                    • - tree: Must be of type `Tree`. + tree: tree to read. Must be of type Tree.
                    @@ -663,14 +663,14 @@

                    Return values:

                    Index:remove (position)
                    -object method. +object method.

                    Calls git_index_remove:

                    Parameters

                    • - position: Must be of type `integer`. + position: position of the entry to remove. Must be of type integer.
                    @@ -698,7 +698,7 @@

                    Return values:

                    Index:uniq ()
                    -object method. +object method.

                    Calls git_index_uniq:

                    @@ -715,7 +715,7 @@

                    Return values:

                    Index:write ()
                    -object method. +object method.

                    Calls git_index_write:

                    diff --git a/modules/IndexEntry.html b/modules/IndexEntry.html index 153ac8e..4ff440e 100644 --- a/modules/IndexEntry.html +++ b/modules/IndexEntry.html @@ -133,7 +133,7 @@

                    Modules

                    Module IndexEntry

                    -

                    Class "IndexEntry".

                    +

                    Class "IndexEntry".

                    @@ -144,7 +144,7 @@

                    Functions

                    IndexEntry.new () - Create a new IndexEntry object + Create a new IndexEntry object. @@ -246,7 +246,7 @@

                    Functions

                    IndexEntry.new ()
                    -Create a new IndexEntry object +Create a new IndexEntry object. @@ -255,7 +255,7 @@

                    Functions

                    Return value:

                    -IndexEntry. +IndexEntry. @@ -467,7 +467,7 @@

                    Return values:

                    Return value:

                    -OID. +OID. @@ -505,11 +505,11 @@

                    Parameters

                    • - secs: Must be of type `integer`. + secs: Must be of type integer.
                    • - nanosecs: Must be of type `integer`. + nanosecs: Must be of type integer.
                    @@ -535,11 +535,11 @@

                    Parameters

                    • - secs: Must be of type `integer`. + secs: Must be of type integer.
                    • - nanosecs: Must be of type `integer`. + nanosecs: Must be of type integer.
                    @@ -565,7 +565,7 @@

                    Parameters

                    • - val: Must be of type `string`. + val: Must be of type string.
                    @@ -584,7 +584,7 @@

                    Parameters

                    IndexEntry:stage ()
                    -object method. +object method.

                    Calls git_index_entry_stage:

                    This entry is calculated from the entrie's flag diff --git a/modules/IndexEntryUnmerged.html b/modules/IndexEntryUnmerged.html index 2a39d7a..e8e5b22 100644 --- a/modules/IndexEntryUnmerged.html +++ b/modules/IndexEntryUnmerged.html @@ -133,7 +133,7 @@

                    Modules

                    Module IndexEntryUnmerged

                    -

                    Class "IndexEntryUnmerged".

                    +

                    Class "IndexEntryUnmerged".

                    @@ -183,7 +183,7 @@

                    Parameters

                    • - idx: Must be of type `integer`. + idx: Must be of type integer.
                    @@ -212,7 +212,7 @@

                    Parameters

                    • - idx: Must be of type `integer`. + idx: Must be of type integer.
                    @@ -223,7 +223,7 @@

                    Parameters

                    Return value:

                    -OID. +OID. diff --git a/modules/ODB.html b/modules/ODB.html index a14188a..1076315 100644 --- a/modules/ODB.html +++ b/modules/ODB.html @@ -133,7 +133,7 @@

                    Modules

                    Module ODB

                    -

                    Class "ODB".

                    +

                    Class "ODB".

                    @@ -143,23 +143,23 @@

                    Functions

                    - - + + - + - + - + @@ -179,7 +179,7 @@

                    Functions

                    - + @@ -198,7 +198,7 @@

                    Functions

                    - + @@ -219,20 +219,20 @@

                    Functions

                    -
                    ODB.hash (data2, otype)
                    +
                    ODB.hash (data, otype)
                    -module function +module function.

                    Calls git_odb_hash:

                    The resulting SHA-1 OID will the itentifier for the data buffer as if the data buffer it were to written to the ODB.

                    Parameters

                    • - data2: Must be of type `string`. + data: data to hash. Must be of type string.
                    • - otype: Must be of type `integer`. + otype: Must be of type integer.
                    @@ -245,7 +245,7 @@

                    Parameters

                    Return values:

                      -
                    1. OID or nil on error. +
                    2. OID or nil on error.
                    3. Error string. @@ -260,18 +260,18 @@

                      Return values:

                      ODB.hashfile (path, otype)
                      -module function +module function.

                      Calls git_odb_hashfile:

                      Parameters

                      • - path: Must be of type `string`. + path: file to read and determine object id for. Must be of type string.
                      • - otype: Must be of type `integer`. + otype: Must be of type integer.
                      @@ -284,7 +284,7 @@

                      Parameters

                      Return values:

                        -
                      1. OID or nil on error. +
                      2. OID or nil on error.
                      3. Error string. @@ -299,7 +299,7 @@

                        Return values:

                        ODB.new ()
                        -Create a new ODB object +Create a new ODB object.

                        Calls git_odb_new:

                        Before the ODB can be used for read/writing, a custom database backend must be manually added using `git_odb_add_backend()` @@ -310,7 +310,7 @@

                        Return values:

                        Return values:

                          -
                        1. ODB or nil on error. +
                        2. ODB or nil on error.
                        3. Error string. @@ -325,14 +325,14 @@

                          Return values:

                          ODB.open (object_dir)
                          -Create a new ODB object +Create a new ODB object.

                          Calls git_odb_open:

                          - git_odb_backend_loose: read and write loose object files from disk, assuming `objects_dir` as the Objects folder

                          - git_odb_backend_pack: read objects from packfiles, assuming `objects_dir` as the Objects folder which contains a 'pack/' folder with the corresponding data

                          Parameters

                          • - object_dir: Must be of type `string`. + object_dir: Must be of type string.
                          @@ -345,7 +345,7 @@

                          Parameters

                          Return values:

                            -
                          1. ODB or nil on error. +
                          2. ODB or nil on error.
                          3. Error string. @@ -367,11 +367,11 @@

                            Parameters

                            • - backend: Must be of type `ODBBackend`. + backend: Must be of type ODBBackend.
                            • - priority: Must be of type `integer`. + priority: Must be of type integer.
                            @@ -406,11 +406,11 @@

                            Parameters

                            • - backend: Must be of type `ODBBackend`. + backend: Must be of type ODBBackend.
                            • - priority: Must be of type `integer`. + priority: Must be of type integer.
                            @@ -438,14 +438,14 @@

                            Return values:

                            ODB:exists (id)
                            -object method. +object method.

                            Calls git_odb_exists:

                            @return - 1, if the object was found - 0, otherwise

                            Parameters

                            • - id: Must be of type `OID`. + id: the object to search for.. Must be of type OID.
                            @@ -473,7 +473,7 @@

                            Return values:

                            ODB:free ()
                            -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                            Calls git_odb_free:

                            @@ -490,14 +490,14 @@

                            Return values:

                            ODB:read (id)
                            -object method. +object method.

                            Calls git_odb_read:

                            This method queries all available ODB backends trying to read the given OID.

                            The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.

                            @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database.

                            Parameters

                            • - id: Must be of type `OID`. + id: identity of the object to read.. Must be of type OID.
                            @@ -510,7 +510,7 @@

                            Parameters

                            Return values:

                              -
                            1. OdbObject or nil on error. +
                            2. OdbObject or nil on error.
                            3. Error string. @@ -525,14 +525,14 @@

                              Return values:

                              ODB:read_header (id)
                              -object method. +object method.

                              Calls git_odb_read_header:

                              The header includes the length and the type of an object.

                              Note that most backends do not support reading only the header of an object, so the whole object will be read and then the header will be returned.

                              @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database.

                              Parameters

                              • - id: Must be of type `OID`. + id: identity of the object to read.. Must be of type OID.
                              @@ -562,18 +562,18 @@

                              Return values:

                              ODB:read_prefix (short_id, len)
                              -object method. +object method.

                              Calls git_odb_read_prefix:

                              This method queries all available ODB backends trying to match the 'len' first hexadecimal characters of the 'short_id'. The remaining (GIT_OID_HEXSZ-len)*4 bits of 'short_id' must be 0s. 'len' must be at least GIT_OID_MINPREFIXLEN, and the prefix must be long enough to identify a unique object in all the backends; the method will fail otherwise.

                              The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.

                              Parameters

                              • - short_id: Must be of type `OID`. + short_id: a prefix of the id of the object to read.. Must be of type OID.
                              • - len: Must be of type `integer`. + len: the length of the prefix. Must be of type integer.
                              @@ -586,7 +586,7 @@

                              Parameters

                              Return values:

                                -
                              1. OdbObject or nil on error. +
                              2. OdbObject or nil on error.
                              3. Error string. @@ -599,20 +599,20 @@

                                Return values:

                                -
                                ODB:write (data1, type)
                                +
                                ODB:write (data, type)
                                -object method. +object method.

                                Calls git_odb_write:

                                This method writes a full object straight into the ODB. For most cases, it is preferred to write objects through a write stream, which is both faster and less memory intensive, specially for big objects.

                                This method is provided for compatibility with custom backends which are not able to support streaming writes

                                Parameters

                                • - data1: Must be of type `string`. + data: buffer with the data to storr. Must be of type string.
                                • - type: Must be of type `string`. + type: type of the data to store. Must be of type string.
                                @@ -625,7 +625,7 @@

                                Parameters

                                Return values:

                                  -
                                1. OID or nil on error. +
                                2. OID or nil on error.
                                3. Error string. diff --git a/modules/ODBBackend.html b/modules/ODBBackend.html index 9796daf..3d1dfbc 100644 --- a/modules/ODBBackend.html +++ b/modules/ODBBackend.html @@ -133,7 +133,7 @@

                                  Modules

                                  Module ODBBackend

                                  -

                                  Class "ODBBackend".

                                  +

                                  Class "ODBBackend".

                                  @@ -144,7 +144,7 @@

                                  Functions

                    - +
                    ODB.hash (data2, otype)module function ODB.hash (data, otype)module function.
                    ODB.hashfile (path, otype)module function module function.
                    ODB.new ()Create a new ODB object Create a new ODB object.
                    ODB.open (object_dir)Create a new ODB object Create a new ODB object.
                    ODB:free ()Destroy this object.Destroy this object (will be called by Garbage Collector).
                    ODB:write (data1, type)ODB:write (data, type) object method.
                    ODBBackend.new ()Create a new ODBBackend object Create a new ODBBackend object.
                    @@ -166,7 +166,7 @@

                    Functions

                    ODBBackend.new ()
                    -Create a new ODBBackend object +Create a new ODBBackend object. @@ -175,7 +175,7 @@

                    Functions

                    Return value:

                    -ODBBackend. +ODBBackend. diff --git a/modules/OID.html b/modules/OID.html index 3ded39f..4e86584 100644 --- a/modules/OID.html +++ b/modules/OID.html @@ -133,7 +133,7 @@

                    Modules

                    Module OID

                    -

                    Class "OID".

                    +

                    Class "OID".

                    @@ -144,12 +144,12 @@

                    Functions

                    OID.hex (str) - Create a new OID object + Create a new OID object. OID.raw (raw) - Create a new OID object + Create a new OID object. @@ -191,14 +191,14 @@

                    Functions

                    OID.hex (str)
                    -Create a new OID object +Create a new OID object.

                    Calls git_oid_fromstrn:

                    If N is odd, N-1 characters will be parsed instead. The remaining space in the git_oid will be set to zero.

                    Parameters

                    • - str: Must be of type `string`. + str: input hex string of at least size `length`. Must be of type string.
                    @@ -211,7 +211,7 @@

                    Parameters

                    Return values:

                      -
                    1. OID or nil on error. +
                    2. OID or nil on error.
                    3. Error string. @@ -226,14 +226,14 @@

                      Return values:

                      OID.raw (raw)
                      -Create a new OID object +Create a new OID object.

                      Calls git_oid_fromraw:

                      Parameters

                      • - raw: Must be of type `string`. + raw: the raw input bytes to be copied.. Must be of type string.
                      @@ -244,7 +244,7 @@

                      Parameters

                      Return value:

                      -OID. +OID. @@ -295,14 +295,14 @@

                      Return value:

                      OID_mt:__eq (id)
                      -object meta method. +object meta method.

                      Calls git_oid_cmp:

                      Parameters

                      • - id: Must be of type `OID`. + id: Must be of type OID.
                      diff --git a/modules/OID_Shorten.html b/modules/OID_Shorten.html index 43bc985..07467a7 100644 --- a/modules/OID_Shorten.html +++ b/modules/OID_Shorten.html @@ -133,7 +133,7 @@

                      Modules

                      Module OID_Shorten

                      -

                      Class "OID_Shorten".

                      +

                      Class "OID_Shorten".

                      @@ -144,7 +144,7 @@

                      Functions

                      OID_Shorten.new (min_length) - Create a new OID_Shorten object + Create a new OID_Shorten object. @@ -171,14 +171,14 @@

                      Functions

                      OID_Shorten.new (min_length)
                      -Create a new OID_Shorten object +Create a new OID_Shorten object.

                      Calls git_oid_shorten_new:

                      The OID shortener is used to process a list of OIDs in text form and return the shortest length that would uniquely identify all of them.

                      E.g. look at the result of `git log --abbrev`.

                      Parameters

                      • - min_length: Must be of type `integer`. + min_length: The minimal length for all identifiers, which will be used even if shorter OIDs would still be unique.. Must be of type integer.
                      @@ -189,7 +189,7 @@

                      Parameters

                      Return value:

                      -OID_Shorten. +OID_Shorten. @@ -200,14 +200,14 @@

                      Return value:

                      OID_Shorten:add (text_oid)
                      -object method. +object method.

                      Calls git_oid_shorten_add:

                      The OID is expected to be a 40-char hexadecimal string. The OID is owned by the user and will not be modified or freed.

                      For performance reasons, there is a hard-limit of how many OIDs can be added to a single set (around ~22000, assuming a mostly randomized distribution), which should be enough for any kind of program, and keeps the algorithm fast and memory-efficient.

                      Attempting to add more than those OIDs will result in a GIT_ENOMEM error

                      Parameters

                      • - text_oid: Must be of type `string`. + text_oid: an OID in text form. Must be of type string.
                      diff --git a/modules/Object.html b/modules/Object.html index 15077e6..87ef26e 100644 --- a/modules/Object.html +++ b/modules/Object.html @@ -133,7 +133,7 @@

                      Modules

                      Module Object

                      -

                      Class "Object".
                      Subclass Blob
                      Subclass Commit
                      Subclass Tree
                      Subclass Tag

                      +

                      Class "Object".

                      @@ -144,17 +144,17 @@

                      Functions

                      Object.string2type (str) - module function + module function. Object.type2string (otype) - module function + module function. Object:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -191,14 +191,14 @@

                      Functions

                      Object.string2type (str)
                      -module function +module function.

                      Parameters

                      • - str: Must be of type `string`. + str: Must be of type string.
                      @@ -220,14 +220,14 @@

                      Return value:

                      Object.type2string (otype)
                      -module function +module function.

                      Parameters

                      • - otype: Must be of type `integer`. + otype: Must be of type integer.
                      @@ -249,7 +249,7 @@

                      Return value:

                      Object:free ()
                      -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                      Calls git_object_free:

                      This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                      IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -266,7 +266,7 @@

                      Return value:

                      Object:id ()
                      -object method. +object method.

                      Calls git_object_id:

                      @@ -275,7 +275,7 @@

                      Return value:

                      Return value:

                      -OID. +OID. @@ -286,7 +286,7 @@

                      Return value:

                      Object:owner ()
                      -object method. +object method.

                      Calls git_object_owner:

                      Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                      Any other operation may be run on the repository without affecting the object. @@ -295,7 +295,7 @@

                      Return value:

                      Return value:

                      -Repository. +Repository. @@ -306,7 +306,7 @@

                      Return value:

                      Object:type ()
                      -object method. +object method.

                      Calls git_object_type:

                      diff --git a/modules/OdbObject.html b/modules/OdbObject.html index 80a4a14..971953a 100644 --- a/modules/OdbObject.html +++ b/modules/OdbObject.html @@ -133,7 +133,7 @@

                      Modules

                      Module OdbObject

                      -

                      Class "OdbObject".

                      +

                      Class "OdbObject".

                      @@ -149,7 +149,7 @@

                      Functions

                      OdbObject:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -186,7 +186,7 @@

                      Functions

                      OdbObject:data ()
                      -object method. +object method.

                      Calls git_odb_object_data:

                      This is the uncompressed, raw data as read from the ODB, without the leading header.

                      This pointer is owned by the object and shall not be free'd.

                      Calls git_odb_object_size:

                      This is the real size of the `data` buffer, not the actual size of the object. @@ -206,7 +206,7 @@

                      Return value:

                      OdbObject:free ()
                      -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                      Calls git_odb_object_free:

                      This method must always be called once a `git_odb_object` is no longer needed, otherwise memory will leak. @@ -223,7 +223,7 @@

                      Return value:

                      OdbObject:id ()
                      -object method. +object method.

                      Calls git_odb_object_id:

                      This is the OID from which the object was read from @@ -232,7 +232,7 @@

                      Return value:

                      Return value:

                      -OID. +OID. @@ -243,7 +243,7 @@

                      Return value:

                      OdbObject:size ()
                      -object method. +object method.

                      Calls git_odb_object_size:

                      This is the real size of the `data` buffer, not the actual size of the object. @@ -263,7 +263,7 @@

                      Return value:

                      OdbObject:type ()
                      -object method. +object method.

                      Calls git_odb_object_type:

                      diff --git a/modules/Reference.html b/modules/Reference.html index 0718d5f..9e9bfc7 100644 --- a/modules/Reference.html +++ b/modules/Reference.html @@ -133,7 +133,7 @@

                      Modules

                      Module Reference

                      -

                      Class "Reference".

                      +

                      Class "Reference".

                      @@ -144,17 +144,17 @@

                      Functions

                      Reference.list (repo, list_flags) - module function + module function. Reference.lookup (repo, name) - Create a new Reference object + Create a new Reference object. Reference.packall (repo) - module function + module function. @@ -226,18 +226,18 @@

                      Functions

                      Reference.list (repo, list_flags)
                      -module function +module function.

                      Parameters

                      • - repo: Must be of type `Repository`. + repo: Must be of type Repository.
                      • - list_flags: Must be of type `integer`. + list_flags: Must be of type integer.
                      @@ -250,7 +250,7 @@

                      Parameters

                      Return values:

                        -
                      1. StrArray or nil on error. +
                      2. StrArray or nil on error.
                      3. Error string. @@ -265,18 +265,18 @@

                        Return values:

                        Reference.lookup (repo, name)
                        -Create a new Reference object +Create a new Reference object.

                        Calls git_reference_lookup:

                        The generated reference must be freed by the user.

                        Parameters

                        • - repo: Must be of type `Repository`. + repo: the repository to look up the reference. Must be of type Repository.
                        • - name: Must be of type `string`. + name: the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...). Must be of type string.
                        @@ -289,7 +289,7 @@

                        Parameters

                        Return values:

                          -
                        1. Reference or nil on error. +
                        2. Reference or nil on error.
                        3. Error string. @@ -304,14 +304,14 @@

                          Return values:

                          Reference.packall (repo)
                          -module function +module function.

                          Calls git_reference_packall:

                          This method will load into the cache all the loose references on the repository and update the `packed-refs` file with them.

                          Once the `packed-refs` file has been written properly, the loose references will be removed from disk.

                          Parameters

                          • - repo: Must be of type `Repository`. + repo: Repository where the loose refs will be packed. Must be of type Repository.
                          @@ -339,7 +339,7 @@

                          Return values:

                          Reference:delete ()
                          -object method. +object method.

                          Calls git_reference_delete:

                          This method works for both direct and symbolic references.

                          The reference will be immediately removed on disk and from memory. The given reference pointer will no longer be valid. @@ -365,7 +365,7 @@

                          Return values:

                          Reference:name ()
                          -object method. +object method.

                          Calls git_reference_name:

                          @@ -385,7 +385,7 @@

                          Return value:

                          Reference:oid ()
                          -object method. +object method.

                          Calls git_reference_oid:

                          Only available if the reference is direct (i.e. not symbolic) @@ -394,7 +394,7 @@

                          Return value:

                          Return value:

                          -OID. +OID. @@ -405,7 +405,7 @@

                          Return value:

                          Reference:owner ()
                          -object method. +object method.

                          Calls git_reference_owner:

                          @@ -414,7 +414,7 @@

                          Return value:

                          Return value:

                          -Repository. +Repository. @@ -425,18 +425,18 @@

                          Return value:

                          Reference:rename (new_name, force)
                          -object method. +object method.

                          Calls git_reference_rename:

                          This method works for both direct and symbolic references. The new name will be checked for validity and may be modified into a normalized form.

                          The given git_reference will be updated in place.

                          The reference will be immediately renamed in-memory and on disk.

                          If the `force` flag is not enabled, and there's already a reference with the given name, the renaming will fail.

                          IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists.

                          Parameters

                          • - new_name: Must be of type `string`. + new_name: The new name for the reference. Must be of type string.
                          • - force: Must be of type `boolean`. + force: Overwrite an existing reference. Must be of type boolean.
                          @@ -464,7 +464,7 @@

                          Return values:

                          Reference:resolve ()
                          -object method. +object method.

                          Calls git_reference_resolve:

                          Thie method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.

                          The peeled reference is returned in the `resolved_ref` argument, and must be freed manually once it's no longer needed.

                          If a direct reference is passed as an argument, a copy of that reference is returned. This copy must be manually freed too. @@ -475,7 +475,7 @@

                          Return values:

                          Return values:

                            -
                          1. Reference or nil on error. +
                          2. Reference or nil on error.
                          3. Error string. @@ -490,14 +490,14 @@

                            Return values:

                            Reference:set_oid (oid)
                            -object method. +object method.

                            Calls git_reference_set_oid:

                            The reference must be a direct reference, otherwise this method will fail.

                            The reference will be automatically updated in memory and on disk.

                            Parameters

                            • - oid: Must be of type `OID`. + oid: Must be of type OID.
                            @@ -525,14 +525,14 @@

                            Return values:

                            Reference:set_target (target)
                            -object method. +object method.

                            Calls git_reference_set_target:

                            The reference must be a symbolic reference, otherwise this method will fail.

                            The reference will be automatically updated in memory and on disk.

                            Parameters

                            • - target: Must be of type `string`. + target: The new target for the reference. Must be of type string.
                            @@ -560,7 +560,7 @@

                            Return values:

                            Reference:target ()
                            -object method. +object method.

                            Calls git_reference_target:

                            Only available if the reference is symbolic @@ -580,7 +580,7 @@

                            Return value:

                            Reference:type ()
                            -object method. +object method.

                            Calls git_reference_type:

                            Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) diff --git a/modules/Repository.html b/modules/Repository.html index 742e64e..eb4d77f 100644 --- a/modules/Repository.html +++ b/modules/Repository.html @@ -133,7 +133,7 @@

                            Modules

                            Module Repository

                            -

                            Class "Repository".

                            +

                            Class "Repository".

                            @@ -144,12 +144,12 @@

                            Functions

                            Repository.init (path, is_bare) - Create a new Repository object + Create a new Repository object. Repository.open (path) - Create a new Repository object + Create a new Repository object. @@ -241,18 +241,18 @@

                            Functions

                            Repository.init (path, is_bare)
                            -Create a new Repository object +Create a new Repository object.

                            Calls git_repository_init:

                            TODO: - Reinit the repository

                            Parameters

                            • - path: Must be of type `string`. + path: the path to the repository. Must be of type string.
                            • - is_bare: Must be of type `integer`. + is_bare: if true, a Git repository without a working directory is created at the pointed path. If false, provided path will be considered as the working directory into which the .git directory will be created.. Must be of type integer.
                            @@ -265,7 +265,7 @@

                            Parameters

                            Return values:

                              -
                            1. Repository or nil on error. +
                            2. Repository or nil on error.
                            3. Error string. @@ -280,14 +280,14 @@

                              Return values:

                              Repository.open (path)
                              -Create a new Repository object +Create a new Repository object.

                              Calls git_repository_open:

                              The 'path' argument must point to either a git repository folder, or an existing work dir.

                              The method will automatically detect if 'path' is a normal or bare repository or fail is 'path' is neither.

                              Parameters

                              • - path: Must be of type `string`. + path: the path to the repository. Must be of type string.
                              @@ -300,7 +300,7 @@

                              Parameters

                              Return values:

                                -
                              1. Repository or nil on error. +
                              2. Repository or nil on error.
                              3. Error string. @@ -315,7 +315,7 @@

                                Return values:

                                Repository:config ()
                                -object method. +object method.

                                Calls git_repository_config:

                                If a configuration file has not been set, the default config set for the repository will be returned, including global and system configurations (if they are available).

                                The configuration file must be freed once it's no longer being used by the user. @@ -326,7 +326,7 @@

                                Return values:

                                Return values:

                                  -
                                1. Config or nil on error. +
                                2. Config or nil on error.
                                3. Error string. @@ -341,7 +341,7 @@

                                  Return values:

                                  Repository:head ()
                                  -object method. +object method.

                                  Calls git_repository_head:

                                  @@ -352,7 +352,7 @@

                                  Return values:

                                  Return values:

                                    -
                                  1. Reference or nil on error. +
                                  2. Reference or nil on error.
                                  3. Error string. @@ -367,7 +367,7 @@

                                    Return values:

                                    Repository:head_detached ()
                                    -object method. +object method.

                                    Calls git_repository_head_detached:

                                    A repository's HEAD is detached when it points directly to a commit instead of a branch. @@ -387,7 +387,7 @@

                                    Return value:

                                    Repository:head_orphan ()
                                    -object method. +object method.

                                    Calls git_repository_head_orphan:

                                    An orphan branch is one named from HEAD but which doesn't exist in the refs namespace, because it doesn't have any commit to point to. @@ -407,7 +407,7 @@

                                    Return value:

                                    Repository:index ()
                                    -object method. +object method.

                                    Calls git_repository_index:

                                    If a custom index has not been set, the default index for the repository will be returned (the one located in `.git/index`).

                                    The index must be freed once it's no longer being used by the user. @@ -418,7 +418,7 @@

                                    Return value:

                                    Return values:

                                      -
                                    1. Index or nil on error. +
                                    2. Index or nil on error.
                                    3. Error string. @@ -433,7 +433,7 @@

                                      Return values:

                                      Repository:is_bare ()
                                      -object method. +object method.

                                      Calls git_repository_is_bare:

                                      @@ -453,7 +453,7 @@

                                      Return value:

                                      Repository:is_empty ()
                                      -object method. +object method.

                                      Calls git_repository_is_empty:

                                      An empty repository has just been initialized and contains no commits. @@ -473,7 +473,7 @@

                                      Return value:

                                      Repository:odb ()
                                      -object method. +object method.

                                      Calls git_repository_odb:

                                      If a custom ODB has not been set, the default database for the repository will be returned (the one located in `.git/objects`).

                                      The ODB must be freed once it's no longer being used by the user. @@ -484,7 +484,7 @@

                                      Return value:

                                      Return values:

                                        -
                                      1. ODB or nil on error. +
                                      2. ODB or nil on error.
                                      3. Error string. @@ -499,7 +499,7 @@

                                        Return values:

                                        Repository:path ()
                                        -object method. +object method.

                                        Calls git_repository_path:

                                        This is the path of the `.git` folder for normal repositories, or of the repository itself for bare repositories. @@ -519,14 +519,14 @@

                                        Return value:

                                        Repository:set_config (config)
                                        -object method. +object method.

                                        Calls git_repository_set_config:

                                        This configuration file will be used for all configuration queries involving this repository.

                                        The repository will keep a reference to the config file; the user must still free the config after setting it to the repository, or it will leak.

                                        Parameters

                                        • - config: Must be of type `Config`. + config: A Config object. Must be of type Config.
                                        @@ -545,14 +545,14 @@

                                        Parameters

                                        Repository:set_index (index)
                                        -object method. +object method.

                                        Calls git_repository_set_index:

                                        This index will be used for all index-related operations involving this repository.

                                        The repository will keep a reference to the index file; the user must still free the index after setting it to the repository, or it will leak.

                                        Parameters

                                        • - index: Must be of type `Index`. + index: An index object. Must be of type Index.
                                        @@ -571,14 +571,14 @@

                                        Parameters

                                        Repository:set_odb (odb)
                                        -object method. +object method.

                                        Calls git_repository_set_odb:

                                        The ODB will be used for all object-related operations involving this repository.

                                        The repository will keep a reference to the ODB; the user must still free the ODB object after setting it to the repository, or it will leak.

                                        Parameters

                                        • - odb: Must be of type `ODB`. + odb: An ODB object. Must be of type ODB.
                                        @@ -597,14 +597,14 @@

                                        Parameters

                                        Repository:set_workdir (workdir)
                                        -object method. +object method.

                                        Calls git_repository_set_workdir:

                                        The working directory doesn't need to be the same one that contains the `.git` folder for this repository.

                                        If this repository is bare, setting its working directory will turn it into a normal repository, capable of performing all the common workdir operations (checkout, status, index manipulation, etc).

                                        Parameters

                                        • - workdir: Must be of type `string`. + workdir: The path to a working directory. Must be of type string.
                                        @@ -632,7 +632,7 @@

                                        Return values:

                                        Repository:workdir ()
                                        -object method. +object method.

                                        Calls git_repository_workdir:

                                        If the repository is bare, this function will always return NULL. diff --git a/modules/RevWalk.html b/modules/RevWalk.html index 1d31ed8..6e99863 100644 --- a/modules/RevWalk.html +++ b/modules/RevWalk.html @@ -133,7 +133,7 @@

                                        Modules

                                        Module RevWalk

                                        -

                                        Class "RevWalk".

                                        +

                                        Class "RevWalk".

                                        @@ -144,12 +144,12 @@

                                        Functions

                                        RevWalk.new (repo) - Create a new RevWalk object + Create a new RevWalk object. RevWalk:close () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -201,14 +201,14 @@

                                        Functions

                                        RevWalk.new (repo)
                                        -Create a new RevWalk object +Create a new RevWalk object.

                                        Calls git_revwalk_new:

                                        This revision walker uses a custom memory pool and an internal commit cache, so it is relatively expensive to allocate.

                                        For maximum performance, this revision walker should be reused for different walks.

                                        This revision walker is *not* thread safe: it may only be used to walk a repository on a single thread; however, it is possible to have several revision walkers in several different threads walking the same repository.

                                        Parameters

                                        • - repo: Must be of type `Repository`. + repo: the repo to walk through. Must be of type Repository.
                                        @@ -221,7 +221,7 @@

                                        Parameters

                                        Return values:

                                          -
                                        1. RevWalk or nil on error. +
                                        2. RevWalk or nil on error.
                                        3. Error string. @@ -236,7 +236,7 @@

                                          Return values:

                                          RevWalk:close ()
                                          -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                                          Calls git_revwalk_free:

                                          @@ -253,14 +253,14 @@

                                          Return values:

                                          RevWalk:hide (id)
                                          -object method. +object method.

                                          Calls git_revwalk_hide:

                                          The given OID must belong to a commit on the walked repository.

                                          The resolved commit and all its parents will be hidden from the output on the revision walk.

                                          Parameters

                                          • - id: Must be of type `OID`. + id: Must be of type OID.
                                          @@ -288,7 +288,7 @@

                                          Return values:

                                          RevWalk:next ()
                                          -object method. +object method.

                                          Calls git_revwalk_next:

                                          The initial call to this method is *not* blocking when iterating through a repo with a time-sorting mode.

                                          Iterating with Topological or inverted modes makes the initial call blocking to preprocess the commit list, but this block should be mostly unnoticeable on most repositories (topological preprocessing times at 0.3s on the git.git repo).

                                          The revision walker is reset when the walk is over. @@ -299,7 +299,7 @@

                                          Return values:

                                          Return values:

                                            -
                                          1. OID or nil on error. +
                                          2. OID or nil on error.
                                          3. Error string. @@ -314,14 +314,14 @@

                                            Return values:

                                            RevWalk:push (id)
                                            -object method. +object method.

                                            Calls git_revwalk_push:

                                            The given OID must belong to a commit on the walked repository.

                                            The given commit will be used as one of the roots when starting the revision walk. At least one commit must be pushed the repository before a walk can be started.

                                            Parameters

                                            • - id: Must be of type `OID`. + id: Must be of type OID.
                                            @@ -349,7 +349,7 @@

                                            Return values:

                                            RevWalk:repository ()
                                            -object method. +object method.

                                            Calls git_revwalk_repository:

                                            @@ -358,7 +358,7 @@

                                            Return values:

                                            Return value:

                                            -Repository. +Repository. @@ -369,7 +369,7 @@

                                            Return value:

                                            RevWalk:reset ()
                                            -object method. +object method.

                                            Calls git_revwalk_reset:

                                            This will clear all the pushed and hidden commits, and leave the walker in a blank state (just like at creation) ready to receive new commit pushes and start a new walk.

                                            The revision walk is automatically reset when a walk is over. @@ -386,14 +386,14 @@

                                            Return value:

                                            RevWalk:sorting (sort_mode)
                                            -object method. +object method.

                                            Calls git_revwalk_sorting:

                                            Changing the sorting mode resets the walker.

                                            Parameters

                                            • - sort_mode: Must be of type `integer`. + sort_mode: combination of GIT_SORT_XXX flags. Must be of type integer.
                                            diff --git a/modules/Signature.html b/modules/Signature.html index 6b1bb44..66eca21 100644 --- a/modules/Signature.html +++ b/modules/Signature.html @@ -133,7 +133,7 @@

                                            Modules

                                            Module Signature

                                            -

                                            Class "Signature".

                                            +

                                            Class "Signature".

                                            @@ -144,12 +144,12 @@

                                            Functions

                                            Signature.new (name, email, time, offset) - Create a new Signature object + Create a new Signature object. Signature.now (name, email) - Create a new Signature object + Create a new Signature object. @@ -186,26 +186,26 @@

                                            Functions

                                            Signature.new (name, email, time, offset)
                                            -Create a new Signature object +Create a new Signature object.

                                            Calls git_signature_new:

                                            Parameters

                                            • - name: Must be of type `string`. + name: name of the person. Must be of type string.
                                            • - email: Must be of type `string`. + email: email of the person. Must be of type string.
                                            • - time: Must be of type `integer`. + time: time when the action happened. Must be of type integer.
                                            • - offset: Must be of type `integer`. + offset: timezone offset in minutes for the time. Must be of type integer.
                                            @@ -218,7 +218,7 @@

                                            Parameters

                                            Return values:

                                              -
                                            1. Signature or nil on error. +
                                            2. Signature or nil on error.
                                            3. Error string. @@ -233,18 +233,18 @@

                                              Return values:

                                              Signature.now (name, email)
                                              -Create a new Signature object +Create a new Signature object.

                                              Calls git_signature_now:

                                              Parameters

                                              • - name: Must be of type `string`. + name: name of the person. Must be of type string.
                                              • - email: Must be of type `string`. + email: email of the person. Must be of type string.
                                              @@ -257,7 +257,7 @@

                                              Parameters

                                              Return values:

                                                -
                                              1. Signature or nil on error. +
                                              2. Signature or nil on error.
                                              3. Error string. diff --git a/modules/StrArray.html b/modules/StrArray.html index 05e7ef8..1fad380 100644 --- a/modules/StrArray.html +++ b/modules/StrArray.html @@ -133,7 +133,7 @@

                                                Modules

                                                Module StrArray

                                                -

                                                Class "StrArray".

                                                +

                                                Class "StrArray".

                                                @@ -144,7 +144,7 @@

                                                Functions

                                                StrArray.new () - Create a new StrArray object + Create a new StrArray object. @@ -154,7 +154,7 @@

                                                Functions

                                                StrArray:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -186,7 +186,7 @@

                                                Functions

                                                StrArray.new ()
                                                -Create a new StrArray object +Create a new StrArray object. @@ -195,7 +195,7 @@

                                                Functions

                                                Return value:

                                                -StrArray. +StrArray. @@ -226,7 +226,7 @@

                                                Return value:

                                                StrArray:free ()
                                                -Destroy this object. +Destroy this object (will be called by Garbage Collector). @@ -270,7 +270,7 @@

                                                Parameters

                                                • - n: Must be of type `integer`. + n: Must be of type integer.
                                                diff --git a/modules/Tag.html b/modules/Tag.html index 8630fb2..7bc7d6a 100644 --- a/modules/Tag.html +++ b/modules/Tag.html @@ -133,7 +133,7 @@

                                                Modules

                                                Module Tag

                                                -

                                                Class "Tag". Extends Object

                                                +

                                                Class "Tag". Extends Object

                                                @@ -144,7 +144,7 @@

                                                Functions

                                                Object:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -164,7 +164,7 @@

                                                Functions

                                                Tag.lookup (repo, id) - Create a new Tag object + Create a new Tag object. @@ -206,7 +206,7 @@

                                                Functions

                                                Object:free ()
                                                -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                                                Calls git_object_free:

                                                This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -223,7 +223,7 @@

                                                Functions

                                                Object:id ()
                                                -object method. +object method.

                                                Calls git_object_id:

                                                @@ -232,7 +232,7 @@

                                                Functions

                                                Return value:

                                                -OID. +OID. @@ -243,7 +243,7 @@

                                                Return value:

                                                Object:owner ()
                                                -object method. +object method.

                                                Calls git_object_owner:

                                                Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                Any other operation may be run on the repository without affecting the object. @@ -252,7 +252,7 @@

                                                Return value:

                                                Return value:

                                                -Repository. +Repository. @@ -263,7 +263,7 @@

                                                Return value:

                                                Object:type ()
                                                -object method. +object method.

                                                Calls git_object_type:

                                                @@ -283,18 +283,18 @@

                                                Return value:

                                                Tag.lookup (repo, id)
                                                -Create a new Tag object +Create a new Tag object.

                                                Calls git_tag_lookup:

                                                Parameters

                                                • - repo: Must be of type `Repository`. + repo: the repo to use when locating the tag.. Must be of type Repository.
                                                • - id: Must be of type `OID`. + id: identity of the tag to locate.. Must be of type OID.
                                                @@ -307,7 +307,7 @@

                                                Parameters

                                                Return values:

                                                  -
                                                1. Tag or nil on error. +
                                                2. Tag or nil on error.
                                                3. Error string. @@ -322,7 +322,7 @@

                                                  Return values:

                                                  Tag:message ()
                                                  -object method. +object method.

                                                  Calls git_tag_message:

                                                  @@ -342,7 +342,7 @@

                                                  Return value:

                                                  Tag:name ()
                                                  -object method. +object method.

                                                  Calls git_tag_name:

                                                  @@ -362,7 +362,7 @@

                                                  Return value:

                                                  Tag:tagger ()
                                                  -object method. +object method.

                                                  Calls git_tag_tagger:

                                                  @@ -371,7 +371,7 @@

                                                  Return value:

                                                  Return value:

                                                  -Signature. +Signature. @@ -382,7 +382,7 @@

                                                  Return value:

                                                  Tag:target ()
                                                  -object method. +object method.

                                                  Calls git_tag_target:

                                                  This method performs a repository lookup for the given object and returns it @@ -393,7 +393,7 @@

                                                  Return value:

                                                  Return values:

                                                    -
                                                  1. Object or nil on error. +
                                                  2. Object or nil on error.
                                                  3. Error string. diff --git a/modules/Tree.html b/modules/Tree.html index 281e795..d7b8481 100644 --- a/modules/Tree.html +++ b/modules/Tree.html @@ -133,7 +133,7 @@

                                                    Modules

                                                    Module Tree

                                                    -

                                                    Class "Tree". Extends Object

                                                    +

                                                    Class "Tree". Extends Object

                                                    @@ -144,7 +144,7 @@

                                                    Functions

                                                    Object:free () - Destroy this object. + Destroy this object (will be called by Garbage Collector). @@ -164,7 +164,7 @@

                                                    Functions

                                                    Tree.lookup (repo, id) - Create a new Tree object + Create a new Tree object. @@ -201,7 +201,7 @@

                                                    Functions

                                                    Object:free ()
                                                    -Destroy this object. +Destroy this object (will be called by Garbage Collector).

                                                    Calls git_object_free:

                                                    This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                    IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -218,7 +218,7 @@

                                                    Functions

                                                    Object:id ()
                                                    -object method. +object method.

                                                    Calls git_object_id:

                                                    @@ -227,7 +227,7 @@

                                                    Functions

                                                    Return value:

                                                    -OID. +OID. @@ -238,7 +238,7 @@

                                                    Return value:

                                                    Object:owner ()
                                                    -object method. +object method.

                                                    Calls git_object_owner:

                                                    Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                    Any other operation may be run on the repository without affecting the object. @@ -247,7 +247,7 @@

                                                    Return value:

                                                    Return value:

                                                    -Repository. +Repository. @@ -258,7 +258,7 @@

                                                    Return value:

                                                    Object:type ()
                                                    -object method. +object method.

                                                    Calls git_object_type:

                                                    @@ -278,18 +278,18 @@

                                                    Return value:

                                                    Tree.lookup (repo, id)
                                                    -Create a new Tree object +Create a new Tree object.

                                                    Calls git_tree_lookup:

                                                    Parameters

                                                    • - repo: Must be of type `Repository`. + repo: the repo to use when locating the tree.. Must be of type Repository.
                                                    • - id: Must be of type `OID`. + id: identity of the tree to locate.. Must be of type OID.
                                                    @@ -302,7 +302,7 @@

                                                    Parameters

                                                    Return values:

                                                      -
                                                    1. Tree or nil on error. +
                                                    2. Tree or nil on error.
                                                    3. Error string. @@ -317,14 +317,14 @@

                                                      Return values:

                                                      Tree:entry_byindex (index)
                                                      -object method. +object method.

                                                      Calls git_tree_entry_byindex:

                                                      Parameters

                                                      • - index: Must be of type `integer`. + index: Must be of type integer.
                                                      @@ -335,7 +335,7 @@

                                                      Parameters

                                                      Return value:

                                                      -TreeEntry. +TreeEntry. @@ -346,14 +346,14 @@

                                                      Return value:

                                                      Tree:entry_byname (filename)
                                                      -object method. +object method.

                                                      Calls git_tree_entry_byname:

                                                      Parameters

                                                      • - filename: Must be of type `string`. + filename: the filename of the desired entry. Must be of type string.
                                                      @@ -364,7 +364,7 @@

                                                      Parameters

                                                      Return value:

                                                      -TreeEntry. +TreeEntry. @@ -375,7 +375,7 @@

                                                      Return value:

                                                      Tree:entrycount ()
                                                      -object method. +object method.

                                                      Calls git_tree_entrycount:

                                                      diff --git a/modules/TreeEntry.html b/modules/TreeEntry.html index fde987d..2033128 100644 --- a/modules/TreeEntry.html +++ b/modules/TreeEntry.html @@ -133,7 +133,7 @@

                                                      Modules

                                                      Module TreeEntry

                                                      -

                                                      Class "TreeEntry".

                                                      +

                                                      Class "TreeEntry".

                                                      @@ -158,7 +158,7 @@

                                                      Functions

                                                      - TreeEntry:object (repo) + TreeEntry:object (repo, object) object method. @@ -181,7 +181,7 @@

                                                      Functions

                                                      TreeEntry:attributes ()
                                                      -object method. +object method.

                                                      Calls git_tree_entry_attributes:

                                                      @@ -210,7 +210,7 @@

                                                      Return value:

                                                      Return value:

                                                      -OID. +OID. @@ -221,7 +221,7 @@

                                                      Return value:

                                                      TreeEntry:name ()
                                                      -object method. +object method.

                                                      Calls git_tree_entry_name:

                                                      @@ -239,7 +239,7 @@

                                                      Return value:

                                                      -
                                                      TreeEntry:object (repo)
                                                      +
                                                      TreeEntry:object (repo, object)
                                                      object method. @@ -248,7 +248,11 @@

                                                      Parameters

                                                      • - repo: Must be of type `Repository`. + repo: repository where to lookup the pointed object. Must be of type Repository. +
                                                        • + +
                                                      • + object: pointer to the converted object
                                                      @@ -261,7 +265,7 @@

                                                      Parameters

                                                      Return values:

                                                        -
                                                      1. Object or nil on error. +
                                                      2. Object or nil on error.
                                                      3. Error string. diff --git a/modules/git2.html b/modules/git2.html index 80d83be..9a44134 100644 --- a/modules/git2.html +++ b/modules/git2.html @@ -133,7 +133,7 @@

                                                        Modules

                                                        Module git2

                                                        -

                                                        Module git2.
                                                        Class StrArray
                                                        Class Repository
                                                        Class Config
                                                        Class OdbObject
                                                        Class OID
                                                        Class OID_Shorten
                                                        Class ODB
                                                        Class ODBBackend
                                                        Class Index
                                                        Class IndexEntry
                                                        Class IndexEntryUnmerged
                                                        Class Object
                                                        Class Blob
                                                        Class Signature
                                                        Class Commit
                                                        Class Tree
                                                        Class TreeEntry
                                                        Class Tag
                                                        Class RevWalk
                                                        Class Reference

                                                        +

                                                        Module git2. See libgit2 API docs.
                                                        Class StrArray
                                                        Class Repository
                                                        Class Config
                                                        Class OdbObject
                                                        Class OID
                                                        Class OID_Shorten
                                                        Class ODB
                                                        Class ODBBackend
                                                        Class Index
                                                        Class IndexEntry
                                                        Class IndexEntryUnmerged
                                                        Class Object
                                                        Class Blob
                                                        Class Signature
                                                        Class Commit
                                                        Class Tree
                                                        Class TreeEntry
                                                        Class Tag
                                                        Class RevWalk
                                                        Class Reference

                                                        @@ -144,7 +144,7 @@

                                                        Functions

                                                        git2.version () - module function + module function. @@ -166,7 +166,7 @@

                                                        Functions

                                                        git2.version ()
                                                        -module function +module function. From ee34658ff3d7596cf4320c7c7f99c2eb2482f1ae Mon Sep 17 00:00:00 2001 From: "Robert G. Jakabosky" Date: Tue, 29 Jul 2025 18:07:10 +0800 Subject: [PATCH 3/3] Update docs. --- git2.luadoc | 2 +- git2/Blob.luadoc | 34 +++-- git2/Commit.luadoc | 30 ++--- git2/Config.luadoc | 39 +++--- git2/Index.luadoc | 106 ++++++---------- git2/IndexEntry.luadoc | 6 +- git2/ODB.luadoc | 20 +-- git2/OID.luadoc | 6 +- git2/OID_Shorten.luadoc | 4 +- git2/Object.luadoc | 8 +- git2/OdbObject.luadoc | 12 +- git2/Reference.luadoc | 68 +++------- git2/Repository.luadoc | 39 +++--- git2/RevWalk.luadoc | 16 +-- git2/Signature.luadoc | 4 +- git2/Tag.luadoc | 18 +-- git2/Tree.luadoc | 16 +-- git2/TreeEntry.luadoc | 9 +- modules/Blob.html | 34 ++--- modules/Commit.html | 30 ++--- modules/Config.html | 82 +++++++++--- modules/Index.html | 263 ++++++++++++++++----------------------- modules/IndexEntry.html | 40 +++--- modules/ODB.html | 20 +-- modules/OID.html | 6 +- modules/OID_Shorten.html | 4 +- modules/Object.html | 8 +- modules/OdbObject.html | 10 +- modules/Reference.html | 149 ++++------------------ modules/Repository.html | 44 ++++--- modules/RevWalk.html | 16 +-- modules/Signature.html | 4 +- modules/Tag.html | 18 +-- modules/Tree.html | 16 +-- modules/TreeEntry.html | 8 +- modules/git2.html | 2 +- 36 files changed, 520 insertions(+), 671 deletions(-) diff --git a/git2.luadoc b/git2.luadoc index d0e5848..95011ce 100644 --- a/git2.luadoc +++ b/git2.luadoc @@ -4,7 +4,7 @@ --- Module git2. -- --- See libgit2 API docs. +-- See libgit2 API docs. -- --
                                                        Class StrArray --
                                                        Class Repository diff --git a/git2/Blob.luadoc b/git2/Blob.luadoc index b694f46..a952cd3 100644 --- a/git2/Blob.luadoc +++ b/git2/Blob.luadoc @@ -9,7 +9,7 @@ module("Blob") --- Create a new Blob object. -- ---

                                                        Calls git_blob_lookup:

                                                        +--

                                                        Calls git_blob_lookup:

                                                        -- @param repo the repo to use when locating the blob.. Must be of type Repository. -- @param id identity of the blob to locate.. Must be of type OID. -- @return Blob or nil on error. @@ -20,33 +20,31 @@ end --- module function. -- ---

                                                        Calls git_blob_create_fromfile:

                                                        --- @param repo repository where the blob will be written. this repository cannot be bare. Must be of type Repository. --- @param path file from which the blob will be created, relative to the repository's working dir. Must be of type string. +-- @param repo Must be of type Repository. +-- @param path Must be of type string. -- @return OID or nil on error. -- @return Error string. --- @name Blob.fromfile -function Blob.fromfile(repo, path) +-- @name Blob.from_disk +function Blob.from_disk(repo, path) end --- module function. -- ---

                                                        Calls git_blob_create_frombuffer:

                                                        --- @param repo repository where to blob will be written. Must be of type Repository. --- @param buffer data to be written into the blob. Must be of type string. +-- @param repo Must be of type Repository. +-- @param buffer Must be of type string. -- @return OID or nil on error. -- @return Error string. --- @name Blob.frombuffer -function Blob.frombuffer(repo, buffer) +-- @name Blob.from_buffer +function Blob.from_buffer(repo, buffer) end --- object method. -- ---

                                                        Calls git_blob_rawcontent:

                                                        A pointer to the raw content of a blob is returned; +--

                                                        Calls git_blob_rawcontent:

                                                        A pointer to the raw content of a blob is returned; -- this pointer is owned internally by the object and shall -- not be free'd. The pointer may be invalidated at a later -- time. ---

                                                        Calls git_blob_rawsize:

                                                        +--

                                                        Calls git_blob_rawsize:

                                                        -- @return string. -- @name Blob:rawcontent function Blob:rawcontent() @@ -54,7 +52,7 @@ end --- object method. -- ---

                                                        Calls git_blob_rawsize:

                                                        +--

                                                        Calls git_blob_rawsize:

                                                        -- @return integer. -- @name Blob:rawsize function Blob:rawsize() @@ -62,7 +60,7 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing +--

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing -- object; note that git_objects are owned and cached by the repository -- so the object may or may not be freed after this library call, -- depending on how agressive is the caching mechanism used @@ -75,7 +73,7 @@ end --- object method. -- ---

                                                        Calls git_object_id:

                                                        +--

                                                        Calls git_object_id:

                                                        -- @return OID. -- @name Object:id function Object:id() @@ -83,7 +81,7 @@ end --- object method. -- ---

                                                        Calls git_object_type:

                                                        +--

                                                        Calls git_object_type:

                                                        -- @return string. -- @name Object:type function Object:type() @@ -91,7 +89,7 @@ end --- object method. -- ---

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the +--

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the -- returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without -- affecting the object. -- @return Repository. diff --git a/git2/Commit.luadoc b/git2/Commit.luadoc index 436fb4a..80f07ec 100644 --- a/git2/Commit.luadoc +++ b/git2/Commit.luadoc @@ -9,7 +9,7 @@ module("Commit") --- Create a new Commit object. -- ---

                                                        Calls git_commit_lookup:

                                                        +--

                                                        Calls git_commit_lookup:

                                                        -- @param repo the repo to use when locating the commit.. Must be of type Repository. -- @param id identity of the commit to locate. If the object is an annotated tag it will be peeled back to the commit.. Must be of type OID. -- @return Commit or nil on error. @@ -37,7 +37,7 @@ end --- object method. -- ---

                                                        Calls git_commit_id:

                                                        +--

                                                        Calls git_commit_id:

                                                        -- @return OID. -- @name Commit:id function Commit:id() @@ -45,7 +45,7 @@ end --- object method. -- ---

                                                        Calls git_commit_message_encoding:

                                                        The encoding may be NULL if the `encoding` header +--

                                                        Calls git_commit_message_encoding:

                                                        The encoding may be NULL if the `encoding` header -- in the commit is missing; in that case UTF-8 is assumed. -- @return string. -- @name Commit:message_encoding @@ -54,7 +54,7 @@ end --- object method. -- ---

                                                        Calls git_commit_message:

                                                        +--

                                                        Calls git_commit_message:

                                                        -- @return string. -- @name Commit:message function Commit:message() @@ -62,7 +62,7 @@ end --- object method. -- ---

                                                        Calls git_commit_time:

                                                        +--

                                                        Calls git_commit_time:

                                                        -- @return integer. -- @name Commit:time function Commit:time() @@ -70,7 +70,7 @@ end --- object method. -- ---

                                                        Calls git_commit_time_offset:

                                                        +--

                                                        Calls git_commit_time_offset:

                                                        -- @return integer. -- @name Commit:time_offset function Commit:time_offset() @@ -78,7 +78,7 @@ end --- object method. -- ---

                                                        Calls git_commit_committer:

                                                        +--

                                                        Calls git_commit_committer:

                                                        -- @return Signature. -- @name Commit:committer function Commit:committer() @@ -86,7 +86,7 @@ end --- object method. -- ---

                                                        Calls git_commit_author:

                                                        +--

                                                        Calls git_commit_author:

                                                        -- @return Signature. -- @name Commit:author function Commit:author() @@ -94,7 +94,7 @@ end --- object method. -- ---

                                                        Calls git_commit_tree:

                                                        +--

                                                        Calls git_commit_tree:

                                                        -- @return Tree or nil on error. -- @return Error string. -- @name Commit:tree @@ -103,7 +103,7 @@ end --- object method. -- ---

                                                        Calls git_commit_parentcount:

                                                        +--

                                                        Calls git_commit_parentcount:

                                                        -- @return integer. -- @name Commit:parentcount function Commit:parentcount() @@ -111,7 +111,7 @@ end --- object method. -- ---

                                                        Calls git_commit_parent:

                                                        +--

                                                        Calls git_commit_parent:

                                                        -- @param n the position of the parent (from 0 to `parentcount`). Must be of type integer. -- @return Commit or nil on error. -- @return Error string. @@ -121,7 +121,7 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing +--

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing -- object; note that git_objects are owned and cached by the repository -- so the object may or may not be freed after this library call, -- depending on how agressive is the caching mechanism used @@ -134,7 +134,7 @@ end --- object method. -- ---

                                                        Calls git_object_id:

                                                        +--

                                                        Calls git_object_id:

                                                        -- @return OID. -- @name Object:id function Object:id() @@ -142,7 +142,7 @@ end --- object method. -- ---

                                                        Calls git_object_type:

                                                        +--

                                                        Calls git_object_type:

                                                        -- @return string. -- @name Object:type function Object:type() @@ -150,7 +150,7 @@ end --- object method. -- ---

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the +--

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the -- returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without -- affecting the object. -- @return Repository. diff --git a/git2/Config.luadoc b/git2/Config.luadoc index 37a53f4..956852c 100644 --- a/git2/Config.luadoc +++ b/git2/Config.luadoc @@ -8,7 +8,7 @@ module("Config") --- Create a new Config object. -- ---

                                                        Calls git_config_new:

                                                        This object is empty, so you have to add a file to it before you +--

                                                        Calls git_config_new:

                                                        This object is empty, so you have to add a file to it before you -- can do anything with it. -- @return Config or nil on error. -- @return Error string. @@ -18,7 +18,7 @@ end --- Create a new Config object. -- ---

                                                        Calls git_config_open_ondisk:

                                                        This method is a simple utility wrapper for the following sequence +--

                                                        Calls git_config_open_ondisk:

                                                        This method is a simple utility wrapper for the following sequence -- of calls: -- - git_config_new -- - git_config_add_file_ondisk @@ -31,25 +31,27 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_config_free:

                                                        +--

                                                        Calls git_config_free:

                                                        -- @name Config:free function Config:free() end --- object method. -- ---

                                                        Calls git_config_add_file_ondisk:

                                                        The on-disk file pointed at by `path` will be opened and +--

                                                        Calls git_config_add_file_ondisk:

                                                        The on-disk file pointed at by `path` will be opened and -- parsed; it's expected to be a native Git config file following -- the default Git config syntax (see man git-config).

                                                        Note that the configuration object will free the file -- automatically.

                                                        Further queries on this config object will access each -- of the config file instances in order (instances with -- a higher priority will be accessed first). -- @param path path to the configuration file (backend) to add. Must be of type string. --- @param priority the priority the backend should have. Must be of type integer. +-- @param level Must be of type integer. +-- @param repo Must be of type Repository. +-- @param force Must be of type integer. -- @return true if no error. -- @return Error string. -- @name Config:add_file_ondisk -function Config:add_file_ondisk(path, priority) +function Config:add_file_ondisk(path, level, repo, force) end --- object method. @@ -92,7 +94,7 @@ end --- object method. -- ---

                                                        Calls git_config_get_bool:

                                                        This function uses the usual C convention of 0 being false and +--

                                                        Calls git_config_get_bool:

                                                        This function uses the usual C convention of 0 being false and -- anything else true. -- @param name the variable's name. Must be of type string. -- @return boolean or nil on error. @@ -103,7 +105,7 @@ end --- object method. -- ---

                                                        Calls git_config_set_bool:

                                                        +--

                                                        Calls git_config_set_bool:

                                                        -- @param value the value to store. Must be of type boolean. -- @param name the variable's name. Must be of type string. -- @return true if no error. @@ -114,7 +116,7 @@ end --- object method. -- ---

                                                        Calls git_config_get_string:

                                                        The string is owned by the variable and should not be freed by the +--

                                                        Calls git_config_get_string:

                                                        The string is owned by the variable and should not be freed by the -- user. -- @param name the variable's name. Must be of type string. -- @return string or nil on error. @@ -125,7 +127,7 @@ end --- object method. -- ---

                                                        Calls git_config_set_string:

                                                        A copy of the string is made and the user is free to use it +--

                                                        Calls git_config_set_string:

                                                        A copy of the string is made and the user is free to use it -- afterwards. -- @param name the variable's name. Must be of type string. -- @param value the string to store.. Must be of type string. @@ -137,11 +139,20 @@ end --- object method. -- ---

                                                        Calls git_config_delete:

                                                        --- @param name the variable to delete. Must be of type string. +-- @param name Must be of type string. +-- @return true if no error. +-- @return Error string. +-- @name Config:delete_entry +function Config:delete_entry(name) +end + +--- object method. +-- +-- @param name Must be of type string. +-- @param regexp Must be of type string. -- @return true if no error. -- @return Error string. --- @name Config:delete -function Config:delete(name) +-- @name Config:delete_multivar +function Config:delete_multivar(name, regexp) end diff --git a/git2/Index.luadoc b/git2/Index.luadoc index bfa51cc..00d8bf0 100644 --- a/git2/Index.luadoc +++ b/git2/Index.luadoc @@ -8,7 +8,7 @@ module("Index") --- Create a new Index object. -- ---

                                                        Calls git_index_open:

                                                        Since there is no ODB or working directory behind this index, +--

                                                        Calls git_index_open:

                                                        Since there is no ODB or working directory behind this index, -- any Index methods which rely on these (e.g. index_add) will -- fail with the GIT_EBAREINDEX error code.

                                                        If you need to access the index of an actual repository, -- use the `git_repository_index` wrapper.

                                                        The index must be freed once it's no longer in use. @@ -21,23 +21,24 @@ end --- object method. -- ---

                                                        Calls git_index_clear:

                                                        +--

                                                        Calls git_index_clear:

                                                        -- @name Index:clear function Index:clear() end --- object method. -- ---

                                                        Calls git_index_read:

                                                        +--

                                                        Calls git_index_read:

                                                        +-- @param force Must be of type integer. -- @return true if no error. -- @return Error string. -- @name Index:read -function Index:read() +function Index:read(force) end --- object method. -- ---

                                                        Calls git_index_write:

                                                        +--

                                                        Calls git_index_write:

                                                        -- @return true if no error. -- @return Error string. -- @name Index:write @@ -46,89 +47,67 @@ end --- object method. -- ---

                                                        Calls git_index_find:

                                                        +--

                                                        Calls git_index_find:

                                                        +-- @param at_pos Must be of type lightuserdata. -- @param path path to search. Must be of type string. -- @return integer. -- @name Index:find -function Index:find(path) +function Index:find(at_pos, path) end --- object method. -- ---

                                                        Calls git_index_uniq:

                                                        --- @name Index:uniq -function Index:uniq() +-- @param path Must be of type string. +-- @return true if no error. +-- @return Error string. +-- @name Index:add_bypath +function Index:add_bypath(path) end --- object method. -- ---

                                                        Calls git_index_add:

                                                        The file `path` must be relative to the repository's +--

                                                        Calls git_index_add:

                                                        The file `path` must be relative to the repository's -- working folder and must be readable.

                                                        This method will fail in bare index instances.

                                                        This forces the file to be added to the index, not looking -- at gitignore rules. Those rules can be evaluated through -- the git_status APIs (in status.h) before calling this. --- @param path filename to add. Must be of type string. --- @param stage stage for the entry. Must be of type integer. --- @return true if no error. --- @return Error string. --- @name Index:add -function Index:add(path, stage) -end - ---- object method. --- -- @param source_entry Must be of type IndexEntry. -- @return true if no error. -- @return Error string. --- @name Index:add2 -function Index:add2(source_entry) -end - ---- object method. --- ---

                                                        Calls git_index_append:

                                                        A new entry will always be inserted into the index; --- if the index already contains an entry for such --- path, the old entry will **not** be replaced.

                                                        The file `path` must be relative to the repository's --- working folder and must be readable.

                                                        This method will fail in bare index instances. --- @param path filename to add. Must be of type string. --- @param stage stage for the entry. Must be of type integer. --- @return true if no error. --- @return Error string. --- @name Index:append -function Index:append(path, stage) +-- @name Index:add +function Index:add(source_entry) end --- object method. -- --- @param source_entry Must be of type IndexEntry. +--

                                                        Calls git_index_remove:

                                                        +-- @param path Must be of type string. +-- @param stage Must be of type integer. -- @return true if no error. -- @return Error string. --- @name Index:append2 -function Index:append2(source_entry) +-- @name Index:remove +function Index:remove(path, stage) end --- object method. -- ---

                                                        Calls git_index_remove:

                                                        --- @param position position of the entry to remove. Must be of type integer. --- @return true if no error. --- @return Error string. --- @name Index:remove -function Index:remove(position) +-- @param n Must be of type integer. +-- @return IndexEntry. +-- @name Index:get_byindex +function Index:get_byindex(n) end --- object method. -- ---

                                                        Calls git_index_get:

                                                        This entry can be modified, and the changes will be written --- back to disk on the next write() call.

                                                        The entry should not be freed by the caller. --- @param n the position of the entry. Must be of type integer. +-- @param path Must be of type string. +-- @param stage Must be of type integer. -- @return IndexEntry. --- @name Index:get -function Index:get(n) +-- @name Index:get_bypath +function Index:get_bypath(path, stage) end --- object method. -- ---

                                                        Calls git_index_entrycount:

                                                        +--

                                                        Calls git_index_entrycount:

                                                        -- @return integer. -- @name Index:entrycount function Index:entrycount() @@ -136,35 +115,30 @@ end --- object method. -- ---

                                                        Calls git_index_entrycount_unmerged:

                                                        -- @return integer. --- @name Index:entrycount_unmerged -function Index:entrycount_unmerged() +-- @name Index:reuc_entrycount +function Index:reuc_entrycount() end --- object method. -- ---

                                                        Calls git_index_get_unmerged_bypath:

                                                        The returned entry is read-only and should not be modified --- of freed by the caller. --- @param path path to search. Must be of type string. +-- @param path Must be of type string. -- @return IndexEntryUnmerged. --- @name Index:get_unmerged_bypath -function Index:get_unmerged_bypath(path) +-- @name Index:reuc_get_bypath +function Index:reuc_get_bypath(path) end --- object method. -- ---

                                                        Calls git_index_get_unmerged_byindex:

                                                        The returned entry is read-only and should not be modified --- of freed by the caller. --- @param n the position of the entry. Must be of type integer. +-- @param n Must be of type integer. -- @return IndexEntryUnmerged. --- @name Index:get_unmerged_byindex -function Index:get_unmerged_byindex(n) +-- @name Index:reuc_get_byindex +function Index:reuc_get_byindex(n) end --- object method. -- ---

                                                        Calls git_index_read_tree:

                                                        The current index contents will be replaced by the specified tree. +--

                                                        Calls git_index_read_tree:

                                                        The current index contents will be replaced by the specified tree. -- @param tree tree to read. Must be of type Tree. -- @return true if no error. -- @return Error string. diff --git a/git2/IndexEntry.luadoc b/git2/IndexEntry.luadoc index 8900db6..520704d 100644 --- a/git2/IndexEntry.luadoc +++ b/git2/IndexEntry.luadoc @@ -15,7 +15,7 @@ end --- object method. -- ---

                                                        Calls git_index_entry_stage:

                                                        This entry is calculated from the entrie's flag +--

                                                        Calls git_index_entry_stage:

                                                        This entry is calculated from the entrie's flag -- attribute like this:

                                                        (entry->flags & GIT_IDXENTRY_STAGEMASK) >> GIT_IDXENTRY_STAGESHIFT

                                                        @returns the stage number -- @return integer. -- @name IndexEntry:stage @@ -113,8 +113,8 @@ end --- object method. -- -- @return OID. --- @name IndexEntry:oid -function IndexEntry:oid() +-- @name IndexEntry:id +function IndexEntry:id() end --- object method. diff --git a/git2/ODB.luadoc b/git2/ODB.luadoc index 6e060ee..f1e9095 100644 --- a/git2/ODB.luadoc +++ b/git2/ODB.luadoc @@ -8,7 +8,7 @@ module("ODB") --- Create a new ODB object. -- ---

                                                        Calls git_odb_new:

                                                        Before the ODB can be used for read/writing, a custom database +--

                                                        Calls git_odb_new:

                                                        Before the ODB can be used for read/writing, a custom database -- backend must be manually added using `git_odb_add_backend()` -- @return ODB or nil on error. -- @return Error string. @@ -18,7 +18,7 @@ end --- Create a new ODB object. -- ---

                                                        Calls git_odb_open:

                                                        - git_odb_backend_loose: read and write loose object files +--

                                                        Calls git_odb_open:

                                                        - git_odb_backend_loose: read and write loose object files -- from disk, assuming `objects_dir` as the Objects folder

                                                        - git_odb_backend_pack: read objects from packfiles, -- assuming `objects_dir` as the Objects folder which -- contains a 'pack/' folder with the corresponding data @@ -31,7 +31,7 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_odb_free:

                                                        +--

                                                        Calls git_odb_free:

                                                        -- @name ODB:free function ODB:free() end @@ -58,7 +58,7 @@ end --- object method. -- ---

                                                        Calls git_odb_read:

                                                        This method queries all available ODB backends +--

                                                        Calls git_odb_read:

                                                        This method queries all available ODB backends -- trying to read the given OID.

                                                        The returned object is reference counted and -- internally cached, so it should be closed -- by the user once it's no longer in use.

                                                        @return @@ -73,7 +73,7 @@ end --- object method. -- ---

                                                        Calls git_odb_read_prefix:

                                                        This method queries all available ODB backends +--

                                                        Calls git_odb_read_prefix:

                                                        This method queries all available ODB backends -- trying to match the 'len' first hexadecimal -- characters of the 'short_id'. -- The remaining (GIT_OID_HEXSZ-len)*4 bits of @@ -94,7 +94,7 @@ end --- object method. -- ---

                                                        Calls git_odb_read_header:

                                                        The header includes the length and the type of an object.

                                                        Note that most backends do not support reading only the header +--

                                                        Calls git_odb_read_header:

                                                        The header includes the length and the type of an object.

                                                        Note that most backends do not support reading only the header -- of an object, so the whole object will be read and then the -- header will be returned.

                                                        @return -- - 0 if the object was read; @@ -109,7 +109,7 @@ end --- object method. -- ---

                                                        Calls git_odb_exists:

                                                        @return +--

                                                        Calls git_odb_exists:

                                                        @return -- - 1, if the object was found -- - 0, otherwise -- @param id the object to search for.. Must be of type OID. @@ -121,7 +121,7 @@ end --- object method. -- ---

                                                        Calls git_odb_write:

                                                        This method writes a full object straight into the ODB. +--

                                                        Calls git_odb_write:

                                                        This method writes a full object straight into the ODB. -- For most cases, it is preferred to write objects through a write -- stream, which is both faster and less memory intensive, specially -- for big objects.

                                                        This method is provided for compatibility with custom backends @@ -136,7 +136,7 @@ end --- module function. -- ---

                                                        Calls git_odb_hash:

                                                        The resulting SHA-1 OID will the itentifier for the data +--

                                                        Calls git_odb_hash:

                                                        The resulting SHA-1 OID will the itentifier for the data -- buffer as if the data buffer it were to written to the ODB. -- @param data data to hash. Must be of type string. -- @param otype Must be of type integer. @@ -148,7 +148,7 @@ end --- module function. -- ---

                                                        Calls git_odb_hashfile:

                                                        +--

                                                        Calls git_odb_hashfile:

                                                        -- @param path file to read and determine object id for. Must be of type string. -- @param otype Must be of type integer. -- @return OID or nil on error. diff --git a/git2/OID.luadoc b/git2/OID.luadoc index 87e86a1..12cdf82 100644 --- a/git2/OID.luadoc +++ b/git2/OID.luadoc @@ -8,7 +8,7 @@ module("OID") --- Create a new OID object. -- ---

                                                        Calls git_oid_fromstrn:

                                                        If N is odd, N-1 characters will be parsed instead. +--

                                                        Calls git_oid_fromstrn:

                                                        If N is odd, N-1 characters will be parsed instead. -- The remaining space in the git_oid will be set to zero. -- @param str input hex string of at least size `length`. Must be of type string. -- @return OID or nil on error. @@ -19,7 +19,7 @@ end --- Create a new OID object. -- ---

                                                        Calls git_oid_fromraw:

                                                        +--

                                                        Calls git_oid_fromraw:

                                                        -- @param raw the raw input bytes to be copied.. Must be of type string. -- @return OID. -- @name OID.raw @@ -49,7 +49,7 @@ end --- object meta method. -- ---

                                                        Calls git_oid_cmp:

                                                        +--

                                                        Calls git_oid_cmp:

                                                        -- @param id Must be of type OID. -- @return integer. -- @name OID_mt:__eq diff --git a/git2/OID_Shorten.luadoc b/git2/OID_Shorten.luadoc index 5311517..e09537f 100644 --- a/git2/OID_Shorten.luadoc +++ b/git2/OID_Shorten.luadoc @@ -8,7 +8,7 @@ module("OID_Shorten") --- Create a new OID_Shorten object. -- ---

                                                        Calls git_oid_shorten_new:

                                                        The OID shortener is used to process a list of OIDs +--

                                                        Calls git_oid_shorten_new:

                                                        The OID shortener is used to process a list of OIDs -- in text form and return the shortest length that would -- uniquely identify all of them.

                                                        E.g. look at the result of `git log --abbrev`. -- @param min_length The minimal length for all identifiers, which will be used even if shorter OIDs would still be unique.. Must be of type integer. @@ -19,7 +19,7 @@ end --- object method. -- ---

                                                        Calls git_oid_shorten_add:

                                                        The OID is expected to be a 40-char hexadecimal string. +--

                                                        Calls git_oid_shorten_add:

                                                        The OID is expected to be a 40-char hexadecimal string. -- The OID is owned by the user and will not be modified -- or freed.

                                                        For performance reasons, there is a hard-limit of how many -- OIDs can be added to a single set (around ~22000, assuming diff --git a/git2/Object.luadoc b/git2/Object.luadoc index 9af2cb6..d9efe86 100644 --- a/git2/Object.luadoc +++ b/git2/Object.luadoc @@ -8,7 +8,7 @@ module("Object") --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing +--

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing -- object; note that git_objects are owned and cached by the repository -- so the object may or may not be freed after this library call, -- depending on how agressive is the caching mechanism used @@ -21,7 +21,7 @@ end --- object method. -- ---

                                                        Calls git_object_id:

                                                        +--

                                                        Calls git_object_id:

                                                        -- @return OID. -- @name Object:id function Object:id() @@ -29,7 +29,7 @@ end --- object method. -- ---

                                                        Calls git_object_type:

                                                        +--

                                                        Calls git_object_type:

                                                        -- @return string. -- @name Object:type function Object:type() @@ -37,7 +37,7 @@ end --- object method. -- ---

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the +--

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the -- returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without -- affecting the object. -- @return Repository. diff --git a/git2/OdbObject.luadoc b/git2/OdbObject.luadoc index b08dd12..1d08dff 100644 --- a/git2/OdbObject.luadoc +++ b/git2/OdbObject.luadoc @@ -8,7 +8,7 @@ module("OdbObject") --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_odb_object_free:

                                                        This method must always be called once a `git_odb_object` is no +--

                                                        Calls git_odb_object_free:

                                                        This method must always be called once a `git_odb_object` is no -- longer needed, otherwise memory will leak. -- @name OdbObject:free function OdbObject:free() @@ -16,7 +16,7 @@ end --- object method. -- ---

                                                        Calls git_odb_object_id:

                                                        This is the OID from which the object was read from +--

                                                        Calls git_odb_object_id:

                                                        This is the OID from which the object was read from -- @return OID. -- @name OdbObject:id function OdbObject:id() @@ -24,9 +24,9 @@ end --- object method. -- ---

                                                        Calls git_odb_object_data:

                                                        This is the uncompressed, raw data as read from the ODB, +--

                                                        Calls git_odb_object_data:

                                                        This is the uncompressed, raw data as read from the ODB, -- without the leading header.

                                                        This pointer is owned by the object and shall not be free'd. ---

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the +--

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the -- actual size of the object. -- @return string. -- @name OdbObject:data @@ -35,7 +35,7 @@ end --- object method. -- ---

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the +--

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the -- actual size of the object. -- @return integer. -- @name OdbObject:size @@ -44,7 +44,7 @@ end --- object method. -- ---

                                                        Calls git_odb_object_type:

                                                        +--

                                                        Calls git_odb_object_type:

                                                        -- @return string. -- @name OdbObject:type function OdbObject:type() diff --git a/git2/Reference.luadoc b/git2/Reference.luadoc index 4c4fae9..01eca4c 100644 --- a/git2/Reference.luadoc +++ b/git2/Reference.luadoc @@ -8,7 +8,7 @@ module("Reference") --- Create a new Reference object. -- ---

                                                        Calls git_reference_lookup:

                                                        The generated reference must be freed by the user. +--

                                                        Calls git_reference_lookup:

                                                        The generated reference must be freed by the user. -- @param repo the repository to look up the reference. Must be of type Repository. -- @param name the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...). Must be of type string. -- @return Reference or nil on error. @@ -19,47 +19,28 @@ end --- object method. -- ---

                                                        Calls git_reference_oid:

                                                        Only available if the reference is direct (i.e. not symbolic) +--

                                                        Calls git_reference_target:

                                                        Only available if the reference is symbolic -- @return OID. --- @name Reference:oid -function Reference:oid() -end - ---- object method. --- ---

                                                        Calls git_reference_set_oid:

                                                        The reference must be a direct reference, otherwise --- this method will fail.

                                                        The reference will be automatically updated in --- memory and on disk. --- @param oid Must be of type OID. --- @return true if no error. --- @return Error string. --- @name Reference:set_oid -function Reference:set_oid(oid) -end - ---- object method. --- ---

                                                        Calls git_reference_target:

                                                        Only available if the reference is symbolic --- @return string. -- @name Reference:target function Reference:target() end --- object method. -- ---

                                                        Calls git_reference_set_target:

                                                        The reference must be a symbolic reference, otherwise +--

                                                        Calls git_reference_set_target:

                                                        The reference must be a symbolic reference, otherwise -- this method will fail.

                                                        The reference will be automatically updated in -- memory and on disk. --- @param target The new target for the reference. Must be of type string. --- @return true if no error. +-- @param oid Must be of type OID. +-- @param log_message Must be of type string. +-- @return Reference or nil on error. -- @return Error string. -- @name Reference:set_target -function Reference:set_target(target) +function Reference:set_target(oid, log_message) end --- object method. -- ---

                                                        Calls git_reference_type:

                                                        Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) +--

                                                        Calls git_reference_type:

                                                        Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) -- @return integer. -- @name Reference:type function Reference:type() @@ -67,7 +48,7 @@ end --- object method. -- ---

                                                        Calls git_reference_name:

                                                        +--

                                                        Calls git_reference_name:

                                                        -- @return string. -- @name Reference:name function Reference:name() @@ -75,7 +56,7 @@ end --- object method. -- ---

                                                        Calls git_reference_resolve:

                                                        Thie method iteratively peels a symbolic reference +--

                                                        Calls git_reference_resolve:

                                                        Thie method iteratively peels a symbolic reference -- until it resolves to a direct reference to an OID.

                                                        The peeled reference is returned in the `resolved_ref` -- argument, and must be freed manually once it's no longer -- needed.

                                                        If a direct reference is passed as an argument, @@ -89,7 +70,7 @@ end --- object method. -- ---

                                                        Calls git_reference_owner:

                                                        +--

                                                        Calls git_reference_owner:

                                                        -- @return Repository. -- @name Reference:owner function Reference:owner() @@ -97,7 +78,7 @@ end --- object method. -- ---

                                                        Calls git_reference_rename:

                                                        This method works for both direct and symbolic references. +--

                                                        Calls git_reference_rename:

                                                        This method works for both direct and symbolic references. -- The new name will be checked for validity and may be -- modified into a normalized form.

                                                        The given git_reference will be updated in place.

                                                        The reference will be immediately renamed in-memory -- and on disk.

                                                        If the `force` flag is not enabled, and there's already @@ -106,16 +87,17 @@ end -- reflog is enabled for the repository. We only rename -- the reflog if it exists. -- @param new_name The new name for the reference. Must be of type string. --- @param force Overwrite an existing reference. Must be of type boolean. --- @return true if no error. +-- @param force Overwrite an existing reference. Must be of type integer. +-- @param log_message Must be of type string. +-- @return Reference or nil on error. -- @return Error string. -- @name Reference:rename -function Reference:rename(new_name, force) +function Reference:rename(new_name, force, log_message) end --- object method. -- ---

                                                        Calls git_reference_delete:

                                                        This method works for both direct and symbolic references.

                                                        The reference will be immediately removed on disk and from +--

                                                        Calls git_reference_delete:

                                                        This method works for both direct and symbolic references.

                                                        The reference will be immediately removed on disk and from -- memory. The given reference pointer will no longer be valid. -- @return true if no error. -- @return Error string. @@ -123,26 +105,12 @@ end function Reference:delete() end ---- module function. --- ---

                                                        Calls git_reference_packall:

                                                        This method will load into the cache all the loose --- references on the repository and update the --- `packed-refs` file with them.

                                                        Once the `packed-refs` file has been written properly, --- the loose references will be removed from disk. --- @param repo Repository where the loose refs will be packed. Must be of type Repository. --- @return true if no error. --- @return Error string. --- @name Reference.packall -function Reference.packall(repo) -end - --- module function. -- -- @param repo Must be of type Repository. --- @param list_flags Must be of type integer. -- @return StrArray or nil on error. -- @return Error string. -- @name Reference.list -function Reference.list(repo, list_flags) +function Reference.list(repo) end diff --git a/git2/Repository.luadoc b/git2/Repository.luadoc index 3be21a3..1fa97ab 100644 --- a/git2/Repository.luadoc +++ b/git2/Repository.luadoc @@ -8,7 +8,7 @@ module("Repository") --- Create a new Repository object. -- ---

                                                        Calls git_repository_open:

                                                        The 'path' argument must point to either a git repository +--

                                                        Calls git_repository_open:

                                                        The 'path' argument must point to either a git repository -- folder, or an existing work dir.

                                                        The method will automatically detect if 'path' is a normal -- or bare repository or fail is 'path' is neither. -- @param path the path to the repository. Must be of type string. @@ -20,7 +20,7 @@ end --- Create a new Repository object. -- ---

                                                        Calls git_repository_init:

                                                        TODO: +--

                                                        Calls git_repository_init:

                                                        TODO: -- - Reinit the repository -- @param path the path to the repository. Must be of type string. -- @param is_bare if true, a Git repository without a working directory is created at the pointed path. If false, provided path will be considered as the working directory into which the .git directory will be created.. Must be of type integer. @@ -32,7 +32,7 @@ end --- object method. -- ---

                                                        Calls git_repository_head:

                                                        +--

                                                        Calls git_repository_head:

                                                        -- @return Reference or nil on error. -- @return Error string. -- @name Repository:head @@ -41,7 +41,7 @@ end --- object method. -- ---

                                                        Calls git_repository_head_detached:

                                                        A repository's HEAD is detached when it points directly to a commit +--

                                                        Calls git_repository_head_detached:

                                                        A repository's HEAD is detached when it points directly to a commit -- instead of a branch. -- @return boolean. -- @name Repository:head_detached @@ -50,16 +50,14 @@ end --- object method. -- ---

                                                        Calls git_repository_head_orphan:

                                                        An orphan branch is one named from HEAD but which doesn't exist in --- the refs namespace, because it doesn't have any commit to point to. -- @return boolean. --- @name Repository:head_orphan -function Repository:head_orphan() +-- @name Repository:head_unborn +function Repository:head_unborn() end --- object method. -- ---

                                                        Calls git_repository_is_empty:

                                                        An empty repository has just been initialized and contains +--

                                                        Calls git_repository_is_empty:

                                                        An empty repository has just been initialized and contains -- no commits. -- @return boolean. -- @name Repository:is_empty @@ -68,7 +66,7 @@ end --- object method. -- ---

                                                        Calls git_repository_is_bare:

                                                        +--

                                                        Calls git_repository_is_bare:

                                                        -- @return boolean. -- @name Repository:is_bare function Repository:is_bare() @@ -76,7 +74,7 @@ end --- object method. -- ---

                                                        Calls git_repository_path:

                                                        This is the path of the `.git` folder for normal repositories, +--

                                                        Calls git_repository_path:

                                                        This is the path of the `.git` folder for normal repositories, -- or of the repository itself for bare repositories. -- @return string. -- @name Repository:path @@ -85,7 +83,7 @@ end --- object method. -- ---

                                                        Calls git_repository_workdir:

                                                        If the repository is bare, this function will always return +--

                                                        Calls git_repository_workdir:

                                                        If the repository is bare, this function will always return -- NULL. -- @return string. -- @name Repository:workdir @@ -94,21 +92,22 @@ end --- object method. -- ---

                                                        Calls git_repository_set_workdir:

                                                        The working directory doesn't need to be the same one +--

                                                        Calls git_repository_set_workdir:

                                                        The working directory doesn't need to be the same one -- that contains the `.git` folder for this repository.

                                                        If this repository is bare, setting its working directory -- will turn it into a normal repository, capable of performing -- all the common workdir operations (checkout, status, index -- manipulation, etc). -- @param workdir The path to a working directory. Must be of type string. +-- @param update_gitlink Must be of type integer. -- @return true if no error. -- @return Error string. -- @name Repository:set_workdir -function Repository:set_workdir(workdir) +function Repository:set_workdir(workdir, update_gitlink) end --- object method. -- ---

                                                        Calls git_repository_config:

                                                        If a configuration file has not been set, the default +--

                                                        Calls git_repository_config:

                                                        If a configuration file has not been set, the default -- config set for the repository will be returned, including -- global and system configurations (if they are available).

                                                        The configuration file must be freed once it's no longer -- being used by the user. @@ -120,7 +119,7 @@ end --- object method. -- ---

                                                        Calls git_repository_set_config:

                                                        This configuration file will be used for all configuration +--

                                                        Calls git_repository_set_config:

                                                        This configuration file will be used for all configuration -- queries involving this repository.

                                                        The repository will keep a reference to the config file; -- the user must still free the config after setting it -- to the repository, or it will leak. @@ -131,7 +130,7 @@ end --- object method. -- ---

                                                        Calls git_repository_odb:

                                                        If a custom ODB has not been set, the default +--

                                                        Calls git_repository_odb:

                                                        If a custom ODB has not been set, the default -- database for the repository will be returned (the one -- located in `.git/objects`).

                                                        The ODB must be freed once it's no longer being used by -- the user. @@ -143,7 +142,7 @@ end --- object method. -- ---

                                                        Calls git_repository_set_odb:

                                                        The ODB will be used for all object-related operations +--

                                                        Calls git_repository_set_odb:

                                                        The ODB will be used for all object-related operations -- involving this repository.

                                                        The repository will keep a reference to the ODB; the user -- must still free the ODB object after setting it to the -- repository, or it will leak. @@ -154,7 +153,7 @@ end --- object method. -- ---

                                                        Calls git_repository_index:

                                                        If a custom index has not been set, the default +--

                                                        Calls git_repository_index:

                                                        If a custom index has not been set, the default -- index for the repository will be returned (the one -- located in `.git/index`).

                                                        The index must be freed once it's no longer being used by -- the user. @@ -166,7 +165,7 @@ end --- object method. -- ---

                                                        Calls git_repository_set_index:

                                                        This index will be used for all index-related operations +--

                                                        Calls git_repository_set_index:

                                                        This index will be used for all index-related operations -- involving this repository.

                                                        The repository will keep a reference to the index file; -- the user must still free the index after setting it -- to the repository, or it will leak. diff --git a/git2/RevWalk.luadoc b/git2/RevWalk.luadoc index c0c8794..76cc123 100644 --- a/git2/RevWalk.luadoc +++ b/git2/RevWalk.luadoc @@ -8,7 +8,7 @@ module("RevWalk") --- Create a new RevWalk object. -- ---

                                                        Calls git_revwalk_new:

                                                        This revision walker uses a custom memory pool and an internal +--

                                                        Calls git_revwalk_new:

                                                        This revision walker uses a custom memory pool and an internal -- commit cache, so it is relatively expensive to allocate.

                                                        For maximum performance, this revision walker should be -- reused for different walks.

                                                        This revision walker is *not* thread safe: it may only be -- used to walk a repository on a single thread; however, @@ -23,14 +23,14 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_revwalk_free:

                                                        +--

                                                        Calls git_revwalk_free:

                                                        -- @name RevWalk:close function RevWalk:close() end --- object method. -- ---

                                                        Calls git_revwalk_reset:

                                                        This will clear all the pushed and hidden commits, and +--

                                                        Calls git_revwalk_reset:

                                                        This will clear all the pushed and hidden commits, and -- leave the walker in a blank state (just like at -- creation) ready to receive new commit pushes and -- start a new walk.

                                                        The revision walk is automatically reset when a walk @@ -41,7 +41,7 @@ end --- object method. -- ---

                                                        Calls git_revwalk_push:

                                                        The given OID must belong to a commit on the walked +--

                                                        Calls git_revwalk_push:

                                                        The given OID must belong to a commit on the walked -- repository.

                                                        The given commit will be used as one of the roots -- when starting the revision walk. At least one commit -- must be pushed the repository before a walk can @@ -55,7 +55,7 @@ end --- object method. -- ---

                                                        Calls git_revwalk_hide:

                                                        The given OID must belong to a commit on the walked +--

                                                        Calls git_revwalk_hide:

                                                        The given OID must belong to a commit on the walked -- repository.

                                                        The resolved commit and all its parents will be hidden from the -- output on the revision walk. -- @param id Must be of type OID. @@ -67,7 +67,7 @@ end --- object method. -- ---

                                                        Calls git_revwalk_next:

                                                        The initial call to this method is *not* blocking when +--

                                                        Calls git_revwalk_next:

                                                        The initial call to this method is *not* blocking when -- iterating through a repo with a time-sorting mode.

                                                        Iterating with Topological or inverted modes makes the initial -- call blocking to preprocess the commit list, but this block should be -- mostly unnoticeable on most repositories (topological preprocessing @@ -80,7 +80,7 @@ end --- object method. -- ---

                                                        Calls git_revwalk_sorting:

                                                        Changing the sorting mode resets the walker. +--

                                                        Calls git_revwalk_sorting:

                                                        Changing the sorting mode resets the walker. -- @param sort_mode combination of GIT_SORT_XXX flags. Must be of type integer. -- @name RevWalk:sorting function RevWalk:sorting(sort_mode) @@ -88,7 +88,7 @@ end --- object method. -- ---

                                                        Calls git_revwalk_repository:

                                                        +--

                                                        Calls git_revwalk_repository:

                                                        -- @return Repository. -- @name RevWalk:repository function RevWalk:repository() diff --git a/git2/Signature.luadoc b/git2/Signature.luadoc index e8802f5..ea381a2 100644 --- a/git2/Signature.luadoc +++ b/git2/Signature.luadoc @@ -8,7 +8,7 @@ module("Signature") --- Create a new Signature object. -- ---

                                                        Calls git_signature_new:

                                                        +--

                                                        Calls git_signature_new:

                                                        -- @param name name of the person. Must be of type string. -- @param email email of the person. Must be of type string. -- @param time time when the action happened. Must be of type integer. @@ -21,7 +21,7 @@ end --- Create a new Signature object. -- ---

                                                        Calls git_signature_now:

                                                        +--

                                                        Calls git_signature_now:

                                                        -- @param name name of the person. Must be of type string. -- @param email email of the person. Must be of type string. -- @return Signature or nil on error. diff --git a/git2/Tag.luadoc b/git2/Tag.luadoc index 653cc9e..a325b58 100644 --- a/git2/Tag.luadoc +++ b/git2/Tag.luadoc @@ -9,7 +9,7 @@ module("Tag") --- Create a new Tag object. -- ---

                                                        Calls git_tag_lookup:

                                                        +--

                                                        Calls git_tag_lookup:

                                                        -- @param repo the repo to use when locating the tag.. Must be of type Repository. -- @param id identity of the tag to locate.. Must be of type OID. -- @return Tag or nil on error. @@ -20,7 +20,7 @@ end --- object method. -- ---

                                                        Calls git_tag_target:

                                                        This method performs a repository lookup for the +--

                                                        Calls git_tag_target:

                                                        This method performs a repository lookup for the -- given object and returns it -- @return Object or nil on error. -- @return Error string. @@ -30,7 +30,7 @@ end --- object method. -- ---

                                                        Calls git_tag_name:

                                                        +--

                                                        Calls git_tag_name:

                                                        -- @return string. -- @name Tag:name function Tag:name() @@ -38,7 +38,7 @@ end --- object method. -- ---

                                                        Calls git_tag_tagger:

                                                        +--

                                                        Calls git_tag_tagger:

                                                        -- @return Signature. -- @name Tag:tagger function Tag:tagger() @@ -46,7 +46,7 @@ end --- object method. -- ---

                                                        Calls git_tag_message:

                                                        +--

                                                        Calls git_tag_message:

                                                        -- @return string. -- @name Tag:message function Tag:message() @@ -54,7 +54,7 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing +--

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing -- object; note that git_objects are owned and cached by the repository -- so the object may or may not be freed after this library call, -- depending on how agressive is the caching mechanism used @@ -67,7 +67,7 @@ end --- object method. -- ---

                                                        Calls git_object_id:

                                                        +--

                                                        Calls git_object_id:

                                                        -- @return OID. -- @name Object:id function Object:id() @@ -75,7 +75,7 @@ end --- object method. -- ---

                                                        Calls git_object_type:

                                                        +--

                                                        Calls git_object_type:

                                                        -- @return string. -- @name Object:type function Object:type() @@ -83,7 +83,7 @@ end --- object method. -- ---

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the +--

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the -- returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without -- affecting the object. -- @return Repository. diff --git a/git2/Tree.luadoc b/git2/Tree.luadoc index 7f0831b..c60941e 100644 --- a/git2/Tree.luadoc +++ b/git2/Tree.luadoc @@ -9,7 +9,7 @@ module("Tree") --- Create a new Tree object. -- ---

                                                        Calls git_tree_lookup:

                                                        +--

                                                        Calls git_tree_lookup:

                                                        -- @param repo the repo to use when locating the tree.. Must be of type Repository. -- @param id identity of the tree to locate.. Must be of type OID. -- @return Tree or nil on error. @@ -20,7 +20,7 @@ end --- object method. -- ---

                                                        Calls git_tree_entrycount:

                                                        +--

                                                        Calls git_tree_entrycount:

                                                        -- @return integer. -- @name Tree:entrycount function Tree:entrycount() @@ -28,7 +28,7 @@ end --- object method. -- ---

                                                        Calls git_tree_entry_byname:

                                                        +--

                                                        Calls git_tree_entry_byname:

                                                        -- @param filename the filename of the desired entry. Must be of type string. -- @return TreeEntry. -- @name Tree:entry_byname @@ -37,7 +37,7 @@ end --- object method. -- ---

                                                        Calls git_tree_entry_byindex:

                                                        +--

                                                        Calls git_tree_entry_byindex:

                                                        -- @param index Must be of type integer. -- @return TreeEntry. -- @name Tree:entry_byindex @@ -46,7 +46,7 @@ end --- Destroy this object (will be called by Garbage Collector). -- ---

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing +--

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing -- object; note that git_objects are owned and cached by the repository -- so the object may or may not be freed after this library call, -- depending on how agressive is the caching mechanism used @@ -59,7 +59,7 @@ end --- object method. -- ---

                                                        Calls git_object_id:

                                                        +--

                                                        Calls git_object_id:

                                                        -- @return OID. -- @name Object:id function Object:id() @@ -67,7 +67,7 @@ end --- object method. -- ---

                                                        Calls git_object_type:

                                                        +--

                                                        Calls git_object_type:

                                                        -- @return string. -- @name Object:type function Object:type() @@ -75,7 +75,7 @@ end --- object method. -- ---

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the +--

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the -- returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without -- affecting the object. -- @return Repository. diff --git a/git2/TreeEntry.luadoc b/git2/TreeEntry.luadoc index 7fb85ea..8baa592 100644 --- a/git2/TreeEntry.luadoc +++ b/git2/TreeEntry.luadoc @@ -8,7 +8,7 @@ module("TreeEntry") --- object method. -- ---

                                                        Calls git_tree_entry_name:

                                                        +--

                                                        Calls git_tree_entry_name:

                                                        -- @return string. -- @name TreeEntry:name function TreeEntry:name() @@ -16,10 +16,9 @@ end --- object method. -- ---

                                                        Calls git_tree_entry_attributes:

                                                        -- @return integer. --- @name TreeEntry:attributes -function TreeEntry:attributes() +-- @name TreeEntry:filemode +function TreeEntry:filemode() end --- object method. @@ -31,7 +30,7 @@ end --- object method. -- ---

                                                        Calls git_tree_entry_to_object:

                                                        @param object pointer to the converted object +--

                                                        Calls git_tree_entry_to_object:

                                                        @param object pointer to the converted object -- @param repo repository where to lookup the pointed object. Must be of type Repository. -- @return Object or nil on error. -- @return Error string. diff --git a/modules/Blob.html b/modules/Blob.html index 5e01c97..9b3104d 100644 --- a/modules/Blob.html +++ b/modules/Blob.html @@ -143,12 +143,12 @@

                                                        Functions

                                                        - + - + @@ -204,20 +204,20 @@

                                                        Functions

                                                        -
                                                        Blob.frombuffer (repo, buffer)
                                                        +
                                                        Blob.from_buffer (repo, buffer)
                                                        -module function.

                                                        Calls git_blob_create_frombuffer:

                                                        +module function.

                                                        Parameters

                                                        • - repo: repository where to blob will be written. Must be of type Repository. + repo: Must be of type Repository.
                                                        • - buffer: data to be written into the blob. Must be of type string. + buffer: Must be of type string.
                                                        @@ -243,20 +243,20 @@

                                                        Return values:

                                                        -
                                                        Blob.fromfile (repo, path)
                                                        +
                                                        Blob.from_disk (repo, path)
                                                        -module function.

                                                        Calls git_blob_create_fromfile:

                                                        +module function.

                                                        Parameters

                                                        • - repo: repository where the blob will be written. this repository cannot be bare. Must be of type Repository. + repo: Must be of type Repository.
                                                        • - path: file from which the blob will be created, relative to the repository's working dir. Must be of type string. + path: Must be of type string.
                                                        @@ -284,7 +284,7 @@

                                                        Return values:

                                                        Blob.lookup (repo, id)
                                                        -Create a new Blob object.

                                                        Calls git_blob_lookup:

                                                        +Create a new Blob object.

                                                        Calls git_blob_lookup:

                                                        Parameters

                                                        @@ -323,7 +323,7 @@

                                                        Return values:

                                                        Blob:rawcontent ()
                                                        -object method.

                                                        Calls git_blob_rawcontent:

                                                        A pointer to the raw content of a blob is returned; this pointer is owned internally by the object and shall not be free'd. The pointer may be invalidated at a later time.

                                                        Calls git_blob_rawsize:

                                                        +object method.

                                                        Calls git_blob_rawcontent:

                                                        A pointer to the raw content of a blob is returned; this pointer is owned internally by the object and shall not be free'd. The pointer may be invalidated at a later time.

                                                        Calls git_blob_rawsize:

                                                        @@ -343,7 +343,7 @@

                                                        Return value:

                                                        Blob:rawsize ()
                                                        -object method.

                                                        Calls git_blob_rawsize:

                                                        +object method.

                                                        Calls git_blob_rawsize:

                                                        @@ -363,7 +363,7 @@

                                                        Return value:

                                                        Object:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -380,7 +380,7 @@

                                                        Return value:

                                                        Object:id ()
                                                        -object method.

                                                        Calls git_object_id:

                                                        +object method.

                                                        Calls git_object_id:

                                                        @@ -400,7 +400,7 @@

                                                        Return value:

                                                        Object:owner ()
                                                        -object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. +object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. @@ -420,7 +420,7 @@

                                                        Return value:

                                                        Object:type ()
                                                        -object method.

                                                        Calls git_object_type:

                                                        +object method.

                                                        Calls git_object_type:

                                                        diff --git a/modules/Commit.html b/modules/Commit.html index ab884fb..6851e13 100644 --- a/modules/Commit.html +++ b/modules/Commit.html @@ -308,7 +308,7 @@

                                                        Return values:

                                                        Commit.lookup (repo, id)
                                                        -Create a new Commit object.

                                                        Calls git_commit_lookup:

                                                        +Create a new Commit object.

                                                        Calls git_commit_lookup:

                                                        Parameters

                                                        @@ -347,7 +347,7 @@

                                                        Return values:

                                                        Commit:author ()
                                                        -object method.

                                                        Calls git_commit_author:

                                                        +object method.

                                                        Calls git_commit_author:

                                                        @@ -367,7 +367,7 @@

                                                        Return value:

                                                        Commit:committer ()
                                                        -object method.

                                                        Calls git_commit_committer:

                                                        +object method.

                                                        Calls git_commit_committer:

                                                        @@ -387,7 +387,7 @@

                                                        Return value:

                                                        Commit:id ()
                                                        -object method.

                                                        Calls git_commit_id:

                                                        +object method.

                                                        Calls git_commit_id:

                                                        @@ -407,7 +407,7 @@

                                                        Return value:

                                                        Commit:message ()
                                                        -object method.

                                                        Calls git_commit_message:

                                                        +object method.

                                                        Calls git_commit_message:

                                                        @@ -427,7 +427,7 @@

                                                        Return value:

                                                        Commit:message_encoding ()
                                                        -object method.

                                                        Calls git_commit_message_encoding:

                                                        The encoding may be NULL if the `encoding` header in the commit is missing; in that case UTF-8 is assumed. +object method.

                                                        Calls git_commit_message_encoding:

                                                        The encoding may be NULL if the `encoding` header in the commit is missing; in that case UTF-8 is assumed. @@ -447,7 +447,7 @@

                                                        Return value:

                                                        Commit:parent (n)
                                                        -object method.

                                                        Calls git_commit_parent:

                                                        +object method.

                                                        Calls git_commit_parent:

                                                        Parameters

                                                        @@ -482,7 +482,7 @@

                                                        Return values:

                                                        Commit:parentcount ()
                                                        -object method.

                                                        Calls git_commit_parentcount:

                                                        +object method.

                                                        Calls git_commit_parentcount:

                                                        @@ -502,7 +502,7 @@

                                                        Return value:

                                                        Commit:time ()
                                                        -object method.

                                                        Calls git_commit_time:

                                                        +object method.

                                                        Calls git_commit_time:

                                                        @@ -522,7 +522,7 @@

                                                        Return value:

                                                        Commit:time_offset ()
                                                        -object method.

                                                        Calls git_commit_time_offset:

                                                        +object method.

                                                        Calls git_commit_time_offset:

                                                        @@ -542,7 +542,7 @@

                                                        Return value:

                                                        Commit:tree ()
                                                        -object method.

                                                        Calls git_commit_tree:

                                                        +object method.

                                                        Calls git_commit_tree:

                                                        @@ -568,7 +568,7 @@

                                                        Return values:

                                                        Object:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -585,7 +585,7 @@

                                                        Return values:

                                                        Object:id ()
                                                        -object method.

                                                        Calls git_object_id:

                                                        +object method.

                                                        Calls git_object_id:

                                                        @@ -605,7 +605,7 @@

                                                        Return value:

                                                        Object:owner ()
                                                        -object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. +object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. @@ -625,7 +625,7 @@

                                                        Return value:

                                                        Object:type ()
                                                        -object method.

                                                        Calls git_object_type:

                                                        +object method.

                                                        Calls git_object_type:

                                                        diff --git a/modules/Config.html b/modules/Config.html index 213b179..4c12713 100644 --- a/modules/Config.html +++ b/modules/Config.html @@ -153,12 +153,17 @@

                                                        Functions

                                                        - + - + + + + + + @@ -226,7 +231,7 @@

                                                        Functions

                                                        Config.new ()
                                                        -Create a new Config object.

                                                        Calls git_config_new:

                                                        This object is empty, so you have to add a file to it before you can do anything with it. +Create a new Config object.

                                                        Calls git_config_new:

                                                        This object is empty, so you have to add a file to it before you can do anything with it. @@ -252,7 +257,7 @@

                                                        Return values:

                                                        Config.open (path)
                                                        -Create a new Config object.

                                                        Calls git_config_open_ondisk:

                                                        This method is a simple utility wrapper for the following sequence of calls: - git_config_new - git_config_add_file_ondisk +Create a new Config object.

                                                        Calls git_config_open_ondisk:

                                                        This method is a simple utility wrapper for the following sequence of calls: - git_config_new - git_config_add_file_ondisk

                                                        Parameters

                                                        @@ -285,9 +290,9 @@

                                                        Return values:

                                                        -
                                                        Config:add_file_ondisk (path, priority)
                                                        +
                                                        Config:add_file_ondisk (path, level, repo, force)
                                                        -object method.

                                                        Calls git_config_add_file_ondisk:

                                                        The on-disk file pointed at by `path` will be opened and parsed; it's expected to be a native Git config file following the default Git config syntax (see man git-config).

                                                        Note that the configuration object will free the file automatically.

                                                        Further queries on this config object will access each of the config file instances in order (instances with a higher priority will be accessed first). +object method.

                                                        Calls git_config_add_file_ondisk:

                                                        The on-disk file pointed at by `path` will be opened and parsed; it's expected to be a native Git config file following the default Git config syntax (see man git-config).

                                                        Note that the configuration object will free the file automatically.

                                                        Further queries on this config object will access each of the config file instances in order (instances with a higher priority will be accessed first).

                                                        Parameters

                                                        @@ -298,7 +303,15 @@

                                                        Parameters

                                                      4. - priority: the priority the backend should have. Must be of type integer. + level: Must be of type integer. +
                                                        5. + +
                                                      5. + repo: Must be of type Repository. +
                                                        6. + +
                                                      6. + force: Must be of type integer.
                                                        7. @@ -324,16 +337,55 @@

                                                        Return values:

                                                        -
                                                        Config:delete (name)
                                                        +
                                                        Config:delete_entry (name)
                                                        -object method.

                                                        Calls git_config_delete:

                                                        +object method.

                                                        Parameters

                                                        • - name: the variable to delete. Must be of type string. + name: Must be of type string. +
                                                          • + +
                                                        + + + + + + +

                                                        Return values:

                                                        +
                                                          + +
                                                        1. true if no error. + +
                                                        2. Error string. + +
                                                        + + + +
                                                        + + + + +
                                                        Config:delete_multivar (name, regexp)
                                                        +
                                                        +object method. + + +

                                                        Parameters

                                                        +
                                                          + +
                                                        • + name: Must be of type string. +
                                                          • + +
                                                        • + regexp: Must be of type string.
                                                        @@ -361,7 +413,7 @@

                                                        Return values:

                                                        Config:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_config_free:

                                                        +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_config_free:

                                                        @@ -378,7 +430,7 @@

                                                        Return values:

                                                        Config:get_bool (name)
                                                        -object method.

                                                        Calls git_config_get_bool:

                                                        This function uses the usual C convention of 0 being false and anything else true. +object method.

                                                        Calls git_config_get_bool:

                                                        This function uses the usual C convention of 0 being false and anything else true.

                                                        Parameters

                                                        @@ -483,7 +535,7 @@

                                                        Return values:

                                                        Config:get_string (name)
                                                        -object method.

                                                        Calls git_config_get_string:

                                                        The string is owned by the variable and should not be freed by the user. +object method.

                                                        Calls git_config_get_string:

                                                        The string is owned by the variable and should not be freed by the user.

                                                        Parameters

                                                        @@ -518,7 +570,7 @@

                                                        Return values:

                                                        Config:set_bool (value, name)
                                                        -object method.

                                                        Calls git_config_set_bool:

                                                        +object method.

                                                        Calls git_config_set_bool:

                                                        Parameters

                                                        @@ -635,7 +687,7 @@

                                                        Return values:

                                                        Config:set_string (name, value)
                                                        -object method.

                                                        Calls git_config_set_string:

                                                        A copy of the string is made and the user is free to use it afterwards. +object method.

                                                        Calls git_config_set_string:

                                                        A copy of the string is made and the user is free to use it afterwards.

                                                        Parameters

                                                        diff --git a/modules/Index.html b/modules/Index.html index 8857b39..7b2f50c 100644 --- a/modules/Index.html +++ b/modules/Index.html @@ -148,22 +148,12 @@

                                                        Functions

                                                        - + - - - - - - - - - - - + @@ -178,47 +168,47 @@

                                                        Functions

                                                        - + - + - + - + - + - + - + - + - + @@ -246,7 +236,7 @@

                                                        Functions

                                                        Index.bare (index_path)
                                                        -Create a new Index object.

                                                        Calls git_index_open:

                                                        Since there is no ODB or working directory behind this index, any Index methods which rely on these (e.g. index_add) will fail with the GIT_EBAREINDEX error code.

                                                        If you need to access the index of an actual repository, use the `git_repository_index` wrapper.

                                                        The index must be freed once it's no longer in use. +Create a new Index object.

                                                        Calls git_index_open:

                                                        Since there is no ODB or working directory behind this index, any Index methods which rely on these (e.g. index_add) will fail with the GIT_EBAREINDEX error code.

                                                        If you need to access the index of an actual repository, use the `git_repository_index` wrapper.

                                                        The index must be freed once it's no longer in use.

                                                        Parameters

                                                        @@ -279,48 +269,9 @@

                                                        Return values:

                                                        -
                                                        Index:add (path, stage)
                                                        +
                                                        Index:add (source_entry)
                                                        -object method.

                                                        Calls git_index_add:

                                                        The file `path` must be relative to the repository's working folder and must be readable.

                                                        This method will fail in bare index instances.

                                                        This forces the file to be added to the index, not looking at gitignore rules. Those rules can be evaluated through the git_status APIs (in status.h) before calling this. - - -

                                                        Parameters

                                                        -
                                                          - -
                                                        • - path: filename to add. Must be of type string. -
                                                          • - -
                                                        • - stage: stage for the entry. Must be of type integer. -
                                                          • - -
                                                        - - - - - - -

                                                        Return values:

                                                        -
                                                          - -
                                                        1. true if no error. - -
                                                        2. Error string. - -
                                                        - - - -
                                                        - - - - -
                                                        Index:add2 (source_entry)
                                                        -
                                                        -object method. +object method.

                                                        Calls git_index_add:

                                                        The file `path` must be relative to the repository's working folder and must be readable.

                                                        This method will fail in bare index instances.

                                                        This forces the file to be added to the index, not looking at gitignore rules. Those rules can be evaluated through the git_status APIs (in status.h) before calling this.

                                                        Parameters

                                                        @@ -353,46 +304,7 @@

                                                        Return values:

                                                        -
                                                        Index:append (path, stage)
                                                        -
                                                        -object method.

                                                        Calls git_index_append:

                                                        A new entry will always be inserted into the index; if the index already contains an entry for such path, the old entry will **not** be replaced.

                                                        The file `path` must be relative to the repository's working folder and must be readable.

                                                        This method will fail in bare index instances. - - -

                                                        Parameters

                                                        -
                                                          - -
                                                        • - path: filename to add. Must be of type string. -
                                                          • - -
                                                        • - stage: stage for the entry. Must be of type integer. -
                                                          • - -
                                                        - - - - - - -

                                                        Return values:

                                                        -
                                                          - -
                                                        1. true if no error. - -
                                                        2. Error string. - -
                                                        - - - -
                                                        - - - - -
                                                        Index:append2 (source_entry)
                                                        +
                                                        Index:add_bypath (path)
                                                        object method. @@ -401,7 +313,7 @@

                                                        Parameters

                                                        • - source_entry: Must be of type IndexEntry. + path: Must be of type string.
                                                        @@ -429,7 +341,7 @@

                                                        Return values:

                                                        Index:clear ()
                                                        -object method.

                                                        Calls git_index_clear:

                                                        +object method.

                                                        Calls git_index_clear:

                                                        @@ -446,27 +358,7 @@

                                                        Return values:

                                                        Index:entrycount ()
                                                        -object method.

                                                        Calls git_index_entrycount:

                                                        - - - - - - - -

                                                        Return value:

                                                        -integer. - - - -
                                                        - - - - -
                                                        Index:entrycount_unmerged ()
                                                        -
                                                        -object method.

                                                        Calls git_index_entrycount_unmerged:

                                                        +object method.

                                                        Calls git_index_entrycount:

                                                        @@ -484,14 +376,18 @@

                                                        Return value:

                                                        -
                                                        Index:find (path)
                                                        +
                                                        Index:find (at_pos, path)
                                                        -object method.

                                                        Calls git_index_find:

                                                        +object method.

                                                        Calls git_index_find:

                                                        Parameters

                                                          +
                                                        • + at_pos: Must be of type lightuserdata. +
                                                          • +
                                                        • path: path to search. Must be of type string.
                                                          • @@ -513,16 +409,16 @@

                                                          Return value:

                                                          -
                                                          Index:get (n)
                                                          +
                                                          Index:get_byindex (n)
                                                          -object method.

                                                          Calls git_index_get:

                                                          This entry can be modified, and the changes will be written back to disk on the next write() call.

                                                          The entry should not be freed by the caller. +object method.

                                                          Parameters

                                                          • - n: the position of the entry. Must be of type integer. + n: Must be of type integer.
                                                          @@ -542,16 +438,20 @@

                                                          Return value:

                                                          -
                                                          Index:get_unmerged_byindex (n)
                                                          +
                                                          Index:get_bypath (path, stage)
                                                          -object method.

                                                          Calls git_index_get_unmerged_byindex:

                                                          The returned entry is read-only and should not be modified of freed by the caller. +object method.

                                                          Parameters

                                                          • - n: the position of the entry. Must be of type integer. + path: Must be of type string. +
                                                            • + +
                                                          • + stage: Must be of type integer.
                                                          @@ -562,7 +462,7 @@

                                                          Parameters

                                                          Return value:

                                                          -IndexEntryUnmerged. +IndexEntry. @@ -571,16 +471,16 @@

                                                          Return value:

                                                          -
                                                          Index:get_unmerged_bypath (path)
                                                          +
                                                          Index:read (force)
                                                          -object method.

                                                          Calls git_index_get_unmerged_bypath:

                                                          The returned entry is read-only and should not be modified of freed by the caller. +object method.

                                                          Calls git_index_read:

                                                          Parameters

                                                          • - path: path to search. Must be of type string. + force: Must be of type integer.
                                                          @@ -590,8 +490,14 @@

                                                          Parameters

                                                          -

                                                          Return value:

                                                          -IndexEntryUnmerged. +

                                                          Return values:

                                                          +
                                                            + +
                                                          1. true if no error. + +
                                                          2. Error string. + +
                                                          @@ -600,10 +506,19 @@

                                                          Return value:

                                                          -
                                                          Index:read ()
                                                          +
                                                          Index:read_tree (tree)
                                                          -object method.

                                                          Calls git_index_read:

                                                          +object method.

                                                          Calls git_index_read_tree:

                                                          The current index contents will be replaced by the specified tree. + +

                                                          Parameters

                                                          +
                                                            + +
                                                          • + tree: tree to read. Must be of type Tree. +
                                                            • + +
                                                          @@ -626,16 +541,20 @@

                                                          Return values:

                                                          -
                                                          Index:read_tree (tree)
                                                          +
                                                          Index:remove (path, stage)
                                                          -object method.

                                                          Calls git_index_read_tree:

                                                          The current index contents will be replaced by the specified tree. +object method.

                                                          Calls git_index_remove:

                                                          Parameters

                                                          • - tree: tree to read. Must be of type Tree. + path: Must be of type string. +
                                                            • + +
                                                          • + stage: Must be of type integer.
                                                          @@ -661,16 +580,36 @@

                                                          Return values:

                                                          -
                                                          Index:remove (position)
                                                          +
                                                          Index:reuc_entrycount ()
                                                          +
                                                          +object method. + + + + + + + +

                                                          Return value:

                                                          +integer. + + + +
                                                          + + + + +
                                                          Index:reuc_get_byindex (n)
                                                          -object method.

                                                          Calls git_index_remove:

                                                          +object method.

                                                          Parameters

                                                          • - position: position of the entry to remove. Must be of type integer. + n: Must be of type integer.
                                                          @@ -680,14 +619,8 @@

                                                          Parameters

                                                          -

                                                          Return values:

                                                          -
                                                            - -
                                                          1. true if no error. - -
                                                          2. Error string. - -
                                                          +

                                                          Return value:

                                                          +IndexEntryUnmerged. @@ -696,15 +629,27 @@

                                                          Return values:

                                                          -
                                                          Index:uniq ()
                                                          +
                                                          Index:reuc_get_bypath (path)
                                                          -object method.

                                                          Calls git_index_uniq:

                                                          +object method. + + +

                                                          Parameters

                                                          +
                                                            + +
                                                          • + path: Must be of type string. +
                                                            • + +
                                                          +

                                                          Return value:

                                                          +IndexEntryUnmerged. @@ -715,7 +660,7 @@

                                                          Return values:

                                                          Index:write ()
                                                          -object method.

                                                          Calls git_index_write:

                                                          +object method.

                                                          Calls git_index_write:

                                                          diff --git a/modules/IndexEntry.html b/modules/IndexEntry.html index 4ff440e..443038c 100644 --- a/modules/IndexEntry.html +++ b/modules/IndexEntry.html @@ -178,22 +178,22 @@

                                                          Functions

                                                        - + - + - + - + @@ -390,7 +390,7 @@

                                                        Return value:

                                                        -
                                                        IndexEntry:ino ()
                                                        +
                                                        IndexEntry:id ()
                                                        object method. @@ -401,7 +401,7 @@

                                                        Return value:

                                                        Return value:

                                                        -integer. +OID. @@ -410,7 +410,7 @@

                                                        Return value:

                                                        -
                                                        IndexEntry:mode ()
                                                        +
                                                        IndexEntry:ino ()
                                                        object method. @@ -430,7 +430,7 @@

                                                        Return value:

                                                        -
                                                        IndexEntry:mtime ()
                                                        +
                                                        IndexEntry:mode ()
                                                        object method. @@ -440,14 +440,8 @@

                                                        Return value:

                                                        -

                                                        Return values:

                                                        -
                                                          - -
                                                        1. integer. - -
                                                        2. integer. - -
                                                        +

                                                        Return value:

                                                        +integer. @@ -456,7 +450,7 @@

                                                        Return values:

                                                        -
                                                        IndexEntry:oid ()
                                                        +
                                                        IndexEntry:mtime ()
                                                        object method. @@ -466,8 +460,14 @@

                                                        Return values:

                                                        -

                                                        Return value:

                                                        -OID. +

                                                        Return values:

                                                        +
                                                          + +
                                                        1. integer. + +
                                                        2. integer. + +
                                                        @@ -584,7 +584,7 @@

                                                        Parameters

                                                        IndexEntry:stage ()
                                                        -object method.

                                                        Calls git_index_entry_stage:

                                                        This entry is calculated from the entrie's flag +object method.

                                                        Calls git_index_entry_stage:

                                                        This entry is calculated from the entrie's flag diff --git a/modules/ODB.html b/modules/ODB.html index 1076315..9f575d9 100644 --- a/modules/ODB.html +++ b/modules/ODB.html @@ -221,7 +221,7 @@

                                                        Functions

                                                        ODB.hash (data, otype)
                                                        -module function.

                                                        Calls git_odb_hash:

                                                        The resulting SHA-1 OID will the itentifier for the data buffer as if the data buffer it were to written to the ODB. +module function.

                                                        Calls git_odb_hash:

                                                        The resulting SHA-1 OID will the itentifier for the data buffer as if the data buffer it were to written to the ODB.

                                                        Parameters

                                                        @@ -260,7 +260,7 @@

                                                        Return values:

                                                        ODB.hashfile (path, otype)
                                                        -module function.

                                                        Calls git_odb_hashfile:

                                                        +module function.

                                                        Calls git_odb_hashfile:

                                                        Parameters

                                                        @@ -299,7 +299,7 @@

                                                        Return values:

                                                        ODB.new ()
                                                        -Create a new ODB object.

                                                        Calls git_odb_new:

                                                        Before the ODB can be used for read/writing, a custom database backend must be manually added using `git_odb_add_backend()` +Create a new ODB object.

                                                        Calls git_odb_new:

                                                        Before the ODB can be used for read/writing, a custom database backend must be manually added using `git_odb_add_backend()` @@ -325,7 +325,7 @@

                                                        Return values:

                                                        ODB.open (object_dir)
                                                        -Create a new ODB object.

                                                        Calls git_odb_open:

                                                        - git_odb_backend_loose: read and write loose object files from disk, assuming `objects_dir` as the Objects folder

                                                        - git_odb_backend_pack: read objects from packfiles, assuming `objects_dir` as the Objects folder which contains a 'pack/' folder with the corresponding data +Create a new ODB object.

                                                        Calls git_odb_open:

                                                        - git_odb_backend_loose: read and write loose object files from disk, assuming `objects_dir` as the Objects folder

                                                        - git_odb_backend_pack: read objects from packfiles, assuming `objects_dir` as the Objects folder which contains a 'pack/' folder with the corresponding data

                                                        Parameters

                                                        @@ -438,7 +438,7 @@

                                                        Return values:

                                                        ODB:exists (id)
                                                        -object method.

                                                        Calls git_odb_exists:

                                                        @return - 1, if the object was found - 0, otherwise +object method.

                                                        Calls git_odb_exists:

                                                        @return - 1, if the object was found - 0, otherwise

                                                        Parameters

                                                        @@ -473,7 +473,7 @@

                                                        Return values:

                                                        ODB:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_odb_free:

                                                        +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_odb_free:

                                                        @@ -490,7 +490,7 @@

                                                        Return values:

                                                        ODB:read (id)
                                                        -object method.

                                                        Calls git_odb_read:

                                                        This method queries all available ODB backends trying to read the given OID.

                                                        The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.

                                                        @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database. +object method.

                                                        Calls git_odb_read:

                                                        This method queries all available ODB backends trying to read the given OID.

                                                        The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.

                                                        @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database.

                                                        Parameters

                                                        @@ -525,7 +525,7 @@

                                                        Return values:

                                                        ODB:read_header (id)
                                                        -object method.

                                                        Calls git_odb_read_header:

                                                        The header includes the length and the type of an object.

                                                        Note that most backends do not support reading only the header of an object, so the whole object will be read and then the header will be returned.

                                                        @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database. +object method.

                                                        Calls git_odb_read_header:

                                                        The header includes the length and the type of an object.

                                                        Note that most backends do not support reading only the header of an object, so the whole object will be read and then the header will be returned.

                                                        @return - 0 if the object was read; - GIT_ENOTFOUND if the object is not in the database.

                                                        Parameters

                                                        @@ -562,7 +562,7 @@

                                                        Return values:

                                                        ODB:read_prefix (short_id, len)
                                                        -object method.

                                                        Calls git_odb_read_prefix:

                                                        This method queries all available ODB backends trying to match the 'len' first hexadecimal characters of the 'short_id'. The remaining (GIT_OID_HEXSZ-len)*4 bits of 'short_id' must be 0s. 'len' must be at least GIT_OID_MINPREFIXLEN, and the prefix must be long enough to identify a unique object in all the backends; the method will fail otherwise.

                                                        The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use. +object method.

                                                        Calls git_odb_read_prefix:

                                                        This method queries all available ODB backends trying to match the 'len' first hexadecimal characters of the 'short_id'. The remaining (GIT_OID_HEXSZ-len)*4 bits of 'short_id' must be 0s. 'len' must be at least GIT_OID_MINPREFIXLEN, and the prefix must be long enough to identify a unique object in all the backends; the method will fail otherwise.

                                                        The returned object is reference counted and internally cached, so it should be closed by the user once it's no longer in use.

                                                        Parameters

                                                        @@ -601,7 +601,7 @@

                                                        Return values:

                                                        ODB:write (data, type)
                                                        -object method.

                                                        Calls git_odb_write:

                                                        This method writes a full object straight into the ODB. For most cases, it is preferred to write objects through a write stream, which is both faster and less memory intensive, specially for big objects.

                                                        This method is provided for compatibility with custom backends which are not able to support streaming writes +object method.

                                                        Calls git_odb_write:

                                                        This method writes a full object straight into the ODB. For most cases, it is preferred to write objects through a write stream, which is both faster and less memory intensive, specially for big objects.

                                                        This method is provided for compatibility with custom backends which are not able to support streaming writes

                                                        Parameters

                                                        diff --git a/modules/OID.html b/modules/OID.html index 4e86584..f7335b0 100644 --- a/modules/OID.html +++ b/modules/OID.html @@ -191,7 +191,7 @@

                                                        Functions

                                                        OID.hex (str)
                                                        -Create a new OID object.

                                                        Calls git_oid_fromstrn:

                                                        If N is odd, N-1 characters will be parsed instead. The remaining space in the git_oid will be set to zero. +Create a new OID object.

                                                        Calls git_oid_fromstrn:

                                                        If N is odd, N-1 characters will be parsed instead. The remaining space in the git_oid will be set to zero.

                                                        Parameters

                                                        @@ -226,7 +226,7 @@

                                                        Return values:

                                                        OID.raw (raw)
                                                        -Create a new OID object.

                                                        Calls git_oid_fromraw:

                                                        +Create a new OID object.

                                                        Calls git_oid_fromraw:

                                                        Parameters

                                                        @@ -295,7 +295,7 @@

                                                        Return value:

                                                        OID_mt:__eq (id)
                                                        -object meta method.

                                                        Calls git_oid_cmp:

                                                        +object meta method.

                                                        Calls git_oid_cmp:

                                                        Parameters

                                                        diff --git a/modules/OID_Shorten.html b/modules/OID_Shorten.html index 07467a7..c873b58 100644 --- a/modules/OID_Shorten.html +++ b/modules/OID_Shorten.html @@ -171,7 +171,7 @@

                                                        Functions

                                                        OID_Shorten.new (min_length)
                                                        -Create a new OID_Shorten object.

                                                        Calls git_oid_shorten_new:

                                                        The OID shortener is used to process a list of OIDs in text form and return the shortest length that would uniquely identify all of them.

                                                        E.g. look at the result of `git log --abbrev`. +Create a new OID_Shorten object.

                                                        Calls git_oid_shorten_new:

                                                        The OID shortener is used to process a list of OIDs in text form and return the shortest length that would uniquely identify all of them.

                                                        E.g. look at the result of `git log --abbrev`.

                                                        Parameters

                                                        @@ -200,7 +200,7 @@

                                                        Return value:

                                                        OID_Shorten:add (text_oid)
                                                        -object method.

                                                        Calls git_oid_shorten_add:

                                                        The OID is expected to be a 40-char hexadecimal string. The OID is owned by the user and will not be modified or freed.

                                                        For performance reasons, there is a hard-limit of how many OIDs can be added to a single set (around ~22000, assuming a mostly randomized distribution), which should be enough for any kind of program, and keeps the algorithm fast and memory-efficient.

                                                        Attempting to add more than those OIDs will result in a GIT_ENOMEM error +object method.

                                                        Calls git_oid_shorten_add:

                                                        The OID is expected to be a 40-char hexadecimal string. The OID is owned by the user and will not be modified or freed.

                                                        For performance reasons, there is a hard-limit of how many OIDs can be added to a single set (around ~22000, assuming a mostly randomized distribution), which should be enough for any kind of program, and keeps the algorithm fast and memory-efficient.

                                                        Attempting to add more than those OIDs will result in a GIT_ENOMEM error

                                                        Parameters

                                                        diff --git a/modules/Object.html b/modules/Object.html index 87ef26e..e113586 100644 --- a/modules/Object.html +++ b/modules/Object.html @@ -249,7 +249,7 @@

                                                        Return value:

                                                        Object:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -266,7 +266,7 @@

                                                        Return value:

                                                        Object:id ()
                                                        -object method.

                                                        Calls git_object_id:

                                                        +object method.

                                                        Calls git_object_id:

                                                        @@ -286,7 +286,7 @@

                                                        Return value:

                                                        Object:owner ()
                                                        -object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. +object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. @@ -306,7 +306,7 @@

                                                        Return value:

                                                        Object:type ()
                                                        -object method.

                                                        Calls git_object_type:

                                                        +object method.

                                                        Calls git_object_type:

                                                        diff --git a/modules/OdbObject.html b/modules/OdbObject.html index 971953a..194b693 100644 --- a/modules/OdbObject.html +++ b/modules/OdbObject.html @@ -186,7 +186,7 @@

                                                        Functions

                                                        OdbObject:data ()
                                                        -object method.

                                                        Calls git_odb_object_data:

                                                        This is the uncompressed, raw data as read from the ODB, without the leading header.

                                                        This pointer is owned by the object and shall not be free'd.

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the actual size of the object. +object method.

                                                        Calls git_odb_object_data:

                                                        This is the uncompressed, raw data as read from the ODB, without the leading header.

                                                        This pointer is owned by the object and shall not be free'd.

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the actual size of the object. @@ -206,7 +206,7 @@

                                                        Return value:

                                                        OdbObject:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_odb_object_free:

                                                        This method must always be called once a `git_odb_object` is no longer needed, otherwise memory will leak. +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_odb_object_free:

                                                        This method must always be called once a `git_odb_object` is no longer needed, otherwise memory will leak. @@ -223,7 +223,7 @@

                                                        Return value:

                                                        OdbObject:id ()
                                                        -object method.

                                                        Calls git_odb_object_id:

                                                        This is the OID from which the object was read from +object method.

                                                        Calls git_odb_object_id:

                                                        This is the OID from which the object was read from @@ -243,7 +243,7 @@

                                                        Return value:

                                                        OdbObject:size ()
                                                        -object method.

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the actual size of the object. +object method.

                                                        Calls git_odb_object_size:

                                                        This is the real size of the `data` buffer, not the actual size of the object. @@ -263,7 +263,7 @@

                                                        Return value:

                                                        OdbObject:type ()
                                                        -object method.

                                                        Calls git_odb_object_type:

                                                        +object method.

                                                        Calls git_odb_object_type:

                                                        diff --git a/modules/Reference.html b/modules/Reference.html index 9e9bfc7..38c94f2 100644 --- a/modules/Reference.html +++ b/modules/Reference.html @@ -143,7 +143,7 @@

                                                        Functions

                                                        Blob.frombuffer (repo, buffer)Blob.from_buffer (repo, buffer) module function.
                                                        Blob.fromfile (repo, path)Blob.from_disk (repo, path) module function.
                                                        Config:add_file_ondisk (path, priority)Config:add_file_ondisk (path, level, repo, force) object method.
                                                        Config:delete (name)Config:delete_entry (name)object method.
                                                        Config:delete_multivar (name, regexp) object method.
                                                        Index:add (path, stage)Index:add (source_entry) object method.
                                                        Index:add2 (source_entry)object method.
                                                        Index:append (path, stage)object method.
                                                        Index:append2 (source_entry)Index:add_bypath (path) object method.
                                                        Index:entrycount_unmerged ()Index:find (at_pos, path) object method.
                                                        Index:find (path)Index:get_byindex (n) object method.
                                                        Index:get (n)Index:get_bypath (path, stage) object method.
                                                        Index:get_unmerged_byindex (n)Index:read (force) object method.
                                                        Index:get_unmerged_bypath (path)Index:read_tree (tree) object method.
                                                        Index:read ()Index:remove (path, stage) object method.
                                                        Index:read_tree (tree)Index:reuc_entrycount () object method.
                                                        Index:remove (position)Index:reuc_get_byindex (n) object method.
                                                        Index:uniq ()Index:reuc_get_bypath (path) object method.
                                                        IndexEntry:ino ()IndexEntry:id () object method.
                                                        IndexEntry:mode ()IndexEntry:ino () object method.
                                                        IndexEntry:mtime ()IndexEntry:mode () object method.
                                                        IndexEntry:oid ()IndexEntry:mtime () object method.
                                                        - + @@ -152,11 +152,6 @@

                                                        Functions

                                                        - - - - - @@ -167,18 +162,13 @@

                                                        Functions

                                                        - - - - - - + @@ -188,12 +178,7 @@

                                                        Functions

                                                        - - - - - - + @@ -224,7 +209,7 @@

                                                        Functions

                                                        -
                                                        Reference.list (repo, list_flags)
                                                        +
                                                        Reference.list (repo)
                                                        module function. @@ -236,10 +221,6 @@

                                                        Parameters

                                                        repo: Must be of type Repository. -
                                                      7. - list_flags: Must be of type integer. -
                                                        8. - @@ -265,7 +246,7 @@

                                                        Return values:

                                                        Reference.lookup (repo, name)
                                                        -Create a new Reference object.

                                                        Calls git_reference_lookup:

                                                        The generated reference must be freed by the user. +Create a new Reference object.

                                                        Calls git_reference_lookup:

                                                        The generated reference must be freed by the user.

                                                        Parameters

                                                        @@ -302,44 +283,9 @@

                                                        Return values:

                                                        -
                                                        Reference.packall (repo)
                                                        -
                                                        -module function.

                                                        Calls git_reference_packall:

                                                        This method will load into the cache all the loose references on the repository and update the `packed-refs` file with them.

                                                        Once the `packed-refs` file has been written properly, the loose references will be removed from disk. - - -

                                                        Parameters

                                                        -
                                                          - -
                                                        • - repo: Repository where the loose refs will be packed. Must be of type Repository. -
                                                          • - -
                                                        - - - - - - -

                                                        Return values:

                                                        -
                                                          - -
                                                        1. true if no error. - -
                                                        2. Error string. - -
                                                        - - - -
                                                        - - - -
                                                        Reference:delete ()
                                                        -object method.

                                                        Calls git_reference_delete:

                                                        This method works for both direct and symbolic references.

                                                        The reference will be immediately removed on disk and from memory. The given reference pointer will no longer be valid. +object method.

                                                        Calls git_reference_delete:

                                                        This method works for both direct and symbolic references.

                                                        The reference will be immediately removed on disk and from memory. The given reference pointer will no longer be valid. @@ -365,7 +311,7 @@

                                                        Return values:

                                                        Reference:name ()
                                                        -object method.

                                                        Calls git_reference_name:

                                                        +object method.

                                                        Calls git_reference_name:

                                                        @@ -383,29 +329,9 @@

                                                        Return value:

                                                        -
                                                        Reference:oid ()
                                                        -
                                                        -object method.

                                                        Calls git_reference_oid:

                                                        Only available if the reference is direct (i.e. not symbolic) - - - - - - - -

                                                        Return value:

                                                        -OID. - - - -
                                                        - - - -
                                                        Reference:owner ()
                                                        -object method.

                                                        Calls git_reference_owner:

                                                        +object method.

                                                        Calls git_reference_owner:

                                                        @@ -423,9 +349,9 @@

                                                        Return value:

                                                        -
                                                        Reference:rename (new_name, force)
                                                        +
                                                        Reference:rename (new_name, force, log_message)
                                                        -object method.

                                                        Calls git_reference_rename:

                                                        This method works for both direct and symbolic references. The new name will be checked for validity and may be modified into a normalized form.

                                                        The given git_reference will be updated in place.

                                                        The reference will be immediately renamed in-memory and on disk.

                                                        If the `force` flag is not enabled, and there's already a reference with the given name, the renaming will fail.

                                                        IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists. +object method.

                                                        Calls git_reference_rename:

                                                        This method works for both direct and symbolic references. The new name will be checked for validity and may be modified into a normalized form.

                                                        The given git_reference will be updated in place.

                                                        The reference will be immediately renamed in-memory and on disk.

                                                        If the `force` flag is not enabled, and there's already a reference with the given name, the renaming will fail.

                                                        IMPORTANT: The user needs to write a proper reflog entry if the reflog is enabled for the repository. We only rename the reflog if it exists.

                                                        Parameters

                                                        @@ -436,7 +362,11 @@

                                                        Parameters

                                                      8. - force: Overwrite an existing reference. Must be of type boolean. + force: Overwrite an existing reference. Must be of type integer. +
                                                        9. + +
                                                      9. + log_message: Must be of type string.
                                                        10. @@ -449,7 +379,7 @@

                                                        Parameters

                                                        Return values:

                                                          -
                                                        1. true if no error. +
                                                        2. Reference or nil on error.
                                                        3. Error string. @@ -464,7 +394,7 @@

                                                          Return values:

                                                          Reference:resolve ()
                                                          -object method.

                                                          Calls git_reference_resolve:

                                                          Thie method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.

                                                          The peeled reference is returned in the `resolved_ref` argument, and must be freed manually once it's no longer needed.

                                                          If a direct reference is passed as an argument, a copy of that reference is returned. This copy must be manually freed too. +object method.

                                                          Calls git_reference_resolve:

                                                          Thie method iteratively peels a symbolic reference until it resolves to a direct reference to an OID.

                                                          The peeled reference is returned in the `resolved_ref` argument, and must be freed manually once it's no longer needed.

                                                          If a direct reference is passed as an argument, a copy of that reference is returned. This copy must be manually freed too. @@ -488,9 +418,9 @@

                                                          Return values:

                                                          -
                                                          Reference:set_oid (oid)
                                                          +
                                                          Reference:set_target (oid, log_message)
                                                          -object method.

                                                          Calls git_reference_set_oid:

                                                          The reference must be a direct reference, otherwise this method will fail.

                                                          The reference will be automatically updated in memory and on disk. +object method.

                                                          Calls git_reference_set_target:

                                                          The reference must be a symbolic reference, otherwise this method will fail.

                                                          The reference will be automatically updated in memory and on disk.

                                                          Parameters

                                                          @@ -500,39 +430,8 @@

                                                          Parameters

                                                          oid: Must be of type OID.
                                                          4. - - - - - - - -

                                                          Return values:

                                                          -
                                                            - -
                                                          1. true if no error. - -
                                                          2. Error string. - -
                                                          - - - -
                                                        - - - - -
                                                        Reference:set_target (target)
                                                        -
                                                        -object method.

                                                        Calls git_reference_set_target:

                                                        The reference must be a symbolic reference, otherwise this method will fail.

                                                        The reference will be automatically updated in memory and on disk. - - -

                                                        Parameters

                                                        -
                                                          -
                                                        • - target: The new target for the reference. Must be of type string. + log_message: Must be of type string.
                                                        @@ -545,7 +444,7 @@

                                                        Parameters

                                                        Return values:

                                                          -
                                                        1. true if no error. +
                                                        2. Reference or nil on error.
                                                        3. Error string. @@ -560,7 +459,7 @@

                                                          Return values:

                                                          Reference:target ()
                                                          -object method.

                                                          Calls git_reference_target:

                                                          Only available if the reference is symbolic +object method.

                                                          Calls git_reference_target:

                                                          Only available if the reference is symbolic @@ -569,7 +468,7 @@

                                                          Return values:

                                                          Return value:

                                                          -string. +OID. @@ -580,7 +479,7 @@

                                                          Return value:

                                                          Reference:type ()
                                                          -object method.

                                                          Calls git_reference_type:

                                                          Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) +object method.

                                                          Calls git_reference_type:

                                                          Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC) diff --git a/modules/Repository.html b/modules/Repository.html index eb4d77f..2a5fd7c 100644 --- a/modules/Repository.html +++ b/modules/Repository.html @@ -168,7 +168,7 @@

                                                          Functions

                                                        - + @@ -213,7 +213,7 @@

                                                        Functions

                                                        - + @@ -241,7 +241,7 @@

                                                        Functions

                                                        Repository.init (path, is_bare)
                                                        -Create a new Repository object.

                                                        Calls git_repository_init:

                                                        TODO: - Reinit the repository +Create a new Repository object.

                                                        Calls git_repository_init:

                                                        TODO: - Reinit the repository

                                                        Parameters

                                                        @@ -280,7 +280,7 @@

                                                        Return values:

                                                        Repository.open (path)
                                                        -Create a new Repository object.

                                                        Calls git_repository_open:

                                                        The 'path' argument must point to either a git repository folder, or an existing work dir.

                                                        The method will automatically detect if 'path' is a normal or bare repository or fail is 'path' is neither. +Create a new Repository object.

                                                        Calls git_repository_open:

                                                        The 'path' argument must point to either a git repository folder, or an existing work dir.

                                                        The method will automatically detect if 'path' is a normal or bare repository or fail is 'path' is neither.

                                                        Parameters

                                                        @@ -315,7 +315,7 @@

                                                        Return values:

                                                        Repository:config ()
                                                        -object method.

                                                        Calls git_repository_config:

                                                        If a configuration file has not been set, the default config set for the repository will be returned, including global and system configurations (if they are available).

                                                        The configuration file must be freed once it's no longer being used by the user. +object method.

                                                        Calls git_repository_config:

                                                        If a configuration file has not been set, the default config set for the repository will be returned, including global and system configurations (if they are available).

                                                        The configuration file must be freed once it's no longer being used by the user. @@ -341,7 +341,7 @@

                                                        Return values:

                                                        Repository:head ()
                                                        -object method.

                                                        Calls git_repository_head:

                                                        +object method.

                                                        Calls git_repository_head:

                                                        @@ -367,7 +367,7 @@

                                                        Return values:

                                                        Repository:head_detached ()
                                                        -object method.

                                                        Calls git_repository_head_detached:

                                                        A repository's HEAD is detached when it points directly to a commit instead of a branch. +object method.

                                                        Calls git_repository_head_detached:

                                                        A repository's HEAD is detached when it points directly to a commit instead of a branch. @@ -385,9 +385,9 @@

                                                        Return value:

                                                        -
                                                        Repository:head_orphan ()
                                                        +
                                                        Repository:head_unborn ()
                                                        -object method.

                                                        Calls git_repository_head_orphan:

                                                        An orphan branch is one named from HEAD but which doesn't exist in the refs namespace, because it doesn't have any commit to point to. +object method. @@ -407,7 +407,7 @@

                                                        Return value:

                                                        Repository:index ()
                                                        -object method.

                                                        Calls git_repository_index:

                                                        If a custom index has not been set, the default index for the repository will be returned (the one located in `.git/index`).

                                                        The index must be freed once it's no longer being used by the user. +object method.

                                                        Calls git_repository_index:

                                                        If a custom index has not been set, the default index for the repository will be returned (the one located in `.git/index`).

                                                        The index must be freed once it's no longer being used by the user. @@ -433,7 +433,7 @@

                                                        Return values:

                                                        Repository:is_bare ()
                                                        -object method.

                                                        Calls git_repository_is_bare:

                                                        +object method.

                                                        Calls git_repository_is_bare:

                                                        @@ -453,7 +453,7 @@

                                                        Return value:

                                                        Repository:is_empty ()
                                                        -object method.

                                                        Calls git_repository_is_empty:

                                                        An empty repository has just been initialized and contains no commits. +object method.

                                                        Calls git_repository_is_empty:

                                                        An empty repository has just been initialized and contains no commits. @@ -473,7 +473,7 @@

                                                        Return value:

                                                        Repository:odb ()
                                                        -object method.

                                                        Calls git_repository_odb:

                                                        If a custom ODB has not been set, the default database for the repository will be returned (the one located in `.git/objects`).

                                                        The ODB must be freed once it's no longer being used by the user. +object method.

                                                        Calls git_repository_odb:

                                                        If a custom ODB has not been set, the default database for the repository will be returned (the one located in `.git/objects`).

                                                        The ODB must be freed once it's no longer being used by the user. @@ -499,7 +499,7 @@

                                                        Return values:

                                                        Repository:path ()
                                                        -object method.

                                                        Calls git_repository_path:

                                                        This is the path of the `.git` folder for normal repositories, or of the repository itself for bare repositories. +object method.

                                                        Calls git_repository_path:

                                                        This is the path of the `.git` folder for normal repositories, or of the repository itself for bare repositories. @@ -519,7 +519,7 @@

                                                        Return value:

                                                        Repository:set_config (config)
                                                        -object method.

                                                        Calls git_repository_set_config:

                                                        This configuration file will be used for all configuration queries involving this repository.

                                                        The repository will keep a reference to the config file; the user must still free the config after setting it to the repository, or it will leak. +object method.

                                                        Calls git_repository_set_config:

                                                        This configuration file will be used for all configuration queries involving this repository.

                                                        The repository will keep a reference to the config file; the user must still free the config after setting it to the repository, or it will leak.

                                                        Parameters

                                                        @@ -545,7 +545,7 @@

                                                        Parameters

                                                        Repository:set_index (index)
                                                        -object method.

                                                        Calls git_repository_set_index:

                                                        This index will be used for all index-related operations involving this repository.

                                                        The repository will keep a reference to the index file; the user must still free the index after setting it to the repository, or it will leak. +object method.

                                                        Calls git_repository_set_index:

                                                        This index will be used for all index-related operations involving this repository.

                                                        The repository will keep a reference to the index file; the user must still free the index after setting it to the repository, or it will leak.

                                                        Parameters

                                                        @@ -571,7 +571,7 @@

                                                        Parameters

                                                        Repository:set_odb (odb)
                                                        -object method.

                                                        Calls git_repository_set_odb:

                                                        The ODB will be used for all object-related operations involving this repository.

                                                        The repository will keep a reference to the ODB; the user must still free the ODB object after setting it to the repository, or it will leak. +object method.

                                                        Calls git_repository_set_odb:

                                                        The ODB will be used for all object-related operations involving this repository.

                                                        The repository will keep a reference to the ODB; the user must still free the ODB object after setting it to the repository, or it will leak.

                                                        Parameters

                                                        @@ -595,9 +595,9 @@

                                                        Parameters

                                                        -
                                                        Repository:set_workdir (workdir)
                                                        +
                                                        Repository:set_workdir (workdir, update_gitlink)
                                                        -object method.

                                                        Calls git_repository_set_workdir:

                                                        The working directory doesn't need to be the same one that contains the `.git` folder for this repository.

                                                        If this repository is bare, setting its working directory will turn it into a normal repository, capable of performing all the common workdir operations (checkout, status, index manipulation, etc). +object method.

                                                        Calls git_repository_set_workdir:

                                                        The working directory doesn't need to be the same one that contains the `.git` folder for this repository.

                                                        If this repository is bare, setting its working directory will turn it into a normal repository, capable of performing all the common workdir operations (checkout, status, index manipulation, etc).

                                                        Parameters

                                                        @@ -607,6 +607,10 @@

                                                        Parameters

                                                        workdir: The path to a working directory. Must be of type string. +
                                                      10. + update_gitlink: Must be of type integer. +
                                                        11. + @@ -632,7 +636,7 @@

                                                        Return values:

                                                        Repository:workdir ()
                                                        -object method.

                                                        Calls git_repository_workdir:

                                                        If the repository is bare, this function will always return NULL. +object method.

                                                        Calls git_repository_workdir:

                                                        If the repository is bare, this function will always return NULL. diff --git a/modules/RevWalk.html b/modules/RevWalk.html index 6e99863..1a3d189 100644 --- a/modules/RevWalk.html +++ b/modules/RevWalk.html @@ -201,7 +201,7 @@

                                                        Functions

                                                        RevWalk.new (repo)
                                                        -Create a new RevWalk object.

                                                        Calls git_revwalk_new:

                                                        This revision walker uses a custom memory pool and an internal commit cache, so it is relatively expensive to allocate.

                                                        For maximum performance, this revision walker should be reused for different walks.

                                                        This revision walker is *not* thread safe: it may only be used to walk a repository on a single thread; however, it is possible to have several revision walkers in several different threads walking the same repository. +Create a new RevWalk object.

                                                        Calls git_revwalk_new:

                                                        This revision walker uses a custom memory pool and an internal commit cache, so it is relatively expensive to allocate.

                                                        For maximum performance, this revision walker should be reused for different walks.

                                                        This revision walker is *not* thread safe: it may only be used to walk a repository on a single thread; however, it is possible to have several revision walkers in several different threads walking the same repository.

                                                        Parameters

                                                        @@ -236,7 +236,7 @@

                                                        Return values:

                                                        RevWalk:close ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_revwalk_free:

                                                        +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_revwalk_free:

                                                        @@ -253,7 +253,7 @@

                                                        Return values:

                                                        RevWalk:hide (id)
                                                        -object method.

                                                        Calls git_revwalk_hide:

                                                        The given OID must belong to a commit on the walked repository.

                                                        The resolved commit and all its parents will be hidden from the output on the revision walk. +object method.

                                                        Calls git_revwalk_hide:

                                                        The given OID must belong to a commit on the walked repository.

                                                        The resolved commit and all its parents will be hidden from the output on the revision walk.

                                                        Parameters

                                                        @@ -288,7 +288,7 @@

                                                        Return values:

                                                        RevWalk:next ()
                                                        -object method.

                                                        Calls git_revwalk_next:

                                                        The initial call to this method is *not* blocking when iterating through a repo with a time-sorting mode.

                                                        Iterating with Topological or inverted modes makes the initial call blocking to preprocess the commit list, but this block should be mostly unnoticeable on most repositories (topological preprocessing times at 0.3s on the git.git repo).

                                                        The revision walker is reset when the walk is over. +object method.

                                                        Calls git_revwalk_next:

                                                        The initial call to this method is *not* blocking when iterating through a repo with a time-sorting mode.

                                                        Iterating with Topological or inverted modes makes the initial call blocking to preprocess the commit list, but this block should be mostly unnoticeable on most repositories (topological preprocessing times at 0.3s on the git.git repo).

                                                        The revision walker is reset when the walk is over. @@ -314,7 +314,7 @@

                                                        Return values:

                                                        RevWalk:push (id)
                                                        -object method.

                                                        Calls git_revwalk_push:

                                                        The given OID must belong to a commit on the walked repository.

                                                        The given commit will be used as one of the roots when starting the revision walk. At least one commit must be pushed the repository before a walk can be started. +object method.

                                                        Calls git_revwalk_push:

                                                        The given OID must belong to a commit on the walked repository.

                                                        The given commit will be used as one of the roots when starting the revision walk. At least one commit must be pushed the repository before a walk can be started.

                                                        Parameters

                                                        @@ -349,7 +349,7 @@

                                                        Return values:

                                                        RevWalk:repository ()
                                                        -object method.

                                                        Calls git_revwalk_repository:

                                                        +object method.

                                                        Calls git_revwalk_repository:

                                                        @@ -369,7 +369,7 @@

                                                        Return value:

                                                        RevWalk:reset ()
                                                        -object method.

                                                        Calls git_revwalk_reset:

                                                        This will clear all the pushed and hidden commits, and leave the walker in a blank state (just like at creation) ready to receive new commit pushes and start a new walk.

                                                        The revision walk is automatically reset when a walk is over. +object method.

                                                        Calls git_revwalk_reset:

                                                        This will clear all the pushed and hidden commits, and leave the walker in a blank state (just like at creation) ready to receive new commit pushes and start a new walk.

                                                        The revision walk is automatically reset when a walk is over. @@ -386,7 +386,7 @@

                                                        Return value:

                                                        RevWalk:sorting (sort_mode)
                                                        -object method.

                                                        Calls git_revwalk_sorting:

                                                        Changing the sorting mode resets the walker. +object method.

                                                        Calls git_revwalk_sorting:

                                                        Changing the sorting mode resets the walker.

                                                        Parameters

                                                        diff --git a/modules/Signature.html b/modules/Signature.html index 66eca21..24786e0 100644 --- a/modules/Signature.html +++ b/modules/Signature.html @@ -186,7 +186,7 @@

                                                        Functions

                                                        Signature.new (name, email, time, offset)
                                                        -Create a new Signature object.

                                                        Calls git_signature_new:

                                                        +Create a new Signature object.

                                                        Calls git_signature_new:

                                                        Parameters

                                                        @@ -233,7 +233,7 @@

                                                        Return values:

                                                        Signature.now (name, email)
                                                        -Create a new Signature object.

                                                        Calls git_signature_now:

                                                        +Create a new Signature object.

                                                        Calls git_signature_now:

                                                        Parameters

                                                        diff --git a/modules/Tag.html b/modules/Tag.html index 7bc7d6a..c1f051c 100644 --- a/modules/Tag.html +++ b/modules/Tag.html @@ -206,7 +206,7 @@

                                                        Functions

                                                        Object:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -223,7 +223,7 @@

                                                        Functions

                                                        Object:id ()
                                                        -object method.

                                                        Calls git_object_id:

                                                        +object method.

                                                        Calls git_object_id:

                                                        @@ -243,7 +243,7 @@

                                                        Return value:

                                                        Object:owner ()
                                                        -object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. +object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. @@ -263,7 +263,7 @@

                                                        Return value:

                                                        Object:type ()
                                                        -object method.

                                                        Calls git_object_type:

                                                        +object method.

                                                        Calls git_object_type:

                                                        @@ -283,7 +283,7 @@

                                                        Return value:

                                                        Tag.lookup (repo, id)
                                                        -Create a new Tag object.

                                                        Calls git_tag_lookup:

                                                        +Create a new Tag object.

                                                        Calls git_tag_lookup:

                                                        Parameters

                                                        @@ -322,7 +322,7 @@

                                                        Return values:

                                                        Tag:message ()
                                                        -object method.

                                                        Calls git_tag_message:

                                                        +object method.

                                                        Calls git_tag_message:

                                                        @@ -342,7 +342,7 @@

                                                        Return value:

                                                        Tag:name ()
                                                        -object method.

                                                        Calls git_tag_name:

                                                        +object method.

                                                        Calls git_tag_name:

                                                        @@ -362,7 +362,7 @@

                                                        Return value:

                                                        Tag:tagger ()
                                                        -object method.

                                                        Calls git_tag_tagger:

                                                        +object method.

                                                        Calls git_tag_tagger:

                                                        @@ -382,7 +382,7 @@

                                                        Return value:

                                                        Tag:target ()
                                                        -object method.

                                                        Calls git_tag_target:

                                                        This method performs a repository lookup for the given object and returns it +object method.

                                                        Calls git_tag_target:

                                                        This method performs a repository lookup for the given object and returns it diff --git a/modules/Tree.html b/modules/Tree.html index d7b8481..f63d894 100644 --- a/modules/Tree.html +++ b/modules/Tree.html @@ -201,7 +201,7 @@

                                                        Functions

                                                        Object:free ()
                                                        -Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. +Destroy this object (will be called by Garbage Collector).

                                                        Calls git_object_free:

                                                        This method instructs the library to close an existing object; note that git_objects are owned and cached by the repository so the object may or may not be freed after this library call, depending on how agressive is the caching mechanism used by the repository.

                                                        IMPORTANT: It *is* necessary to call this method when you stop using an object. Failure to do so will cause a memory leak. @@ -218,7 +218,7 @@

                                                        Functions

                                                        Object:id ()
                                                        -object method.

                                                        Calls git_object_id:

                                                        +object method.

                                                        Calls git_object_id:

                                                        @@ -238,7 +238,7 @@

                                                        Return value:

                                                        Object:owner ()
                                                        -object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. +object method.

                                                        Calls git_object_owner:

                                                        Freeing or calling `git_repository_close` on the returned pointer will invalidate the actual object.

                                                        Any other operation may be run on the repository without affecting the object. @@ -258,7 +258,7 @@

                                                        Return value:

                                                        Object:type ()
                                                        -object method.

                                                        Calls git_object_type:

                                                        +object method.

                                                        Calls git_object_type:

                                                        @@ -278,7 +278,7 @@

                                                        Return value:

                                                        Tree.lookup (repo, id)
                                                        -Create a new Tree object.

                                                        Calls git_tree_lookup:

                                                        +Create a new Tree object.

                                                        Calls git_tree_lookup:

                                                        Parameters

                                                        @@ -317,7 +317,7 @@

                                                        Return values:

                                                        Tree:entry_byindex (index)
                                                        -object method.

                                                        Calls git_tree_entry_byindex:

                                                        +object method.

                                                        Calls git_tree_entry_byindex:

                                                        Parameters

                                                        @@ -346,7 +346,7 @@

                                                        Return value:

                                                        Tree:entry_byname (filename)
                                                        -object method.

                                                        Calls git_tree_entry_byname:

                                                        +object method.

                                                        Calls git_tree_entry_byname:

                                                        Parameters

                                                        @@ -375,7 +375,7 @@

                                                        Return value:

                                                        Tree:entrycount ()
                                                        -object method.

                                                        Calls git_tree_entrycount:

                                                        +object method.

                                                        Calls git_tree_entrycount:

                                                        diff --git a/modules/TreeEntry.html b/modules/TreeEntry.html index 2033128..2e04fed 100644 --- a/modules/TreeEntry.html +++ b/modules/TreeEntry.html @@ -143,7 +143,7 @@

                                                        Functions

                                                        Reference.list (repo, list_flags)Reference.list (repo) module function.
                                                        Create a new Reference object.
                                                        Reference.packall (repo)module function.
                                                        Reference:delete () object method. object method.
                                                        Reference:oid ()object method.
                                                        Reference:owner () object method.
                                                        Reference:rename (new_name, force)Reference:rename (new_name, force, log_message) object method.
                                                        Reference:set_oid (oid)object method.
                                                        Reference:set_target (target)Reference:set_target (oid, log_message) object method.
                                                        Repository:head_orphan ()Repository:head_unborn () object method.
                                                        Repository:set_workdir (workdir)Repository:set_workdir (workdir, update_gitlink) object method.
                                                        - + @@ -179,9 +179,9 @@

                                                        Functions

                                                        -
                                                        TreeEntry:attributes ()
                                                        +
                                                        TreeEntry:filemode ()
                                                        -object method.

                                                        Calls git_tree_entry_attributes:

                                                        +object method. @@ -221,7 +221,7 @@

                                                        Return value:

                                                        TreeEntry:name ()
                                                        -object method.

                                                        Calls git_tree_entry_name:

                                                        +object method.

                                                        Calls git_tree_entry_name:

                                                        diff --git a/modules/git2.html b/modules/git2.html index 9a44134..df44e18 100644 --- a/modules/git2.html +++ b/modules/git2.html @@ -133,7 +133,7 @@

                                                        Modules

                                                        Module git2

                                                        -

                                                        Module git2. See libgit2 API docs.
                                                        Class StrArray
                                                        Class Repository
                                                        Class Config
                                                        Class OdbObject
                                                        Class OID
                                                        Class OID_Shorten
                                                        Class ODB
                                                        Class ODBBackend
                                                        Class Index
                                                        Class IndexEntry
                                                        Class IndexEntryUnmerged
                                                        Class Object
                                                        Class Blob
                                                        Class Signature
                                                        Class Commit
                                                        Class Tree
                                                        Class TreeEntry
                                                        Class Tag
                                                        Class RevWalk
                                                        Class Reference

                                                        +

                                                        Module git2. See libgit2 API docs.
                                                        Class StrArray
                                                        Class Repository
                                                        Class Config
                                                        Class OdbObject
                                                        Class OID
                                                        Class OID_Shorten
                                                        Class ODB
                                                        Class ODBBackend
                                                        Class Index
                                                        Class IndexEntry
                                                        Class IndexEntryUnmerged
                                                        Class Object
                                                        Class Blob
                                                        Class Signature
                                                        Class Commit
                                                        Class Tree
                                                        Class TreeEntry
                                                        Class Tag
                                                        Class RevWalk
                                                        Class Reference

                                                        TreeEntry:attributes ()TreeEntry:filemode () object method.