Did you know ... | Search Documentation: |
![]() | Pack logtalk -- logtalk-3.81.0/docs/_sources/git_protocol_0.rst.txt |
.. index:: git_protocol .. _git_protocol/0:
.. rst-class:: right
protocol
git_protocol
Predicates for accessing a git project current branch and latest commit data.
| Availability:
| logtalk_load(git(loader))
| Author: Paulo Moura | Version: 1:1:0 | Date: 2022-01-21
| Compilation flags:
| static
| Dependencies: | (none)
| Remarks: | (none)
| Inherited public predicates: | (none)
.. contents:: :local: :backlinks: top
.. index:: branch/2 .. _git_protocol/0::branch/2:
branch/2 ^^^^^^^^^^^^
Returns the name of the current git branch. Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| branch(Directory,Branch)
| Mode and number of proofs:
| branch(+atom,?atom)
- zero_or_one
.. index:: commit_author/2 .. _git_protocol/0::commit_author/2:
commit_author/2 ^^^^^^^^^^^^^^^^^^^
Returns the latest commit author. Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| commit_author(Directory,Author)
| Mode and number of proofs:
| commit_author(+atom,-atom)
- zero_or_one
.. index:: commit_date/2 .. _git_protocol/0::commit_date/2:
commit_date/2 ^^^^^^^^^^^^^^^^^
Returns the latest commit date (strict ISO 8601 format). Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| commit_date(Directory,Date)
| Mode and number of proofs:
| commit_date(+atom,-atom)
- zero_or_one
.. index:: commit_hash/2 .. _git_protocol/0::commit_hash/2:
commit_hash/2 ^^^^^^^^^^^^^^^^^
Returns the latest commit hash. Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| commit_hash(Directory,Hash)
| Mode and number of proofs:
| commit_hash(+atom,-atom)
- zero_or_one
.. index:: commit_hash_abbreviated/2 .. _git_protocol/0::commit_hash_abbreviated/2:
commit_hash_abbreviated/2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the latest commit abbreviated hash. Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| commit_hash_abbreviated(Directory,Hash)
| Mode and number of proofs:
| commit_hash_abbreviated(+atom,-atom)
- zero_or_one
.. index:: commit_message/2 .. _git_protocol/0::commit_message/2:
commit_message/2 ^^^^^^^^^^^^^^^^^^^^
Returns the latest commit message. Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| commit_message(Directory,Message)
| Mode and number of proofs:
| commit_message(+atom,-atom)
- zero_or_one
.. index:: commit_log/3 .. _git_protocol/0::commit_log/3:
commit_log/3 ^^^^^^^^^^^^^^^^
Returns the git latest commit log output for the given format (see e.g. https://git-scm.com/docs/pretty-formats). Fails if the directory is not a git repo or a sub-directory of a git repo directory.
| Compilation flags:
| static
| Template:
| commit_log(Directory,Format,Output)
| Mode and number of proofs:
| commit_log(+atom,+atom,-atom)
- zero_or_one
(none)
(none)
(none)