6. Checkout¶
These methods help doing a git checkout
to either a repository’s HEAD
or Index or Tree.
6.1. checkout_init_options¶
parameters | Returns |
---|---|
None | luagit2_checkout_options |
- Creates a
luagit2_checkout_options
to be used in other functions or gives an error. - libgit2 equivalent : https://libgit2.org/libgit2/#v0.27.0/group/checkout/git_checkout_init_options
6.2. checkout_head¶
parameters | Returns |
---|---|
luagit2_repository | None |
luagit2_checkout_options |
luagit2_repository
: The repository in which checkout is to be performed.luagit2_checkout_options
: The checkout options to be used while checkout is performed.
- returns none or an error.
- libgit2 equivalent : https://libgit2.org/libgit2/#v0.27.0/group/checkout/git_checkout_head
6.3. checkout_index¶
parameters | Returns |
---|---|
luagit2_repository | None |
luagit2_index | |
luagit2_checkout_options |
luagit2_repository
: The repository in which checkout is to be performed.luagit2_index
: The index to which checkout is to be performed.luagit2_checkout_options
: The checkout options to be used while checkout is performed.
- returns none or an error.
- libgit2 equivalent : https://libgit2.org/libgit2/#v0.27.0/group/checkout/git_checkout_index
6.4. checkout_tree¶
parameters | Returns |
---|---|
luagit2_repository | None |
luagit2_tree | |
luagit2_checkout_options |
luagit2_repository
: The repository in which checkout is to be performed.luagit2_tree
: The tree to which checkout is to be performed.luagit2_checkout_options
: The checkout options to be used while checkout is performed.
- returns none or an error.
- libgit2 equivalent : https://libgit2.org/libgit2/#v0.27.0/group/checkout/git_checkout_tree