LibGit2

LibGit2 モジュールは、libgit2(Git バージョン管理システムの中核機能を実装する、移植性の高い C ライブラリ)へのバインディングを提供します。これらのバインディングは現在、Julia のパッケージマネージャーを支えるために使われています。将来的には、このモジュールは独立したパッケージに移される予定です。

Functionality

このドキュメントの一部では、libgit2 API に関する予備知識があることを前提としています。ここで言及しているオブジェクトやメソッドについて詳しくは、上流の libgit2 API reference を参照してください。

LibGit2.Buffer — Type
LibGit2.Buffer

libgit2 からデータをエクスポートするためのデータバッファです。git_buf 構造体に対応します。

LibGit2 からデータを取得する際の一般的な使用例は、次のとおりです。

buf_ref = Ref(Buffer())
@check ccall(..., (Ptr{Buffer},), buf_ref)
# operation on buf_ref
free(buf_ref)

特に、Ref オブジェクトに対して、その後 LibGit2.free を呼び出す必要がある点に注意してください。

source
LibGit2.CheckoutOptions — Type
LibGit2.CheckoutOptions

git_checkout_options 構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では常に 1 です。
  • checkout_strategy: 競合の処理方法と、チェックアウトを強制するか、欠落ファイルを再作成するかを指定します。
  • disable_filters: 0 以外の場合、CLRF(ファイルの改行コードを UNIX と DOS の間で変換するフィルターなど)を適用しません。
  • dir_mode: チェックアウトに関係するディレクトリの読み取り/書き込み/アクセスモード。デフォルトは 0755 です。
  • file_mode: チェックアウトに関係するファイルの読み取り/書き込み/アクセスモード。デフォルトは、blob に応じて 0755 または 0644 です。
  • file_open_flags: チェックアウト中にファイルを開く際に使用するビットフラグ。
  • notify_flags: ユーザーに通知する競合の種類を指定するフラグ。
  • notify_cb: チェックアウトで競合が発生した場合にユーザーへ通知する、任意のコールバック関数。この関数が 0 以外の値を返すと、チェックアウトはキャンセルされます。
  • notify_payload: 通知コールバック関数に渡すペイロード。
  • progress_cb: チェックアウトの進行状況を表示する、任意のコールバック関数。
  • progress_payload: 進行状況コールバックに渡すペイロード。
  • paths: 空でない場合、チェックアウト中に検索するパスを指定します。空の場合、リポジトリ内のすべてのファイルがチェックアウト対象になります。
  • baseline: workdir の想定内容。GitTree へのポインター(またはそのポインター)に格納されます。デフォルトは HEAD におけるツリーの状態です。
  • baseline_index: workdir の想定内容。GitIndex へのポインター(またはそのポインター)に格納されます。デフォルトは HEAD におけるインデックスの状態です。
  • target_directory: 空でない場合、workdir ではなく、このディレクトリにチェックアウトします。
  • ancestor_label: 競合が発生した場合、共通祖先側の名前。
  • our_label: 競合が発生した場合、「ours」側の名前。
  • their_label: 競合が発生した場合、「theirs」側の名前。
  • perfdata_cb: パフォーマンスデータを表示する、任意のコールバック関数。
  • perfdata_payload: パフォーマンスコールバックに渡すペイロード。
source
LibGit2.CloneOptions — Type
LibGit2.CloneOptions

git_clone_options 構造体に一致します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では常に 1 です。
  • checkout_opts: クローンの一環としてリモートをチェックアウトする際のオプション。
  • fetch_opts: クローンの一環として、チェックアウト前にリモートをフェッチする際のオプション。
  • bare: 0 の場合、リモートリポジトリ全体をクローンします。ゼロ以外の場合はベアクローンを実行します。ベアクローンでは、リポジトリ内にソースファイルのローカルコピーがなく、gitdir と workdir は同じになります。
  • localclone: ローカルのオブジェクトデータベースをクローンするか、フェッチを行うかを指定するフラグ。デフォルトでは git に判断を任せます。ローカルクローンでは git 対応のトランスポートを使用しませんが、file:// で始まる URL では使用します。
  • checkout_branch: チェックアウトするブランチ名。空文字列の場合、リモートのデフォルトブランチをチェックアウトします。
  • repository_cb: クローン先となる 新しい リポジトリを作成するために使用する、任意のコールバック。
  • repository_cb_payload: リポジトリコールバックに渡すペイロード。
  • remote_cb: クローン元となる GitRemote を作成するために、クローンの実行前に使用する任意のコールバック。
  • remote_cb_payload: リモートコールバックに渡すペイロード。
source
LibGit2.DescribeOptions — Type
LibGit2.DescribeOptions

git_describe_options 構造体に一致します。

各フィールドの意味は次のとおりです。

  • version: 後で構造体のバージョンが変更された場合に備えて、使用中の構造体のバージョンを示します。現時点では、常に 1 です。
  • max_candidates_tags: コミットを説明するタグを探すため、refs/tags 内の最新のタグをこの数だけ調べます。デフォルトは 10 です(つまり、コミットを説明するタグがあるかどうかを確認するため、最新の 10 個のタグを調べます)。
  • describe_strategy: refs/tags(git-describe --tags と同等)のすべてのエントリを対象にするか、refs/(git-describe --all と同等)のすべてのエントリを対象にするかを指定します。デフォルトでは、注釈付きタグのみが表示されます。Consts.DESCRIBE_TAGS を渡すと、注釈付きかどうかを問わず、すべてのタグが対象になります。Consts.DESCRIBE_ALL を渡すと、refs/ 内のすべての参照が対象になります。
  • pattern: pattern に一致するタグのみを対象にします。glob 展開に対応しています。
  • only_follow_first_parent: 一致する参照から説明対象のオブジェクトまでの距離を求める際、最初の親からの距離のみを対象にします。
  • show_commit_oid_as_fallback: コミットを説明する一致する参照が見つからない場合、エラーをスローせず、コミットの GitHash を表示します(これがデフォルトの動作です)。
source
LibGit2.DescribeFormatOptions — Type
LibGit2.DescribeFormatOptions

git_describe_format_options 構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では、常に 1 です。
  • abbreviated_size: 省略形の GitHash のサイズの下限。既定値は 7 です。
  • always_use_long_format: 1 に設定すると、短い形式を使用できる場合でも、文字列に長い形式を使用します。
  • dirty_suffix: 設定されている場合、workdir が dirty のとき、説明文字列の末尾に追加されます。
source
LibGit2.DiffDelta — Type
LibGit2.DiffDelta

1つのエントリに対する変更の説明。git_diff_delta 構造体に対応します。

各フィールドの意味は次のとおりです。

  • status: ファイルが追加・変更・削除されたかを示す、Consts.DELTA_STATUS のいずれか。
  • flags: 差分と両側のオブジェクトに関するフラグ。ファイルをバイナリとして扱うかテキストとして扱うか、差分の各側にファイルが存在するか、オブジェクト ID が正しいと確認されているかを判定します。
  • similarity: ファイルの名前が変更されたか、コピーされたかを示します。
  • nfiles: 差分に含まれるファイル数(たとえば、サブモジュールのコミット ID に対して差分を実行した場合、複数のファイルが含まれることがあります)。
  • old_file: 変更前のファイルに関する情報を含む DiffFile。
  • new_file: 変更後のファイルに関する情報を含む DiffFile。
source
LibGit2.DiffFile — Type
LibGit2.DiffFile

デルタの片側の説明です。git_diff_file 構造体に対応します。

各フィールドの意味は次のとおりです。

  • id: diff 内の項目の GitHash です。diff のこの側で項目が空の場合(たとえば、ファイルの削除を表す diff の場合)、値は GitHash(0) になります。
  • path: リポジトリの作業ディレクトリを基準とした、項目への NULL 終端のパスです。
  • size: 項目のサイズ(バイト単位)です。
  • flags: git_diff_flag_t フラグを組み合わせた値です。この整数の i ビット目が、i フラグ目を設定します。
  • mode: 項目の stat モードです。
  • id_abbrev: LibGit2 のバージョンが 0.25.0 以上の場合にのみ存在します。string を使って変換したときの id フィールドの長さです。通常は OID_HEXSZ(40)と同じです。
source
LibGit2.DiffOptionsStruct — Type
LibGit2.DiffOptionsStruct

git_diff_options 構造体に一致します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えて指定する、使用中の構造体のバージョン。現時点では、常に 1 です。
  • flags: diff に表示するファイルを制御するフラグ。デフォルトは DIFF_NORMAL です。
  • ignore_submodules: サブモジュール内のファイルを調べるかどうか。デフォルトは SUBMODULE_IGNORE_UNSPECIFIED です。この場合、サブモジュールの設定によって diff に表示するかどうかが決まります。
  • pathspec: diff に含めるファイルのパス。デフォルトでは、リポジトリ内のすべてのファイルが対象になります。
  • notify_cb: ファイル差分が追加されるたびに、diff の変更をユーザーに通知する任意のコールバック。
  • progress_cb: diff の進行状況を表示する任意のコールバック。libgit2 のバージョンが 0.24.0 以降の場合にのみ有効です。
  • payload: notify_cb および progress_cb に渡すペイロード。
  • context_lines: ハンクの境界を定義するために使用する、変更されていない行数。ハンクの前後にコンテキストとして表示される行数もこれと同じです。デフォルトは 3 です。
  • interhunk_lines: 別々のハンク間に許容される、変更されていない行の最大数。この数を超えると、ハンクは結合されます。デフォルトは 0 です。
  • id_abbrev: 表示する GitHash の省略形の長さを設定します。デフォルトは 7 です。
  • max_size: blob の最大ファイルサイズ。このサイズを超えると、バイナリ blob として扱われます。デフォルトは 512 MB です。
  • old_prefix: diff の片側で古いファイルを配置する仮想ファイルディレクトリ。デフォルトは "a" です。
  • new_prefix: diff の片側で新しいファイルを配置する仮想ファイルディレクトリ。デフォルトは "b" です。
source
LibGit2.FetchHead — Type
LibGit2.FetchHead

フェッチ時の HEAD に関する情報を保持します。フェッチ元のブランチ名と URL、HEAD の oid、およびフェッチした HEAD がローカルにマージ済みかどうかが含まれます。

各フィールドの内容は次のとおりです。

  • name: フェッチヘッドのローカル参照データベース上の名前。たとえば、"refs/heads/master"。
  • url: フェッチヘッドの URL。
  • oid: フェッチヘッドの先端の GitHash。
  • ismerge: リモートの変更がローカルコピーにまだマージされていないかどうかを示すブール値フラグ。true の場合、ローカルコピーはリモートのフェッチヘッドと同期しています。
source
LibGit2.FetchOptions — Type
LibGit2.FetchOptions

