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.
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: the path to the index file in disk. Must be of type
string.
Return values:
- Index or
nilon error. - Error string.
-
index_path: the path to the index file in disk. Must be of type
- Index:add (path, stage)
-
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:
trueif no error.- Error string.
-
path: filename to add. Must be of type
- Index:add2 (source_entry)
-
object method.
Parameters
- source_entry: Must be of type IndexEntry.
Return values:
trueif no error.- Error string.
- 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:
trueif no error.- Error string.
-
path: filename to add. Must be of type
- Index:append2 (source_entry)
-
object method.
Parameters
- source_entry: Must be of type IndexEntry.
Return values:
trueif no error.- Error string.
- Index:clear ()
-
object method.
Calls git_index_clear:
- Index:entrycount ()
-
object method.
Calls git_index_entrycount:
Return value:
integer. - Index:entrycount_unmerged ()
-
object method.
Calls git_index_entrycount_unmerged:
Return value:
integer. - Index:find (path)
-
object method.
Calls git_index_find:
Parameters
-
path: path to search. Must be of type
string.
Return value:
integer. -
path: path to search. Must be of type
- Index:get (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.
Parameters
-
n: the position of the entry. Must be of type
integer.
Return value:
IndexEntry. -
n: the position of the entry. Must be of type
- Index:get_unmerged_byindex (n)
-
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: the position of the entry. Must be of type
integer.
Return value:
IndexEntryUnmerged. -
n: the position of the entry. Must be of type
- Index:get_unmerged_bypath (path)
-
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: path to search. Must be of type
string.
Return value:
IndexEntryUnmerged. -
path: path to search. Must be of type
- Index:read ()
-
object method.
Calls git_index_read:
Return values:
trueif no error.- Error string.
- Index:read_tree (tree)
-
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.
Return values:
trueif no error.- Error string.
- Index:remove (position)
-
object method.
Calls git_index_remove:
Parameters
-
position: position of the entry to remove. Must be of type
integer.
Return values:
trueif no error.- Error string.
-
position: position of the entry to remove. Must be of type
- Index:uniq ()
-
object method.
Calls git_index_uniq:
- Index:write ()
-
object method.
Calls git_index_write:
Return values:
trueif no error.- Error string.