Preskoči na vsebino

Podmoduli

Prikaži kot Markdown Uredi na GitHub Dokumentacija za bfe242f

Git podmoduli vgradijo en repozitorij v drugega. V nadrejenem drevesu je podmodul predstavljen kot vnos gitlink (način 160000), ki kaže na določeno potrditev v repozitoriju podmodula. URL in pot podmodula sta določena v datoteki .gitmodules.

Pojmi

V drevesu nadrejenega repozitorija:

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

Vnos gitlink beleži, katero potrditev podmodula je treba prevzeti. Dejanski repozitorij podmodula je v .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

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

Seznam podmodulov

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";
    }
}

Predmet vrednosti podmodula

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)

Razčlenjevanje .gitmodules

Datoteka .gitmodules določa konfiguracijo podmodulov:

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";
}

Razčlenjevalnik obravnava:

  • Glave razdelkov: [submodule "<name>"]
  • Pare ključ-vrednost: path = ..., url = ..., branch = ...
  • Komentarje (vrstice, ki se začnejo z #)
  • Presledke in zamike

Vnosi brez path in url so izpuščeni. Vrednosti se ne odstranijo iz narekovajev.

Vnosi gitlink so vnosi drevesa z načinom 160000. Kažejo na potrditev (ne na drevo ali blob) v repozitoriju podmodula.

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

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

Zaznavanje TreeEntry

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

Inicializacija podmodulov

PHP
$manager->init();

Za vsak podmodul, naveden v .gitmodules, se izvede naslednje:

  1. Ustvari se prazen imenik .git/modules/<name>/
  2. Ustvari se imenik na poti podmodula, če še ne obstaja
  3. V .git/config se zabeležita submodule.<name>.active = true in submodule.<name>.url

Ničesar ne pridobi ali prevzame in ne zapiše datoteke .git podmodula.

Posodabljanje podmodulov

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

Za vsak podmodul, pripet v podanem drevesu, update() kopira imenik git izvornega repozitorija v .git/modules/<name>/, zamenja delovne datoteke podmodula z datotekami iz vira, zapiše datoteko .git, ki kaže na imenik modula, nastavi core.worktree in odcepi HEAD pri pripeti potrditvi.

URL podmodula mora biti lokalna pot: absolutna ali relativna glede na delovno drevo nadrejenega repozitorija (git relativne URL-je sicer razreši glede na oddaljeni repozitorij URL nadrejenega repozitorija). URL s shemo (https://...) sproži RuntimeException('Submodule update currently supports only local paths: ...').

Po posodobitvi lahko vsak podmodul odprete kot ločen repozitorij:

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

Preverjanje pripetih potrditev

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

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

Metoda pinnedCommit() prehodi hierarhijo drevesa, da najde vnos gitlink na podani poti in vrne zgoščeno vrednost ciljne potrditve.

Stanje podmodula

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";
}

Polja stanja:

  • name: ime podmodula
  • path: pot v delovnem drevesu
  • expected: zgoščena vrednost potrditve, pripete v nadrejenem drevesu (null, če je ni)
  • actual: trenutni HEAD podmodula (null, če ni inicializiran)
  • dirty: true, kadar sta obe potrditvi znani in se razlikujeta. Spremembe v delovnem drevesu podmodula se ne preverjajo.

Struktura imenika

Koda
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

Potek dela s podmoduli

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";