git_fetch_options構造体に一致します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では、常に1です。
  • callbacks: フェッチ中に使用するリモートコールバック。
  • prune: フェッチ後にプルーンを実行するかどうか。デフォルトでは、GitConfigの設定が使われます。
  • update_fetchhead: フェッチ後にFetchHeadを更新するかどうか。デフォルトでは更新が実行されます。これは通常のgitの動作です。
  • download_tags: リモートにあるタグをダウンロードするかどうか。デフォルトでは、サーバーからダウンロードするオブジェクトに付いているタグを要求します。
  • proxy_opts: プロキシ経由でリモートに接続するためのオプション。ProxyOptionsを参照してください。libgit2のバージョンが0.25.0以上の場合にのみ存在します。
  • custom_headers: フェッチに必要な追加ヘッダー。libgit2のバージョンが0.24.0以上の場合にのみ存在します。
source
LibGit2.GitAnnotated — Type
GitAnnotated(repo::GitRepo, commit_id::GitHash)
GitAnnotated(repo::GitRepo, ref::GitReference)
GitAnnotated(repo::GitRepo, fh::FetchHead)
GitAnnotated(repo::GitRepo, committish::AbstractString)

注釈付きの git コミットには、そのコミットがどのように検索され、なぜ選ばれたのかという情報が含まれます。そのため、rebase や merge の操作で、コミットのコンテキストをより詳しく把握できます。たとえば、競合しているマージのソースブランチとターゲットブランチに関する情報が、競合ファイルに含まれます。注釈付きコミットは、たとえば FetchHead が渡された場合のリモートブランチの先端や、GitReference を使って記述されたブランチヘッドを参照できます。

source
LibGit2.GitBlame — Type
GitBlame(repo::GitRepo, path::AbstractString; options::BlameOptions=BlameOptions())

path の履歴から得られる変更情報を使って、ファイル repo 用の GitBlame オブジェクトを構築します。GitBlame オブジェクトには、誰が、いつ、どのようにファイルのどの部分を変更したかが記録されます。options は、ファイルの内容をどのように分割するか、および調査対象とするコミットを制御します。詳しくは BlameOptions を参照してください。

source
LibGit2.GitBlob — Type
GitBlob(repo::GitRepo, hash::AbstractGitHash)
GitBlob(repo::GitRepo, spec::AbstractString)

hash/specで指定されたrepoから、GitBlobオブジェクトを返します。

  • hashは、完全な(GitHash)ハッシュ、または部分的な(GitShortHash)ハッシュです。
  • specはテキスト形式の仕様です。全項目についてはthe git docsを参照してください。
source
LibGit2.GitCommit — Type
GitCommit(repo::GitRepo, hash::AbstractGitHash)
GitCommit(repo::GitRepo, spec::AbstractString)

repoで指定されたhash/specから、GitCommitオブジェクトを返します。

  • hashは、完全な(GitHash)ハッシュ、または部分的な(GitShortHash)ハッシュです。
  • specはテキスト形式の仕様です。全項目についてはthe git docsを参照してください。
source
LibGit2.GitConfig — Type
GitConfig(path::AbstractString, level::Consts.GIT_CONFIG=Consts.CONFIG_LEVEL_APP, force::Bool=false)

path のファイルから設定情報を読み込んで、新しい GitConfig を作成します。level、repo、force の各オプションの詳細については、addfile を参照してください。

source
GitConfig(repo::GitRepo)

repo の Git リポジトリに保存されている設定を取得します。repo に特定の設定ファイルが設定されていない場合は、既定の Git 設定が使用されます。

source
GitConfig(level::Consts.GIT_CONFIG=Consts.CONFIG_LEVEL_DEFAULT)

グローバルおよびシステムの設定ファイルを読み込み、優先順位を付けた設定としてデフォルトの Git 設定を取得します。これにより、特定の Git リポジトリに属さないデフォルトの設定オプションにアクセスできます。

source
LibGit2.GitHash — Type
GitHash

sha-1ハッシュに基づくGitオブジェクト識別子です。リポジトリ内のGitObjectを識別するために使われる、20バイト(40桁の16進数)の文字列です。

source
LibGit2.GitObject — Type
GitObject(repo::GitRepo, hash::AbstractGitHash)
GitObject(repo::GitRepo, spec::AbstractString)

hash/specで指定されたrepoから、指定されたオブジェクト(GitCommit、GitBlob、GitTree、またはGitTag)を返します。

  • hashは、完全な(GitHash)ハッシュ、または部分的な(GitShortHash)ハッシュです。
  • specはテキスト形式の仕様です。全項目についてはthe git docsを参照してください。
source
LibGit2.GitRemote — Type
GitRemote(repo::GitRepo, rmt_name::AbstractString, rmt_url::AbstractString)::GitRemote

名前と URL を使ってリモートの Git リポジトリを検索します。デフォルトのフェッチ refspec を使用します。

Examples

repo = LibGit2.init(repo_path)
remote = LibGit2.GitRemote(repo, "upstream", repo_url)
source
GitRemote(repo::GitRepo, rmt_name::AbstractString, rmt_url::AbstractString, fetch_spec::AbstractString)::GitRemote

リポジトリ名とURL、およびリモートからの取得方法に関する指定(取得元のリモートブランチなど)を使って、リモートのGitリポジトリを検索します。

Examples

repo = LibGit2.init(repo_path)
refspec = "+refs/heads/mybranch:refs/remotes/origin/mybranch"
remote = LibGit2.GitRemote(repo, "upstream", repo_url, refspec)
source
LibGit2.GitRemoteAnon — Function
GitRemoteAnon(repo::GitRepo, url::AbstractString)::GitRemote

名前ではなく、URLだけを使ってリモートのGitリポジトリを検索します。

Examples

repo = LibGit2.init(repo_path)
remote = LibGit2.GitRemoteAnon(repo, repo_url)
source
LibGit2.GitRepo — Type
LibGit2.GitRepo(path::AbstractString)

path で Git リポジトリを開きます。

source
LibGit2.GitRepoExt — Function
LibGit2.GitRepoExt(path::AbstractString, flags::Cuint = Cuint(Consts.REPOSITORY_OPEN_DEFAULT))

path で、アクセス制御を強化した Git リポジトリを開きます(たとえば、path を読み取るには、現在のユーザーが特別なアクセスグループのメンバーである必要がある場合など)。

source
LibGit2.GitRevWalker — Type
GitRevWalker(repo::GitRepo)

GitRevWalker は、Git リポジトリ repo の リビジョン(つまりコミット)を順にたどります。これはリポジトリ内のコミットを集めたもので、反復処理に対応し、LibGit2.map および LibGit2.count を呼び出せます(たとえば、LibGit2.count を使って、特定の作者がリポジトリ内で作成したコミットの割合を求められます)。

cnt = LibGit2.with(LibGit2.GitRevWalker(repo)) do walker
    LibGit2.count((oid,repo)->(oid == commit_oid1), walker, oid=commit_oid1, by=LibGit2.Consts.SORT_TIME)
end

ここでは、LibGit2.count によって、指定した GitHash を持つ、ウォーク上のコミット数を求めます。GitHash はコミットごとに一意なので、cnt は 1 になります。

source
LibGit2.GitShortHash — Type
GitShortHash(hash::GitHash, len::Integer)

一意である場合に Git オブジェクトの識別に使用できる、短縮形の Git オブジェクト識別子。hash の先頭 len 桁の 16 進数で構成されます(残りの桁は無視されます)。

source
LibGit2.GitStatus — Type
LibGit2.GitStatus(repo::GitRepo; status_opts=StatusOptions())

git リポジトリ repo 内の各ファイルの状態(変更済みか、ステージ済みかなど)を取得します。status_opts を使うと、未追跡ファイルを確認するかどうか、サブモジュールを含めるかどうかなど、さまざまなオプションを設定できます。詳しくは StatusOptions を参照してください。

source
LibGit2.GitTag — Type
GitTag(repo::GitRepo, hash::AbstractGitHash)
GitTag(repo::GitRepo, spec::AbstractString)

GitTag オブジェクトを、hash/spec で指定された repo から返します。

  • hash は、完全な(GitHash)ハッシュ、または部分的な(GitShortHash)ハッシュです。
  • spec はテキスト形式の仕様です。全項目については the git docs を参照してください。
source
LibGit2.GitTree — Type
GitTree(repo::GitRepo, hash::AbstractGitHash)
GitTree(repo::GitRepo, spec::AbstractString)

repoで指定されたhash/specから、GitTreeオブジェクトを返します。

  • hashは、完全なハッシュ(GitHash)または部分ハッシュ(GitShortHash)です。
  • specはテキスト形式の指定です。全項目についてはthe git docsを参照してください。
source
LibGit2.BlameOptions — Type
LibGit2.BlameOptions

git_blame_options 構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では、常に 1 です。
  • flags: Consts.BLAME_NORMAL または Consts.BLAME_FIRST_PARENT のいずれかです(その他の blame フラグは、libgit2 ではまだ実装されていません)。
  • min_match_characters: 変更をそのコミットに関連付けるために、コミット内で変更されている必要がある英数字の最小文字数です。デフォルトは 20 です。libgit2 ではまだ実装されていない Consts.BLAME_*_COPIES フラグのいずれかを使用した場合にのみ有効です。
  • newest_commit: 変更を調べる対象となる、最も新しいコミットの GitHash です。
  • oldest_commit: 変更を調べる対象となる、最も古いコミットの GitHash です。
  • min_line: blame の開始位置となるファイルの先頭行です。デフォルトは 1 です。
  • max_line: blame の対象となるファイルの最終行です。デフォルトは 0 で、ファイルの最終行を意味します。
source
LibGit2.MergeOptions — Type
LibGit2.MergeOptions

git_merge_options 構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で構造体の仕様が変更された場合に備えた、使用中の構造体のバージョン。現時点では常に 1 です。

  • flags: マージの動作を指定するフラグを表す enum。git_merge_flag_t で定義されています。対応する Julia の列挙型は GIT_MERGE で、次の値を取ります。

    • MERGE_FIND_RENAMES: 共通の祖先からマージの「ours」側または「theirs」側にかけて、ファイル名が変更されたかどうかを検出します。ファイル名が変更された場合でもマージできるようにします。
    • MERGE_FAIL_ON_CONFLICT: 競合が見つかった時点で、解決を試みずに直ちに終了します。
    • MERGE_SKIP_REUC: マージ後のインデックスに REUC 拡張を書き込みません。
    • MERGE_NO_RECURSIVE: マージ対象のコミットに複数のマージベースがある場合、ベースを再帰的にマージせず、最初のものを使用します。
  • rename_threshold: 2つのファイルを同一ファイルの改名とみなすために必要な類似度。類似度をパーセンテージで指定する整数です。既定値は 50 です。

  • target_limit: 改名を検出するために比較するファイルの最大数。既定値は 200 です。

  • metric: 改名検出で2つのファイルの類似度を判定するために使用する、任意のカスタム関数。

  • recursion_limit: マージ用の新しい仮想マージベースを構築するために、共通祖先のマージを試みる回数の上限。既定では上限はありません。このフィールドは、libgit2 のバージョンが 0.24.0 より新しい場合にのみ存在します。

  • default_driver: 両方の側で変更がある場合に使用するマージドライバー。このフィールドは、libgit2 のバージョンが 0.25.0 より新しい場合にのみ存在します。

  • file_favor: text ドライバーで、ファイル内容の競合をどのように処理するか。

    • MERGE_FILE_FAVOR_NORMAL: マージの両側で同じセクションが変更されている場合、インデックスに競合の情報を記録します。git checkout はこの情報を使ってマージファイルを作成し、ユーザーはそのファイルを参照して競合を解決できます。これが既定の動作です。
    • MERGE_FILE_FAVOR_OURS: マージの両側で同じセクションが変更されている場合、インデックスではマージの「ours」側のバージョンを使用します。
    • MERGE_FILE_FAVOR_THEIRS: マージの両側で同じセクションが変更されている場合、インデックスではマージの「theirs」側のバージョンを使用します。
    • MERGE_FILE_FAVOR_UNION: マージの両側で同じセクションが変更されている場合、両側にある重複しない各行を、インデックスに格納するファイルに含めます。
  • file_flags: ファイルをマージする際の指針。

