Liigu sisu juurde

Alamhoidlad

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: bfe242f

Git alamhoidlad põimivad ühe hoidla teise sisse. Alamhoidlat tähistab emapuu sees gitlink-kirje (režiimiga 160000), mis viitab kindlale commitile alamhoidla hoidlas. Alamhoidla URL ja tee määratakse failis .gitmodules.

Mõisted

Emalhoidla puus:

Kood
100644 blob abc123...  README.md
040000 tree def456...  src/
160000 commit 789012... lib/external    <-- gitlink entry (submodule)

Gitlink-kirje salvestab, milline alamhoidla commit tuleks välja registreerida. Tegelik alamhoidla hoidla asub asukohas .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);

Alamhoidlate loetlemine

PHP
$submodules = $manager->list();

foreach ($submodules as $sub) {
    echo "{$sub->name}: {$sub->url} at {$sub->path}\n";
    if ($sub->branch !== null) {
        echo "  tracks branch: {$sub->branch}\n";
    }
}

Alamhoidla väärtusobjekt

PHP
use Pitmaster\Submodule\Submodule;

$sub->name;     // Submodule name (from .gitmodules section header)
$sub->path;     // Path in the working tree
$sub->url;      // Remote URL
$sub->branch;   // Tracked branch (nullable)

.gitmodules-faili parsimine

Fail .gitmodules määrab alamhoidla konfiguratsiooni:

Ini
[submodule "lib/external"]
    path = lib/external
    url = https://github.com/vendor/lib.git
    branch = main

[submodule "tools/helper"]
    path = tools/helper
    url = https://github.com/vendor/helper.git
PHP
$content = file_get_contents('.gitmodules');
$submodules = SubmoduleManager::parseGitmodules($content);

foreach ($submodules as $sub) {
    echo "{$sub->name} -> {$sub->url}\n";
}

Parser käsitleb järgmist:

  • Jaotiste päised: [submodule "<name>"]
  • Võti-väärtus paarid: path = ..., url = ..., branch = ...
  • Kommentaarid (read, mis algavad märgiga #)
  • Tühikud ja taanded

Kirjed, millel puudub kas path või url, jäetakse vahele. Väärtusi ei eemaldata jutumärkidest.

Gitlink-kirjed on režiimiga 160000 puukirjed. Need viitavad alamhoidla commitile (mitte puule ega plokile).

PHP
$tree = $repo->readObject($treeHash);

foreach ($tree->entries as $entry) {
    if ($entry->isGitlink()) {
        echo "Submodule at {$entry->name}: commit {$entry->hash->hex}\n";
    }
}

TreeEntry tuvastamine

PHP
$entry->isGitlink();  // true if mode is '160000'
$entry->mode;         // '160000'

Alamhoidlate lähtestamine

PHP
$manager->init();

Iga asukohas .gitmodules deklareeritud alamhoidla puhul tehakse järgmist:

  1. Loob tühja kataloogi .git/modules/<name>/
  2. Loob alamhoidla tee kataloogi, kui seda pole olemas
  3. Salvestab väärtused submodule.<name>.active = true ja submodule.<name>.url asukohta .git/config

See ei hangi ega registreeri midagi välja ning ei kirjuta alamhoidla faili .git.

Alamhoidlate uuendamine

PHP
$manager->update($repo->head()->tree);

Iga antud puus fikseeritud alamooduli puhul kopeerib update() lähteteegi git kataloogi asukohta .git/modules/<name>/, asendab alamooduli tööfailid lähtefailidega, kirjutab mooduli kataloogile osutava faili .git, määrab väärtuse core.worktree ja lahutab HEAD-i fikseeritud sissekande juures.

Alamooduli URL peab olema kohalik tee: absoluutne või vanema tööpuu suhtes suhteline (git lahendab suhtelised URL-id hoopis vanema kaugallika URL põhjal). Skeemiga URL (https://...) viskab RuntimeException('Submodule update currently supports only local paths: ...').

Pärast uuendamist saate iga alamhoidla avada eraldi hoidlana:

PHP
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');

Fikseeritud commitide kontrollimine

PHP
$headCommit = $repo->head();
$pinnedId = $manager->pinnedCommit('lib/external', $headCommit->tree);

if ($pinnedId !== null) {
    echo "lib/external is pinned to commit {$pinnedId->hex}\n";
}

Meetod pinnedCommit() läbib puuhierarhia, leiab antud teel gitlink-kirje ja tagastab selle sihtcommiti räsi.

Alamhoidla olek

PHP
$headCommit = $repo->head();
$statuses = $manager->status($headCommit->tree);

foreach ($statuses as $status) {
    $expected = $status['expected'] ?? 'not pinned';
    $actual = $status['actual'] ?? 'not initialized';
    $dirty = $status['dirty'] ? ' (dirty)' : '';

    echo "{$status['name']}: expected={$expected}, actual={$actual}{$dirty}\n";
}

Olekuväljad:

  • name: alamhoidla nimi
  • path: tee tööpuus
  • expected: emapuus fikseeritud commiti räsi (null, kui seda pole)
  • actual: alamhoidla praegune HEAD (null, kui see pole lähtestatud)
  • dirty: tõene, kui mõlemad commitid on teada ja erinevad. Muudatusi alamhoidla tööpuus ei kontrollita.

Kataloogistruktuur

Kood
project/
  .git/
    modules/
      lib/
        external/          # Submodule's actual git directory (.git/modules/<name>)
        HEAD
        objects/
        refs/
        ...
  .gitmodules              # Submodule declarations
  lib/
    external/
      .git                 # File: "gitdir: ../../.git/modules/lib/external"
      src/
      README.md
  src/
  README.md

Alamhoidla töövoog

PHP
// 1. Open the parent repo
$repo = Pitmaster::open('/path/to/project');

// 2. List submodules
$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);

$submodules = $manager->list();

// 3. Populate the submodules pinned at HEAD (local source paths only)
$manager->update($repo->head()->tree);

// 4. Check status
$statuses = $manager->status($repo->head()->tree);

// 5. Open a submodule as its own repo
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');
$subHead = $subRepo->head();
echo "Submodule HEAD: {$subHead->id->hex}\n";