source
LibGit2.ProxyOptions — Type
LibGit2.ProxyOptions

プロキシ経由で接続するためのオプションです。

git_proxy_options 構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョンです。現時点では常に 1 です。

  • proxytype: 使用するプロキシの種類を示す enum です。定義は git_proxy_t にあります。対応する Julia の列挙型は GIT_PROXY で、次の値を取ります。

    • PROXY_NONE: プロキシ経由での接続を試みません。
    • PROXY_AUTO: git の設定からプロキシ構成を自動判定します。
    • PROXY_SPECIFIED: この構造体の url フィールドで指定された URL を使って接続します。

    デフォルトでは、プロキシの種類を自動判定します。

  • url: プロキシの URL です。

  • credential_cb: リモートへの接続に認証が必要な場合に呼び出されるコールバック関数へのポインターです。

  • certificate_cb: 証明書の検証に失敗した場合に呼び出されるコールバック関数へのポインターです。接続を続行するかどうかをユーザーが判断できます。この関数が 1 を返すと接続が許可され、0 を返すと接続は許可されません。エラーを返すには負の値を使用できます。

  • payload: 2 つのコールバック関数に渡されるペイロードです。

Examples

julia> fo = LibGit2.FetchOptions(
           proxy_opts = LibGit2.ProxyOptions(url = Cstring("https://my_proxy_url.com")))

julia> fetch(remote, "master", options=fo)
source
LibGit2.PushOptions — Type
LibGit2.PushOptions

git_push_options 構造体に一致します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では、常に 1 です。
  • parallelism: pack ファイルを作成する必要がある場合に、packbuilder が起動するワーカースレッド数を設定する変数です。0 の場合、packbuilder が使用するスレッド数を自動的に設定します。デフォルトは 1 です。
  • callbacks: push で使用するコールバック(リモートでの認証など)です。
  • proxy_opts: LibGit2 のバージョンが 0.25.0 以上の場合にのみ関係します。リモートとの通信にプロキシを使用するためのオプションを設定します。詳細は ProxyOptions を参照してください。
  • custom_headers: LibGit2 のバージョンが 0.24.0 以上の場合にのみ関係します。push 操作に必要な追加ヘッダーです。
  • remote_push_options: LibGit2 のバージョンが 1.8.0 以上の場合にのみ関係します。リモートに渡す「Push options」です。
source
LibGit2.RebaseOperation — Type
LibGit2.RebaseOperation

リベース中に実行する単一の命令/操作を表します。git_rebase_operation 構造体に対応します。

各フィールドの意味は次のとおりです。

  • optype: 現在実行中のリベース操作の種類。選択肢は次のとおりです。

    • REBASE_OPERATION_PICK: 対象のコミットを cherry-pick します。
    • REBASE_OPERATION_REWORD: 対象のコミットを cherry-pick し、プロンプトを使ってコミットメッセージを書き換えます。
    • REBASE_OPERATION_EDIT: 対象のコミットを cherry-pick し、コミットの内容とメッセージをユーザーが編集できるようにします。
    • REBASE_OPERATION_SQUASH: 対象のコミットを直前のコミットに squash します。2つのコミットメッセージは統合されます。
    • REBASE_OPERATION_FIXUP: 対象のコミットを直前のコミットに squash します。直前のコミットメッセージのみが使用されます。
    • REBASE_OPERATION_EXEC: コミットを cherry-pick せず、コマンドを実行します。コマンドが正常終了した場合は続行します。
  • id: このリベース手順で処理するコミットの GitHash。

  • exec: REBASE_OPERATION_EXEC を使用する場合に、この手順で実行するコマンド(たとえば、各コミットの後にテストスイートを実行するコマンド)。

source
LibGit2.RebaseOptions — Type
LibGit2.RebaseOptions

git_rebase_options 構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では、常に 1 です。
  • quiet: リベースを支援または実行している他の Git クライアントに、リベースを「静かに」実行するよう伝えます。相互運用性のために使用されます。デフォルトは 1 です。
  • inmemory: メモリ上でリベースを開始します。リベースを実行する呼び出し元は、各ステップを進めて変更をコミットできますが、HEAD を巻き戻したり、リポジトリを更新したりすることはできません。workdir は変更されません。libgit2 のバージョンが 0.24.0 以降の場合にのみ使用できます。
  • rewrite_notes_ref: リベースの完了時にコミットノートを書き換えるために使用する、ノートへの参照名。
  • merge_opts: リベースの各ステップでツリーをマージする方法を制御するマージオプション。libgit2 のバージョンが 0.24.0 以降の場合にのみ使用できます。
  • checkout_opts: リベースの初期化時、各ステップの実行時、および中止時にファイルを書き込むためのチェックアウトオプション。詳しくは CheckoutOptions を参照してください。
source
LibGit2.SignatureStruct — Type
LibGit2.SignatureStruct

コミッターやタグ作成者などのアクション署名です。git_signature 構造体に対応します。

各フィールドの意味は次のとおりです。

  • name: コミッターまたはコミットの作成者の氏名。
  • email: コミッターまたは作成者への連絡に使用するメールアドレス。
  • when: コミットが作成された時刻、またはリポジトリにコミットされた時刻を示す TimeStruct。
source
LibGit2.StatusEntry — Type
LibGit2.StatusEntry

HEAD にあるファイルとインデックスの差分、およびインデックスと作業ディレクトリの差分を提供します。git_status_entry 構造体に対応します。

各フィールドの内容は次のとおりです。

  • status: ファイルの状態フラグを格納します。ファイルが最新の状態か、インデックスまたは作業ツリーで何らかの変更が加えられているかを示します。
  • head_to_index: DiffDelta へのポインターです。HEAD にあるファイルとインデックスにあるファイルの差分を保持します。
  • index_to_workdir: DiffDelta へのポインターです。インデックスにあるファイルと workdir にあるファイルの差分を保持します。
source
LibGit2.StatusOptions — Type
LibGit2.StatusOptions

git_status_foreach_ext()がコールバックを呼び出す方法を制御するオプションです。git_status_opt_t構造体に対応します。

各フィールドの意味は次のとおりです。

  • version: 後で変更される場合に備えた、使用中の構造体のバージョン。現時点では常に1です。
  • show: 調べるファイルとその順序を指定するフラグ。デフォルトはConsts.STATUS_SHOW_INDEX_AND_WORKDIRです。
  • flags: status呼び出しで使用するコールバックを制御するフラグ。
  • pathspec: パスの照合に使用するパスの配列。パス照合の動作は、showとflagsの値によって異なります。
  • baselineは、作業ディレクトリおよびインデックスとの比較に使用するツリーです。デフォルトはHEADです。
source
LibGit2.StrArrayStruct — Type
LibGit2.StrArrayStruct

文字列配列を表す LibGit2 の表現です。git_strarray 構造体に対応します。

LibGit2 からデータを取得する場合、一般的な使い方は次のとおりです。

sa_ref = Ref(StrArrayStruct())
@check ccall(..., (Ptr{StrArrayStruct},), sa_ref)
res = collect(sa_ref[])
free(sa_ref)

特に、Ref オブジェクトに対して、その後に LibGit2.free を呼び出す必要がある点に注意してください。

一方、文字列のベクトルを LibGit2 に渡す場合は、暗黙的な変換に任せるのが一般に最も簡単です。

strs = String[...]
@check ccall(..., (Ptr{StrArrayStruct},), strs)

データは Julia によって確保されるため、free を呼び出す必要はありません。

source
LibGit2.addfile — Function
addfile(cfg::GitConfig, path::AbstractString,
        level::Consts.GIT_CONFIG=Consts.CONFIG_LEVEL_APP,
        repo::Union{GitRepo, Nothing} = nothing,
        force::Bool=false)

既存の Git 設定ファイル path を、現在の GitConfig cfg に追加します。ファイルが存在しない場合は作成されます。

  • level は Git 設定の優先度レベルを指定します。優先度レベルは

Consts.GIT_CONFIG

によって決まります。

  • repo は、条件付きインクルードを解析するための任意のリポジトリです。
  • force が false で、指定された優先度レベルの設定がすでに存在する場合、

addfile はエラーになります。force が true の場合、既存の設定は path のファイル内の設定で置き換えられます。

source
LibGit2.add! — Function
add!(repo::GitRepo, files::AbstractString...; flags::Cuint = Consts.INDEX_ADD_DEFAULT)
add!(idx::GitIndex, files::AbstractString...; flags::Cuint = Consts.INDEX_ADD_DEFAULT)

filesで指定されたパスのファイルをすべて、idx(またはrepoのインデックス)に追加します。ファイルがすでに存在する場合は、インデックスのエントリが更新されます。まだ存在しない場合は、新たにインデックスに追加されます。filesには、展開されるグロブパターンを指定できます。一致するファイルはすべて追加されます(ただし、INDEX_ADD_DISABLE_PATHSPEC_MATCHが設定されている場合を除きます。下記参照)。ファイルが(.gitignoreまたは設定ファイルで)無視対象になっている場合、インデックスですでに追跡されているファイルを更新する場合を除き、追加されません。キーワード引数flagsは、無視対象ファイルの扱いを制御するビットフラグの集合です。

  • Consts.INDEX_ADD_DEFAULT - デフォルト。上記のとおりです。
  • Consts.INDEX_ADD_FORCE - 既存の無視ルールを無視し、すでに無視対象になっているファイルも強制的にインデックスに追加します。
  • Consts.INDEX_ADD_CHECK_PATHSPEC - INDEX_ADD_FORCEと同時には使用できません。files内でディスク上に存在する各ファイルが、無視リストに含まれていないことを確認します。ファイルが無視対象の場合、この関数はEINVALIDSPECを返します。
  • Consts.INDEX_ADD_DISABLE_PATHSPEC_MATCH - グロブによる照合を無効にし、filesで指定されたパスと完全に一致するファイルのみをインデックスに追加します。
source
LibGit2.add_fetch! — Function
add_fetch!(repo::GitRepo, rmt::GitRemote, fetch_spec::String)

指定したrmtに対する fetch refspec を追加します。この refspec には、どのブランチをフェッチするかを示す情報が含まれます。

Examples

julia> LibGit2.add_fetch!(repo, remote, "upstream");

julia> LibGit2.fetch_refspecs(remote)
String["+refs/heads/*:refs/remotes/upstream/*"]
source
LibGit2.add_push! — Function
add_push!(repo::GitRepo, rmt::GitRemote, push_spec::String)

指定したrmtに対して、push refspecを追加します。このrefspecには、どのブランチをpushするかを指定します。

Examples

julia> LibGit2.add_push!(repo, remote, "refs/heads/master");

julia> remote = LibGit2.get(LibGit2.GitRemote, repo, branch);

julia> LibGit2.push_refspecs(remote)
String["refs/heads/master"]
Note

push refspecを更新した後、変更を反映させ、pushの呼び出しを機能させるには、対象のGitRemoteをcloseしてから、再度開く必要がある場合があります。

source
LibGit2.addblob! — Function
LibGit2.addblob!(repo::GitRepo, path::AbstractString)

path のファイルを読み込み、repo のオブジェクトデータベースにルースブロブとして追加します。生成されたブロブの GitHash を返します。

Examples

hash_str = string(commit_oid)
blob_file = joinpath(repo_path, ".git", "objects", hash_str[1:2], hash_str[3:end])
id = LibGit2.addblob!(repo, blob_file)
source
LibGit2.author — Function
author(c::GitCommit)

コミットの作成者 c の Signature を返します。作成者とは、該当するファイルに変更を加えた人のことです。詳しくは committer を参照してください。

source
LibGit2.authors — Function
authors(repo::GitRepo)::Vector{Signature}

repo リポジトリへのコミットの全作成者を返します。

Examples

repo = LibGit2.GitRepo(repo_path)
repo_file = open(joinpath(repo_path, test_file), "a")

println(repo_file, commit_msg)
flush(repo_file)
LibGit2.add!(repo, test_file)
sig = LibGit2.Signature("TEST", "TEST@TEST.COM", round(time(), 0), 0)
commit_oid1 = LibGit2.commit(repo, "commit1"; author=sig, committer=sig)
println(repo_file, randstring(10))
flush(repo_file)
LibGit2.add!(repo, test_file)
commit_oid2 = LibGit2.commit(repo, "commit2"; author=sig, committer=sig)

# will be a Vector of [sig, sig]
auths = LibGit2.authors(repo)
source
LibGit2.branch — Function
branch(repo::GitRepo)

git branchと同等です。現在のHEADから新しいブランチを作成します。

source
LibGit2.branch! — Function
branch!(repo::GitRepo, branch_name::AbstractString, commit::AbstractString=""; kwargs...)

repo リポジトリで新しい Git ブランチをチェックアウトします。commit は文字列形式の GitHash で、新しいブランチの起点になります。commit が空文字列の場合は、現在の HEAD が使用されます。

キーワード引数は次のとおりです。

  • track::AbstractString="": 新しいブランチが追跡するリモートブランチ名。空の場合(デフォルト)は、リモートブランチを追跡しません。
  • force::Bool=false: true の場合、ブランチの作成を強制します。
  • set_head::Bool=true: true の場合、ブランチの作成後に、そのブランチの HEAD を repo の HEAD に設定します。

git checkout [-b|-B] <branch_name> [<commit>] [--track <track>] と同等です。

Examples

repo = LibGit2.GitRepo(repo_path)
LibGit2.branch!(repo, "new_branch", set_head=false)
source
LibGit2.checkout! — Function
checkout!(repo::GitRepo, commit::AbstractString=""; force::Bool=true)

git checkout [-f] --detach <commit>と同等です。repoで、git コミット commit(文字列形式のGitHash)をチェックアウトします。forceがtrueの場合は、強制的にチェックアウトし、現在の変更をすべて破棄します。これにより、現在のHEADがデタッチされることに注意してください。

Examples

repo = LibGit2.GitRepo(repo_path)
open(joinpath(LibGit2.path(repo), "file1"), "w") do f
    write(f, "111
")
end
LibGit2.add!(repo, "file1")
commit_oid = LibGit2.commit(repo, "add file1")
open(joinpath(LibGit2.path(repo), "file1"), "w") do f
    write(f, "112
")
end
# would fail without the force=true
# since there are modifications to the file
LibGit2.checkout!(repo, string(commit_oid), force=true)
source
LibGit2.clone — Function
clone(repo_url::AbstractString, repo_path::AbstractString, clone_opts::CloneOptions)

リモートリポジトリ(リモート URL またはローカルファイルシステム上のパス)を repo_url から repo_path(ローカルファイルシステム上のパスである必要があります)にクローンします。ベアクローンにするかどうかなどのクローンオプションは、CloneOptions で設定します。

Examples

repo_url = "https://github.com/JuliaLang/Example.jl"
repo = LibGit2.clone(repo_url, "/home/me/projects/Example")
source
clone(repo_url::AbstractString, repo_path::AbstractString; kwargs...)

repo_url にあるリモートリポジトリを、ローカルファイルシステム上の repo_path にクローンします。

キーワード引数は次のとおりです。

  • branch::AbstractString="": リモートのどのブランチをクローンするかを指定します。指定しない場合は、リポジトリのデフォルトブランチ(通常は master)が使われます。
  • isbare::Bool=false: true の場合、リモートをベアリポジトリとしてクローンします。この場合、repo_path 自体が repo_path/.git ではなく Git ディレクトリになります。そのため、作業ツリーはチェックアウトできません。Git CLI の引数 --bare に相当します。
  • remote_cb::Ptr{Cvoid}=C_NULL: クローンの前にリモートを作成するために使うコールバックです。C_NULL(デフォルト)の場合、リモートの作成は試みず、すでに存在するものとして扱います。
  • depth::Integer=0: 指定したコミット数まで履歴を切り詰めたシャロークローンを作成します。0 は完全なクローン(デフォルト)を指定します。シャロークローンから不足しているデータをすべて取得するには、Consts.FETCH_DEPTH_UNSHALLOW を使います。注: 執筆時点では、シャロークローンはネットワークプロトコル(http、https、git、ssh)でのみサポートされており、ローカルファイルシステムのパスではサポートされていません。(https://github.com/libgit2/libgit2/issues/6634)
  • credentials::Creds=nothing: プライベートリポジトリの認証に使う認証情報や設定を指定します。
  • callbacks::Callbacks=Callbacks(): ユーザーが指定するコールバックとペイロードです。

git clone [-b <branch>] [--bare] [--depth <depth>] <repo_url> <repo_path> と同等です。

Examples

repo_url = "https://github.com/JuliaLang/Example.jl"
repo1 = LibGit2.clone(repo_url, "test_path")
repo2 = LibGit2.clone(repo_url, "test_path", isbare=true)
julia_url = "https://github.com/JuliaLang/julia"
julia_repo = LibGit2.clone(julia_url, "julia_path", branch="release-0.6")
# Shallow clone with only the most recent commit
shallow_repo = LibGit2.clone(repo_url, "shallow_path", depth=1)
source
LibGit2.commit — Function
commit(repo::GitRepo, msg::AbstractString; kwargs...)::GitHash

git_commit_createをラップします。リポジトリrepoにコミットを作成します。msgはコミットメッセージです。新しいコミットのOIDを返します。

キーワード引数は次のとおりです。

  • refname::AbstractString=Consts.HEAD_FILE: NULLでない場合、新しいコミットを指すように更新する参照名です。たとえば、"HEAD"を指定すると、現在のブランチのHEADが更新されます。参照がまだ存在しない場合は作成されます。
  • author::Signature = Signature(repo)は、コミットの作成者に関する情報を含むSignatureです。
  • committer::Signature = Signature(repo)は、リポジトリにコミットを記録した人に関する情報を含むSignatureです。必ずしもauthorと同じとは限りません。たとえば、authorがパッチをメールでcommitterに送り、後者がそれをコミットした場合です。
  • tree_id::GitHash = GitHash()は、コミットの作成に使用するGitツリーです。系譜と、ほかの履歴との関係を示します。treeはrepoに属している必要があります。
  • parent_ids::Vector{GitHash}=GitHash[]は、新しいコミットの親コミットとして使用する、GitHashによるコミットのリストです。空でもかまいません。たとえば、マージコミットのように、コミットが複数の親を持つ場合があります。
source
LibGit2.commit(rb::GitRebase, sig::GitSignature)

現在のパッチをリベース rb にコミットし、コミッターには sig を指定してください。コミットがすでに適用されている場合は、何も出力しないでください。

source
LibGit2.committer — Function
committer(c::GitCommit)

c のコミットのコミッターの Signature を返します。コミッターとは、author が元々作成した変更をコミットした人です。ただし、コミッターは author と同一人物とは限りません。たとえば、author がパッチをメールで committer に送り、その人がコミットした場合が該当します。

source
LibGit2.count — Function
LibGit2.count(f::Function, walker::GitRevWalker; oid::GitHash=GitHash(), by::Cint=Consts.SORT_NONE, rev::Bool=false)

GitRevWalker walkerを使って、リポジトリの履歴にあるすべてのコミットを「たどり」、fを適用したときにtrueを返すコミットの数を調べます。キーワード引数は次のとおりです。 * oid: たどり始めるコミットのGitHash。デフォルトではpush_head!を使うため、HEADコミットとそのすべての祖先が対象になります。 * by: ソート方法。デフォルトではソートしません。ほかに、トポロジー順(LibGit2.Consts.SORT_TOPOLOGICAL)、時系列の昇順(LibGit2.Consts.SORT_TIME、最も古いものが先)、時系列の降順(LibGit2.Consts.SORT_REVERSE、最も新しいものが先)でソートできます。 * rev: ソート順を逆にするかどうか(たとえば、トポロジー順でソートする場合)。

Examples

cnt = LibGit2.with(LibGit2.GitRevWalker(repo)) do walker
    LibGit2.count((oid, repo)->(oid == commit_oid1), walker, oid=commit_oid1, by=LibGit2.Consts.SORT_TIME)
end

LibGit2.countは、特定のGitHash commit_oid1を持つコミットのうち、そのコミットからたどり始めて時系列の順に進んだときに見つかる数を返します。GitHashはコミットごとに一意であるため、cntは1になります。

source
LibGit2.counthunks — Function
counthunks(blame::GitBlame)

ファイル内の個別の「ハンク」の数を返します。ハンクには複数の行が含まれる場合があります。通常、ハンクとは、ファイル内でまとめて追加・変更・削除された部分を指します。たとえば、ソースファイルに追加された関数や、後に最適化によってその関数から取り除かれた内側のループなどです。

source
LibGit2.create_branch — Function
LibGit2.create_branch(repo::GitRepo, bname::AbstractString, commit_obj::GitCommit; force::Bool=false)

リポジトリ repo に、コミット commit_obj(repo に含まれている必要があります)を指す、名前が bname の新しいブランチを作成します。force が true の場合、同じ名前のブランチ bname がすでに存在すれば上書きします。force が false で、ブランチ bname がすでに存在する場合、この関数はエラーをスローします。

source
LibGit2.credentials_callback — Function
credential_callback(...)::Cint

接続プロトコルに応じて異なる認証情報の取得方法を提供する、LibGit2 の認証情報コールバック関数です。payload_ptrには、状態と設定を管理するLibGit2.CredentialPayloadオブジェクトを含める必要があります。

allowed_typesには、試行する認証方式を指定するLibGit2.Consts.GIT_CREDTYPE値のビットマスクが含まれます。

認証情報による認証は、対応している場合、次の順序で行われます。

  • SSH エージェント
  • SSH の秘密鍵と公開鍵のペア
  • ユーザー名とパスワード(平文)

認証情報の入力を求められた場合、^Dと入力すると、プロンプトを中断できます(dキーを押しながら Control キーを押します)。

注: libgit2認証の仕様上、認証に失敗しても、成功したかどうかを示す情報なしにこの関数が再度呼び出されます。同じ無効な認証情報を繰り返し使用して無限ループに陥るのを防ぐため、ペイロードを使って状態を管理します。

詳しくは、LibGit2 のauthenticating against a serverに関するガイドを参照してください。

source
LibGit2.diff_files — Function
diff_files(repo::GitRepo, branch1::AbstractString, branch2::AbstractString; kwarg...)::Vector{AbstractString}

ブランチ branch1 と branch2 の間で、Git リポジトリ repo 内の変更されたファイルを表示します。

キーワード引数は次のとおりです。

  • filter::Set{Consts.DELTA_STATUS}=Set([Consts.DELTA_ADDED, Consts.DELTA_MODIFIED, Consts.DELTA_DELETED]))。差分のオプションを指定します。デフォルトでは、追加、変更、削除されたファイルが表示されます。

変更されたファイルの内容ではなく、ファイル名のみを返します。

Examples

LibGit2.branch!(repo, "branch/a")
LibGit2.branch!(repo, "branch/b")
# add a file to repo
open(joinpath(LibGit2.path(repo),"file"),"w") do f
    write(f, "hello repo
")
end
LibGit2.add!(repo, "file")
LibGit2.commit(repo, "add file")
# returns ["file"]
filt = Set([LibGit2.Consts.DELTA_ADDED])
files = LibGit2.diff_files(repo, "branch/a", "branch/b", filter=filt)
# returns [] because existing files weren't modified
filt = Set([LibGit2.Consts.DELTA_MODIFIED])
files = LibGit2.diff_files(repo, "branch/a", "branch/b", filter=filt)

git diff --name-only --diff-filter=<filter> <branch1> <branch2> と同等です。

source
LibGit2.entrytype — Function
entrytype(te::GitTreeEntry)

teが参照するオブジェクトの型を返します。結果は、objtypeが返す型のいずれかです。たとえば、GitTreeやGitBlobです。

source
LibGit2.fetch — Function
fetch(rmt::GitRemote, refspecs; options::FetchOptions=FetchOptions(), msg="")

指定されたリモート Git リポジトリ rmt からフェッチします。フェッチするリモートブランチは refspecs によって決まります。キーワード引数は次のとおりです。

  • options: フェッチ時のオプションを指定します。たとえば、フェッチ後にプルーニングするかどうかなどです。詳しくは FetchOptions を参照してください。
  • msg: reflog に記録するメッセージです。
source
fetch(repo::GitRepo; kwargs...)

リポジトリ repo の上流から更新を取得します。

キーワード引数は次のとおりです。

  • remote::AbstractString="origin": 取得元となる repo のリモート名です。空の場合は、URL を使って匿名リモートを構成します。
  • remoteurl::AbstractString="": remote の URL です。指定しない場合は、指定された remote の名前に基づいて決定されます。
  • refspecs=AbstractString[]: フェッチのプロパティを指定します。
  • depth::Integer=0: 各リモートブランチの先端から、取得するコミット数を制限します。0 は完全なフェッチ(デフォルト)を指定します。浅いクローンに不足しているデータをすべて取得するには、Consts.FETCH_DEPTH_UNSHALLOW を使用します。注: 執筆時点では、depth はネットワークプロトコル(http、https、git、ssh)でのみサポートされており、ローカルファイルシステムのパスではサポートされていません。 (https://github.com/libgit2/libgit2/issues/6634)
  • credentials=nothing: プライベートな remote に対する認証時に、認証情報や設定を指定します。
  • callbacks=Callbacks(): ユーザーが指定するコールバックとペイロードです。

git fetch [--depth <depth>] [<remoteurl>|<repo>] [<refspecs>] と同等です。

source
LibGit2.fetchheads — Function
fetchheads(repo::GitRepo)::Vector{FetchHead}

repo のすべてのフェッチヘッドを、それぞれ FetchHead として返してください。各フェッチヘッドには、名前、URL、マージ状態を含めてください。

Examples

julia> fetch_heads = LibGit2.fetchheads(repo);

julia> fetch_heads[1].name
"refs/heads/master"

julia> fetch_heads[1].ismerge
true

julia> fetch_heads[2].name
"refs/heads/test_branch"

julia> fetch_heads[2].ismerge
false
source
LibGit2.fetch_refspecs — Function
fetch_refspecs(rmt::GitRemote)::Vector{String}

指定したrmtのfetch refspecを取得します。これらのrefspecには、どのブランチを取得するかを示す情報が含まれています。

Examples

julia> remote = LibGit2.get(LibGit2.GitRemote, repo, "upstream");

julia> LibGit2.add_fetch!(repo, remote, "upstream");

julia> LibGit2.fetch_refspecs(remote)
String["+refs/heads/*:refs/remotes/upstream/*"]
source
LibGit2.merge_base — Function
merge_base(repo::GitRepo, one::AbstractString, two::AbstractString)::GitHash

コミット one と two の間で、マージベース(共通の祖先)を見つけてください。one と two は、どちらも文字列形式の場合があります。マージベースの GitHash を返してください。

source
LibGit2.merge! — Method
merge!(repo::GitRepo; kwargs...)::Bool

リポジトリ repo で git merge を実行し、履歴が分岐したコミットを現在のブランチにマージします。マージに成功した場合は true、失敗した場合は false を返します。

キーワード引数は次のとおりです。

  • committish::AbstractString="": committish にある指定したコミットをマージします。
  • branch::AbstractString="": ブランチ branch と、現在のブランチから分岐して以降のすべてのコミットをマージします。
  • fastforward::Bool=false: fastforward が true の場合、マージが早送り(現在のブランチの HEAD がマージ対象のコミットの祖先である状態)になる場合に限ってマージします。それ以外の場合はマージを拒否し、false を返します。これは git CLI のオプション --ff-only と同等です。
  • merge_opts::MergeOptions=MergeOptions(): merge_opts には、競合時のマージ戦略など、マージに関するオプションを指定します。
  • checkout_opts::CheckoutOptions=CheckoutOptions(): checkout_opts には、チェックアウト手順に関するオプションを指定します。

git merge [--ff-only] [<committish> | <branch>] と同等です。

Note

branch を指定する場合は、参照形式で指定する必要があります。文字列が GitReference に変換されるためです。たとえば、ブランチ branch_a をマージする場合は、merge!(repo, branch="refs/heads/branch_a") を呼び出します。

source
LibGit2.merge! — Method
merge!(repo::GitRepo, anns::Vector{GitAnnotated}; kwargs...)::Bool

注釈付きコミット(GitAnnotated オブジェクトとして取得)anns の変更を、リポジトリ repo の HEAD にマージします。キーワード引数は次のとおりです。

  • merge_opts::MergeOptions = MergeOptions(): 高速フォワードを許可するかどうかなど、マージ方法を指定するオプションです。詳しくは MergeOptions を参照してください。
  • checkout_opts::CheckoutOptions = CheckoutOptions(): チェックアウト方法を指定するオプションです。詳しくは CheckoutOptions を参照してください。

anns には、リモートまたはローカルのブランチヘッドを指定できます。マージに成功した場合は true を返し、成功しなかった場合は false を返します(たとえば、ブランチに共通の祖先がなく、マージできない場合)。

Examples

upst_ann = LibGit2.GitAnnotated(repo, "branch/a")

# merge the branch in
LibGit2.merge!(repo, [upst_ann])
source
LibGit2.merge! — Method
merge!(repo::GitRepo, anns::Vector{GitAnnotated}, fastforward::Bool; kwargs...)::Bool

注釈付きコミット(GitAnnotated オブジェクトとして取得されます)anns の変更を、リポジトリ repo の HEAD にマージします。fastforward が true の場合、許可されるのは早送りマージのみです。この場合、競合が発生するとマージは失敗します。それ以外の場合、fastforward が false であれば、競合ファイルが生成されることがあり、その場合はユーザーが解決する必要があります。

キーワード引数は次のとおりです。

  • merge_opts::MergeOptions = MergeOptions(): 早送りを許可するかどうかなど、マージ方法を指定するオプションです。詳しくは MergeOptions を参照してください。
  • checkout_opts::CheckoutOptions = CheckoutOptions(): チェックアウト方法を指定するオプションです。詳しくは CheckoutOptions を参照してください。

anns は、リモートまたはローカルのブランチヘッドを指す場合があります。マージに成功した場合は true を返し、成功しなかった場合(たとえば、ブランチ間に共通の祖先がなく、マージできない場合)は false を返します。

Examples

upst_ann_1 = LibGit2.GitAnnotated(repo, "branch/a")

# merge the branch in, fastforward
LibGit2.merge!(repo, [upst_ann_1], true)

# merge conflicts!
upst_ann_2 = LibGit2.GitAnnotated(repo, "branch/b")
# merge the branch in, try to fastforward
LibGit2.merge!(repo, [upst_ann_2], true) # will return false
LibGit2.merge!(repo, [upst_ann_2], false) # will return true
source
LibGit2.ffmerge! — Function
ffmerge!(repo::GitRepo, ann::GitAnnotated)

現在の HEAD に変更を fast-forward マージします。これは、ann が指すコミットが現在の HEAD の子孫である場合にのみ可能です(たとえば、ローカルブランチの先端より単純に先行しているリモートブランチから変更を取得する場合)。

source
LibGit2.fullname — Function
LibGit2.fullname(ref::GitReference)

シンボリック参照 ref が指す参照先の名前を返します。ref がシンボリック参照でない場合は、空文字列を返します。

source
LibGit2.features — Function
features()

現在のバージョンの libgit2 がサポートする Git の機能(スレッド処理、HTTPS や SSH の使用など)を一覧にしてください。

source
LibGit2.filename — Function
filename(te::GitTreeEntry)

teが指す、ディスク上のオブジェクトのファイル名を返してください。

source
LibGit2.filemode — Function
filemode(te::GitTreeEntry)::Cint

teが参照するディスク上のオブジェクトのUNIXファイルモードを、整数として返します。

source
LibGit2.gitdir — Function
LibGit2.gitdir(repo::GitRepo)

repo の「git」ファイルの場所を返します。

  • 通常のリポジトリでは、.git フォルダーの場所です。
  • ベアリポジトリでは、リポジトリ自体の場所です。

workdir、path も参照してください。

source
LibGit2.git_url — Function
LibGit2.git_url(; kwargs...)::String

指定された URL コンポーネントに基づいて文字列を作成します。scheme キーワードが指定されていない場合、生成される URL では代わりに scp-like syntax が使用されます。

Keywords

  • scheme::AbstractString="": 使用するプロトコルを示す URL スキーム。HTTP の場合は "http"、SSH の場合は "ssh" などを指定します。scheme が指定されていない場合、出力形式は "ssh" になりますが、scp 形式の構文が使用されます。
  • username::AbstractString="": 指定されている場合、出力で使用するユーザー名。
  • password::AbstractString="": 指定されている場合、出力で使用するパスワード。
  • host::AbstractString="": 出力で使用するホスト名。ホスト名の指定は必須です。
  • port::Union{AbstractString,Integer}="": 指定されている場合、出力で使用するポート番号。scp 形式の構文を使用する場合は指定できません。
  • path::AbstractString="": 指定されている場合、出力で使用するパス。
Warning

URL にパスワードを含めないでください。認証情報オブジェクトとは異なり、Julia では使用後に機密データを安全にゼロ化または破棄できないため、パスワードがメモリに残る可能性があります。その結果、初期化されていないメモリを通じて漏えいするおそれがあります。

Examples

julia> LibGit2.git_url(username="git", host="github.com", path="JuliaLang/julia.git")
"git@github.com:JuliaLang/julia.git"

julia> LibGit2.git_url(scheme="https", host="github.com", path="/JuliaLang/julia.git")
"https://github.com/JuliaLang/julia.git"

julia> LibGit2.git_url(scheme="ssh", username="git", host="github.com", port=2222, path="JuliaLang/julia.git")
"ssh://git@github.com:2222/JuliaLang/julia.git"
source
LibGit2.@githash_str — Macro
@githash_str -> AbstractGitHash

指定された文字列から git ハッシュオブジェクトを構築します。文字列が40桁未満の16進数の場合は GitShortHash を返し、それ以外の場合は GitHash を返します。

Examples

julia> LibGit2.githash"d114feb74ce633"
GitShortHash("d114feb74ce633")

julia> LibGit2.githash"d114feb74ce63307afe878a5228ad014e0289a85"
GitHash("d114feb74ce63307afe878a5228ad014e0289a85")
source
LibGit2.head — Function
LibGit2.head(repo::GitRepo)::GitReference

現在の repo の HEAD に対する GitReference を返します。

source
head(pkg::AbstractString)::String

pkg リポジトリの現在の HEAD を文字列として返します。 GitHash

source
LibGit2.head! — Function
LibGit2.head!(repo::GitRepo, ref::GitReference)::GitReference

repo の HEAD を、ref が指すオブジェクトに設定します。

source
LibGit2.head_oid — Function
LibGit2.head_oid(repo::GitRepo)::GitHash

git リポジトリ repo の現在の HEAD のオブジェクト ID を調べます。

source
LibGit2.headname — Function
LibGit2.headname(repo::GitRepo)

git リポジトリ repo の現在の HEAD の名前を取得します。repo が現在 detached 状態の場合は、HEAD がどの名前から切り離されているかを返します。

source
LibGit2.init — Function
LibGit2.init(path::AbstractString, bare::Bool=false)::GitRepo

path に新しい Git リポジトリを作成します。bare が false の場合、作業ツリーは path/.git に作成されます。bare が true の場合、作業ディレクトリは作成されません。

source
LibGit2.is_ancestor_of — Function
is_ancestor_of(a::AbstractString, b::AbstractString, repo::GitRepo)::Bool

trueを返すのは、文字列形式のGitHashであるaが、文字列形式のGitHashであるbの祖先である場合です。

Examples

julia> repo = GitRepo(repo_path);

julia> LibGit2.add!(repo, test_file1);

julia> commit_oid1 = LibGit2.commit(repo, "commit1");

julia> LibGit2.add!(repo, test_file2);

julia> commit_oid2 = LibGit2.commit(repo, "commit2");

julia> LibGit2.is_ancestor_of(string(commit_oid1), string(commit_oid2), repo)
true
source
LibGit2.isbinary — Function
isbinary(blob::GitBlob)::Bool

ファイルがバイナリかどうかを推測するため、NULL バイトを検索し、先頭 8000 バイトに含まれる印字可能文字と印字不可能文字の比率が妥当かどうかを調べます。

source
LibGit2.iscommit — Function
iscommit(id::AbstractString, repo::GitRepo)::Bool

コミット id(文字列形式の GitHash)がリポジトリに存在するか確認します。

Examples

julia> repo = GitRepo(repo_path);

julia> LibGit2.add!(repo, test_file);

julia> commit_oid = LibGit2.commit(repo, "add test_file");

julia> LibGit2.iscommit(string(commit_oid), repo)
true
source
LibGit2.isdiff — Function
LibGit2.isdiff(repo::GitRepo, treeish::AbstractString, pathspecs::AbstractString=""; cached::Bool=false)

treeishで指定されたツリーと、作業ツリー内の追跡対象ファイル(cached=falseの場合)またはインデックス(cached=trueの場合)との間に差分があるかどうかを確認します。pathspecsは、diffのオプションを指定します。

Examples

repo = LibGit2.GitRepo(repo_path)
LibGit2.isdiff(repo, "HEAD") # should be false
open(joinpath(repo_path, new_file), "a") do f
    println(f, "here's my cool new file")
end
LibGit2.isdiff(repo, "HEAD") # now true

git diff-index <treeish> [-- <pathspecs>]と同等です。

source
LibGit2.isdirty — Function
LibGit2.isdirty(repo::GitRepo, pathspecs::AbstractString=""; cached::Bool=false)::Bool

作業ツリー(cached=false)またはインデックス(cached=true)に、追跡対象ファイルの変更があるかどうかを確認します。pathspecs は、差分のオプションの仕様です。

Examples

repo = LibGit2.GitRepo(repo_path)
LibGit2.isdirty(repo) # should be false
open(joinpath(repo_path, new_file), "a") do f
    println(f, "here's my cool new file")
end
LibGit2.isdirty(repo) # now true
LibGit2.isdirty(repo, new_file) # now true

git diff-index HEAD [-- <pathspecs>] と同等です。

source
LibGit2.isorphan — Function
LibGit2.isorphan(repo::GitRepo)

現在のブランチが「孤立」ブランチ、つまりコミットがないブランチかどうかを確認します。このブランチへの最初のコミットには親がありません。

source
LibGit2.isset — Function
isset(val::Integer, flag::Integer)

flagでインデックス指定されたvalのビットがセットされている(1)か、セットされていない(0)かを判定します。

source
LibGit2.iszero — Function
iszero(id::GitHash)::Bool

指定されたGitHashの16進数の各桁がすべてゼロかどうかを判定します。

source
LibGit2.lookup_branch — Function
lookup_branch(repo::GitRepo, branch_name::AbstractString, remote::Bool=false)::Union{GitReference, Nothing}

branch_nameで指定されたブランチが、リポジトリrepoに存在するかどうかを判定してください。remoteがtrueの場合、repoはリモートのGitリポジトリとみなします。それ以外の場合は、ローカルファイルシステムの一部です。

ブランチが存在する場合は、要求されたブランチへのGitReferenceを返し、存在しない場合はnothingを返してください。

source
LibGit2.map — Function
LibGit2.map(f::Function, walker::GitRevWalker; oid::GitHash=GitHash(), range::AbstractString="", by::Cint=Consts.SORT_NONE, rev::Bool=false)

GitRevWalker walker を使ってリポジトリの履歴にあるすべてのコミットを「たどり」、たどった各コミットに対して f を適用します。キーワード引数は次のとおりです。 * oid: たどり始めるコミットの GitHash。デフォルトでは push_head! を使うため、HEAD コミットとそのすべての祖先が対象になります。 * range: GitHash の範囲。形式は oid1..oid2 です。f は その2つの間にあるすべてのコミットに適用されます。 * by: 並べ替え方法。デフォルトでは並べ替えません。ほかに、トポロジー順(LibGit2.Consts.SORT_TOPOLOGICAL)、時系列の昇順 (LibGit2.Consts.SORT_TIME、最も古いものが先頭)、時系列の降順 (LibGit2.Consts.SORT_REVERSE、最も新しいものが先頭)で並べ替える方法があります。 * rev: 並べ替えた順序を逆にするかどうか(たとえば、トポロジー順で並べ替える場合)。

Examples

oids = LibGit2.with(LibGit2.GitRevWalker(repo)) do walker
    LibGit2.map((oid, repo)->string(oid), walker, by=LibGit2.Consts.SORT_TIME)
end

ここでは、LibGit2.map が GitRevWalker を使って各コミットを調べ、その GitHash を見つけます。

source
LibGit2.mirror_callback — Function

ミラーコールバック関数

リモート参照の +refs/*:refs/* refspec と mirror フラグを設定する関数。

source
LibGit2.message — Function
message(c::GitCommit, raw::Bool=false)

cで行われた変更を説明するコミットメッセージを返してください。rawがfalseの場合は、先頭の改行を削除した、少し「整形済み」のメッセージを返してください。rawがtrueの場合、メッセージからそのような改行は削除されません。

source
LibGit2.merge_analysis — Function
merge_analysis(repo::GitRepo, anns::Vector{GitAnnotated}) -> analysis, preference

注釈付きブランチの先端が指す anns を解析し、どのような条件でマージできるかを判定します。たとえば、anns[1] が単に ann[2] の祖先である場合、merge_analysis は早送りマージが可能であると報告します。

出力は analysis と preference の2つです。analysis には、次のような値があります。 * MERGE_ANALYSIS_NONE: anns の要素をマージできません。 * MERGE_ANALYSIS_NORMAL: HEAD と、ユーザーがマージしようとしているコミットが、すべて共通の祖先から分岐している場合の通常のマージです。この場合、変更を解決する必要があり、競合が発生することもあります。 * MERGE_ANALYSIS_UP_TO_DATE: ユーザーがマージしようとしている入力コミットはすべて HEAD から到達可能なため、マージは不要です。 * MERGE_ANALYSIS_FASTFORWARD: 入力コミットは HEAD の子孫であるため、マージは不要です。代わりに、ユーザーは入力コミットをチェックアウトできます。 * MERGE_ANALYSIS_UNBORN: リポジトリの HEAD が存在しないコミットを参照しています。マージはできませんが、入力コミットをチェックアウトできる場合があります。preference にも、次のような値があります。 * MERGE_PREFERENCE_NONE: ユーザーに希望はありません。 * MERGE_PREFERENCE_NO_FASTFORWARD: 早送りマージを一切許可しません。 * MERGE_PREFERENCE_FASTFORWARD_ONLY: 早送りマージのみを許可し、競合が発生する可能性のある他の種類のマージは許可しません。preference は、リポジトリまたはグローバルの Git 設定で制御できます。

source
LibGit2.name — Function
LibGit2.name(ref::GitReference)

refの正式名称を返してください。

source
name(rmt::GitRemote)

リモートリポジトリの名前を取得します。たとえば、"origin"です。リモートが匿名の場合(GitRemoteAnonを参照)、名前は空文字列""になります。

Examples

julia> repo_url = "https://github.com/JuliaLang/Example.jl";

julia> repo = LibGit2.clone(cache_repo, "test_directory");

julia> remote = LibGit2.GitRemote(repo, "origin", repo_url);

julia> name(remote)
"origin"
source
LibGit2.name(tag::GitTag)

tag の名前(例:"v0.5")。

source
LibGit2.need_update — Function
need_update(repo::GitRepo)

git update-indexと同等です。repoの更新が必要な場合は、trueを返してください。

source
LibGit2.objtype — Function
objtype(obj_type::Consts.OBJECT)

列挙値に対応する型を返します。

source
LibGit2.path — Function
LibGit2.path(repo::GitRepo)

リポジトリのベースファイルパス repo を返します。

  • 通常のリポジトリでは、通常「.git」ディレクトリの親ディレクトリです(注: 作業ディレクトリとは異なる場合があります。詳しくは workdir を参照してください)。
  • ベアリポジトリでは、「git」ファイルの場所です。

gitdir、workdir も参照してください。

source
LibGit2.peel — Function
peel([T,] ref::GitReference)

ref を再帰的に剥がし、T 型のオブジェクトを取得します。T が指定されていない場合は、ref を剥がし、GitTag 以外のオブジェクトを取得します。

  • GitTag は、それが参照するオブジェクトまで剥がされます。
  • GitCommit は、GitTree まで剥がされます。
Note

注釈付きタグのみ、GitTag オブジェクトまで剥がすことができます。軽量タグ(デフォルト)は、refs/tags/ の下にある参照で、GitCommit オブジェクトを直接指します。

source
peel([T,] obj::GitObject)

obj を再帰的に剥がし、T 型のオブジェクトが得られるまで続けます。T が指定されていない場合は、型が変わるまで obj を剥がします。

  • GitTag は、参照先のオブジェクトまで剥がされます。
  • GitCommit は、GitTree まで剥がされます。
source
LibGit2.posixpath — Function
LibGit2.posixpath(path)

パス文字列 path の区切り文字を POSIX 形式に統一します。

source
LibGit2.push — Function
push(rmt::GitRemote, refspecs; force::Bool=false, options::PushOptions=PushOptions())

指定した rmt リモート Git リポジトリにプッシュします。プッシュ先のリモートブランチは refspecs に基づいて決定されます。キーワード引数は次のとおりです。

  • force: true の場合、競合を無視して強制プッシュします。
  • options: プッシュ時のオプションを指定します。たとえば、使用するプロキシヘッダーなどです。詳しくは PushOptions を参照してください。
Note

プッシュの refspec に関する情報は、ほかに 2 つの方法で追加できます。リポジトリの GitConfig にオプションを設定する方法(キーは push.default)と、add_push! を呼び出す方法です。どちらも行わない場合、効果を得るには push の呼び出しでプッシュ refspec を明示的に指定する必要があります。たとえば、次のように指定します。LibGit2.push(repo, refspecs=["refs/heads/master"])。

source
push(repo::GitRepo; kwargs...)

repo の上流リモートに更新をプッシュします。

キーワード引数は次のとおりです。

  • remote::AbstractString="origin": プッシュ先の上流リモートの名前。
  • remoteurl::AbstractString="": remote の URL。
  • refspecs=AbstractString[]: プッシュのプロパティを指定します。
  • force::Bool=false: リモートブランチを上書きする強制プッシュを行うかどうかを指定します。
  • credentials=nothing: プライベートな remote に対する認証時に、認証情報や設定を指定します。
  • callbacks=Callbacks(): ユーザーが指定するコールバックとペイロード。

git push [<remoteurl>|<repo>] [<refspecs>] と同等です。

source
LibGit2.push! — Method
LibGit2.push!(w::GitRevWalker, cid::GitHash)

GitRevWalker walkerをコミットcidから開始します。この関数を使うと、特定の年の最初のコミットをcidとして渡し、その結果のwをLibGit2.mapに渡すことで、その年以降のすべてのコミットに関数を適用できます。

source
LibGit2.push_head! — Function
LibGit2.push_head!(w::GitRevWalker)

HEAD コミットとその祖先を GitRevWalker w にプッシュします。これにより、ウォーク中に HEAD とそのすべての祖先コミットが検出されるようになります。

source
LibGit2.push_refspecs — Function
push_refspecs(rmt::GitRemote)::Vector{String}

指定したrmtのpush refspecを取得します。これらのrefspecには、どのブランチをプッシュするかを示す情報が含まれています。

Examples

julia> remote = LibGit2.get(LibGit2.GitRemote, repo, "upstream");

julia> LibGit2.add_push!(repo, remote, "refs/heads/master");

julia> close(remote);

julia> remote = LibGit2.get(LibGit2.GitRemote, repo, "upstream");

julia> LibGit2.push_refspecs(remote)
String["refs/heads/master"]
source
LibGit2.raw — Function
raw(id::GitHash)::Vector{UInt8}

GitHash の生バイトを、長さ 20 のベクトルとして取得します。

source
LibGit2.read_tree! — Function
LibGit2.read_tree!(idx::GitIndex, tree::GitTree)
LibGit2.read_tree!(idx::GitIndex, treehash::AbstractGitHash)

ツリー tree(または、idx が所有するリポジトリ内で treehash が指すツリー)をインデックス idx に読み込みます。現在のインデックスの内容は置き換えられます。

source
LibGit2.rebase! — Function
LibGit2.rebase!(repo::GitRepo, upstream::AbstractString="", newbase::AbstractString="")

現在のブランチを、upstream が指定されていればそこから、指定されていなければ上流の追跡ブランチから、自動マージリベースします。リベース先のブランチは newbase です。デフォルトでは upstream です。

自動解決できない競合が発生した場合、リベースは中止され、リポジトリと作業ツリーは元の状態のままになります。また、この関数は GitError をスローします。これは、おおむね次のコマンドライン文に相当します。

git rebase --merge [<upstream>]
if [ -d ".git/rebase-merge" ]; then
    git rebase --abort
fi
source
LibGit2.ref_list — Function
LibGit2.ref_list(repo::GitRepo)::Vector{String}

repo リポジトリ内のすべての参照名の一覧を取得します。

source
LibGit2.reftype — Function
LibGit2.reftype(ref::GitReference)::Cint

ref の型に対応する Cint を返します。

  • 参照が無効な場合は 0
  • 参照がオブジェクト ID の場合は 1
  • 参照がシンボリックな場合は 2
source
LibGit2.remotes — Function
LibGit2.remotes(repo::GitRepo)

repo のリモート名をベクトルで返します。

source
LibGit2.remove! — Function
remove!(repo::GitRepo, files::AbstractString...)
remove!(idx::GitIndex, files::AbstractString...)

インデックス idx(または repo のインデックス)から、files で指定されたパスのファイルをすべて削除します。

source
LibGit2.reset — Function
reset(val::Integer, flag::Integer)

valのうち、flagで指定されたビットをクリアし、0に戻します。

source
LibGit2.reset! — Function
reset!(payload, [config])::CredentialPayload

payload の状態を初期値にリセットし、認証情報コールバック内で再び使用できるようにします。config が指定されている場合は、設定も更新されます。

source

対象コミットツリーのインデックス内にある一部のエントリを、pathspecsで指定された内容に更新します。

source

現在のHEADを指定されたコミットOIDに設定し、必要に応じてインデックスと作業ツリーもそれに合わせてリセットします。

source

git reset [<コミット指定>] [–] <パス指定>...

source
reset!(repo::GitRepo, id::GitHash, mode::Cint=Consts.RESET_MIXED)

リポジトリ repo を id の状態に戻します。モードは mode で指定する次の3つから選びます。

  1. Consts.RESET_SOFT - HEAD を id に移動します。
  2. Consts.RESET_MIXED - デフォルト。HEAD を id に移動し、インデックスを id にリセットします。
  3. Consts.RESET_HARD - HEAD を id に移動し、インデックスを id にリセットして、作業ツリーの変更をすべて破棄します。

Examples

# fetch changes
LibGit2.fetch(repo)
isfile(joinpath(repo_path, our_file)) # will be false

# fastforward merge the changes
LibGit2.merge!(repo, fastforward=true)

# because there was not any file locally, but there is
# a file remotely, we need to reset the branch
head_oid = LibGit2.head_oid(repo)
new_head = LibGit2.reset!(repo, head_oid, LibGit2.Consts.RESET_HARD)

この例では、フェッチ元のリモートのインデックスに our_file というファイルが存在するため、リセットが必要です。

git reset [--soft | --mixed | --hard] <id> と同等です。

Examples

repo = LibGit2.GitRepo(repo_path)
head_oid = LibGit2.head_oid(repo)
open(joinpath(repo_path, "file1"), "w") do f
    write(f, "111
")
end
LibGit2.add!(repo, "file1")
mode = LibGit2.Consts.RESET_HARD
# will discard the changes to file1
# and unstage it
new_head = LibGit2.reset!(repo, head_oid, mode)
source
LibGit2.restore — Function
restore(s::State, repo::GitRepo)

リポジトリのrepoを、以前のState s(たとえば、マージを試みる前のブランチのHEAD)に戻します。sは、snapshot関数を使って生成できます。

source
LibGit2.revcount — Function
LibGit2.revcount(repo::GitRepo, commit1::AbstractString, commit2::AbstractString)

commit1 と commit2(文字列形式のコミット識別子 OID)の間にあるリビジョン数を列挙します。commit1 と commit2 は異なるブランチにある可能性があるため、revcount は「左右」のリビジョン一覧(および件数)を実行し、左側と右側のコミット数をそれぞれ表す Int のタプルを返します。左側(または右側)のコミットとは、ツリーの対称差のどちら側からそのコミットに到達できるかを示します。

git rev-list --left-right --count <commit1> <commit2> と同等です。

Examples

repo = LibGit2.GitRepo(repo_path)
repo_file = open(joinpath(repo_path, test_file), "a")
println(repo_file, "hello world")
flush(repo_file)
LibGit2.add!(repo, test_file)
commit_oid1 = LibGit2.commit(repo, "commit 1")
println(repo_file, "hello world again")
flush(repo_file)
LibGit2.add!(repo, test_file)
commit_oid2 = LibGit2.commit(repo, "commit 2")
LibGit2.revcount(repo, string(commit_oid1), string(commit_oid2))

これは (-1, 0) を返します。

source
LibGit2.set_remote_url — Function
set_remote_url(repo::GitRepo, remote_name, url)
set_remote_url(repo::String, remote_name, url)

GitRepoまたはpathにあるgitリポジトリのremote_nameについて、fetchとpushの両方をurlに設定します。通常、gitリポジトリではリモート名に"origin"を使用します。

Examples

repo_path = joinpath(tempdir(), "Example")
repo = LibGit2.init(repo_path)
LibGit2.set_remote_url(repo, "upstream", "https://github.com/JuliaLang/Example.jl")
LibGit2.set_remote_url(repo_path, "upstream2", "https://github.com/JuliaLang/Example2.jl")
source
LibGit2.shortname — Function
LibGit2.shortname(ref::GitReference)

ref の名前を短縮した、「人が読みやすい」形式を返します。

julia> repo = GitRepo(path_to_repo);

julia> branch_ref = LibGit2.head(repo);

julia> LibGit2.name(branch_ref)
"refs/heads/master"

julia> LibGit2.shortname(branch_ref)
"master"
source
LibGit2.snapshot — Function
snapshot(repo::GitRepo)::State

リポジトリ repo の現在の状態をスナップショットとして保存します。現在の HEAD、インデックス、および未コミットの作業が保存されます。出力 State は、後で restore の呼び出し時に使用すると、リポジトリをスナップショット時の状態に戻せます。

source
LibGit2.split_cfg_entry — Function
LibGit2.split_cfg_entry(ce::LibGit2.ConfigEntry)::Tuple{String,String,String,String}

ConfigEntryを、section、subsection、name、valueの各要素に分解します。

Examples

次の内容を含むgit設定ファイルがあるとします。

[credential "https://example.com"]
    username = me

ConfigEntryは、次のようになります。

julia> entry
ConfigEntry("credential.https://example.com.username", "me")

julia> LibGit2.split_cfg_entry(entry)
("credential", "https://example.com", "username", "me")

詳しくはgit config syntax documentationを参照してください。

source
LibGit2.status — Function
LibGit2.status(repo::GitRepo, path::String)::Union{Cuint, Cvoid}

Gitリポジトリrepo内のファイルpathの状態を確認します。たとえば、pathのファイルが変更されており、ステージングしてコミットする必要があるかどうかを確認できます。

source
LibGit2.stage — Function
stage(ie::IndexEntry)::Cint

ieのステージ番号を取得します。ステージ番号0は作業ツリーの現在の状態を表しますが、マージコンフリクトが発生した場合は、ほかの番号が使われることがあります。その場合、IndexEntryにある各ステージ番号は、ファイルの現在の状態がコンフリクトのどちら側(または両側)に属するかを示します。ステージ0はマージを試みる前の状態、ステージ1はローカルで行われた変更を表します。ステージ2以降は、ほかのブランチからの変更を表します(たとえば、複数ブランチをマージする「オクトパス」マージでは、ステージ2、3、4が使われることがあります)。

source
LibGit2.tag_create — Function
LibGit2.tag_create(repo::GitRepo, tag::AbstractString, commit; kwargs...)

リポジトリ repo のコミット commit に、新しい Git タグ tag(例: "v0.5")を作成します。

キーワード引数は次のとおりです。

  • msg::AbstractString="": タグのメッセージ。
  • force::Bool=false: true の場合、既存の参照は上書きされます。
  • sig::Signature=Signature(repo): タグ作成者の署名。
source
LibGit2.tag_delete — Function
LibGit2.tag_delete(repo::GitRepo, tag::AbstractString)

リポジトリ repo から Git タグ tag を削除します。

source
LibGit2.tag_list — Function
LibGit2.tag_list(repo::GitRepo)::Vector{String}

git リポジトリ repo 内のすべてのタグの一覧を取得します。

source
LibGit2.toggle — Function
toggle(val::Integer, flag::Integer)

val のうち、flag で指定されたビットを反転します。つまり、ビットが 0 の場合は反転後に 1 となり、その逆も同様です。

source
LibGit2.transact — Function
transact(f::Function, repo::GitRepo)

git リポジトリ repo に関数 f を適用します。f を適用する前に、snapshot を取得します。f 内でエラーが発生した場合、restore を使用して repo をスナップショットの状態に戻します。発生したエラーは再スローされますが、repo の状態は破損しません。

source
LibGit2.treewalk — Function
treewalk(f, tree::GitTree, post::Bool=false)

treeとその部分木の各エントリを、ポストオーダーまたはプレオーダーで走査します。プレオーダーでは、ルートから始め、最も左の部分木を走査します(その部分木の最も左の部分木を再帰的にたどりながら下へ進みます)。その後、部分木を右へ順にたどります。ポストオーダーでは、最も左の部分木の最下部から始めて上へたどり、次に右隣の部分木を同様に最下部から走査し、最後にツリーのルートを訪問します。

関数パラメーターfは、次のシグネチャを持つ必要があります。

(String, GitTreeEntry) -> Cint

fが負の値を返すと、ツリーの走査を停止します。正の値を返すと、postがfalseの場合、そのエントリはスキップされます。

source
LibGit2.upstream — Function
upstream(ref::GitReference)::Union{GitReference, Nothing}

ref を含むブランチに、追跡先のブランチが指定されているか確認してください。

追跡先のブランチが存在する場合は GitReference を返し、指定されたブランチに対応する追跡先がない場合は nothing を返してください。

source
LibGit2.update! — Function
update!(repo::GitRepo, files::AbstractString...)
update!(idx::GitIndex, files::AbstractString...)

インデックス idx(または repo のインデックス)内で、files によってパスが指定されたすべてのファイルを更新します。インデックス内の各ファイルの状態をディスク上の現在の状態に合わせ、ディスク上で削除されている場合はインデックスから削除し、それ以外の場合はオブジェクトデータベース内のエントリを更新します。

source
LibGit2.url — Function
url(rmt::GitRemote)

リモート Git リポジトリの fetch URL を取得します。

Examples

julia> repo_url = "https://github.com/JuliaLang/Example.jl";

julia> repo = LibGit2.init(mktempdir());

julia> remote = LibGit2.GitRemote(repo, "origin", repo_url);

julia> LibGit2.url(remote)
"https://github.com/JuliaLang/Example.jl"
source
LibGit2.with — Function
with(f::Function, obj)

リソース管理用のヘルパー関数。objに対してfを適用し、fが正常に戻るかエラーをスローした後に、objに対してcloseを必ず呼び出します。確保されたgitリソースが不要になった時点で、速やかに解放されるようにします。

source
LibGit2.with_warn — Function
with_warn(f::Function, ::Type{T}, args...)

リソース管理用のヘルパー関数。まず args から型 T のインスタンスを生成し、args に f を適用します。f が正常に戻るかエラーをスローした後、生成されたオブジェクトに対して close を必ず呼び出します。これにより、確保された Git リソースは不要になり次第、確実にファイナライズされます。f がエラーをスローした場合は、そのエラーを含む警告が表示されます。

source
LibGit2.workdir — Function
LibGit2.workdir(repo::GitRepo)

repo の作業ディレクトリの場所を返します。ベアリポジトリではエラーが発生します。

Note

通常は gitdir(repo) の親ディレクトリですが、場合によっては異なることがあります。たとえば、core.worktree 設定変数または GIT_WORK_TREE 環境変数が設定されている場合です。

関連項目: gitdir、path。

source
LibGit2.GitObject — Method
(::Type{T})(te::GitTreeEntry) where T<:GitObject

te が参照する Git オブジェクトを取得し、実際の型(entrytype に表示される型)で返します。たとえば、GitBlob や GitTag です。

Examples

tree = LibGit2.GitTree(repo, "HEAD^{tree}")
tree_entry = tree[1]
blob = LibGit2.GitBlob(tree_entry)
source
LibGit2.isfilled — Function
isfilled(cred::AbstractCredential)::Bool

認証に使用できる状態にある認証情報であることを確認します。

source
LibGit2.CredentialPayload — Type
LibGit2.CredentialPayload

同じ URL に対する認証情報コールバックの複数回の呼び出し間で状態を保持します。異なる URL で使用する場合は、CredentialPayload のインスタンスを reset! にする必要があります。

source
LibGit2.approve — Function
approve(payload::CredentialPayload; shred::Bool=true) -> nothing

今後の認証で再利用できるよう、payload 認証情報を保存します。認証に成功した場合にのみ呼び出してください。

shred キーワードは、ペイロードの認証情報フィールドに含まれる機密情報を破棄するかどうかを制御します。テスト時にのみ false に設定してください。

source
LibGit2.reject — Function
reject(payload::CredentialPayload; shred::Bool=true) -> nothing

認証に失敗した場合にのみ呼び出してください。これにより、payload の認証情報が破棄され、今後の認証で再利用されなくなります。

shred キーワードは、ペイロードの認証情報フィールドに含まれる機密情報を破棄するかどうかを制御します。テスト時にのみ false に設定してください。

source
LibGit2.Consts.GIT_CONFIG — Type

設定ファイルの優先度。

これらの優先度は、Git が設定項目を検索する際の自然な優先順位(高い順)に対応しています。

  • CONFIG_LEVEL_DEFAULT - グローバル、XDG、システムの各設定ファイルが存在する場合は、それらを開きます。
  • CONFIG_LEVEL_PROGRAMDATA - Windows では、portable git との互換性のため、システム全体に適用されます。
  • CONFIG_LEVEL_SYSTEM - システム全体の設定ファイル。Linux システムでは /etc/gitconfig
  • CONFIG_LEVEL_XDG - XDG 互換の設定ファイル。通常は ~/.config/git/config
  • CONFIG_LEVEL_GLOBAL - ユーザー固有の設定ファイル(グローバル設定ファイルとも呼ばれます)。通常は ~/.gitconfig
  • CONFIG_LEVEL_LOCAL - リポジトリ固有の設定ファイル。ベアでないリポジトリでは $WORK_DIR/.git/config
  • CONFIG_LEVEL_WORKTREE - ワークツリー固有の設定ファイル。$GIT_DIR/config.worktree
  • CONFIG_LEVEL_APP - アプリケーション固有の設定ファイル。アプリケーションが自由に定義します。
  • CONFIG_HIGHEST_LEVEL - 利用可能な設定ファイルのうち最も高い優先度を表します(つまり、実際に読み込まれる設定ファイルの中で最も具体的なもの)。
source