Ugrás a tartalomhoz

Almodulok

Megtekintés Markdownként Szerkesztés itt: GitHub Dokumentáció itt: bfe242f

Git Az almodulok egy tárolót ágyaznak egy másikba. A szülő tároló fájában az almodult egy gitlink-bejegyzés jelöli (160000 mód), amely az almodul-tároló egy adott commitjára mutat. Az almodul URL értékét és elérési útját a .gitmodules fájl deklarálja.

Fogalmak

A szülő tároló fájában:

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

A gitlink-bejegyzés rögzíti, hogy az almodul melyik commitját kell checkoutolni. Maga az almodul-tároló itt található: .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

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

Almodulok listázása

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

Almodul értékobjektum

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)

A .gitmodules feldolgozása

A .gitmodules fájl deklarálja az almodul konfigurációját:

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

A feldolgozó kezeli a következőket:

  • Szakaszfejlécek: [submodule "<name>"]
  • Kulcs-érték párok: path = ..., url = ..., branch = ...
  • Megjegyzések (# karakterrel kezdődő sorok)
  • Üres karakterek és behúzás

Azokat a bejegyzéseket, amelyekből hiányzik akár a path, akár a url, a rendszer kihagyja. Az értékekről nem távolítja el az idézőjeleket.

A gitlink-bejegyzések 160000 módú faelemek. Az almodul-tároló egy commitjára mutatnak (nem fára vagy blobra).

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

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

A TreeEntry felismerése

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

Almodulok inicializálása

PHP
$manager->init();

Minden, a .gitmodules fájlban deklarált almodul esetén a folyamat:

  1. Létrehoz egy üres .git/modules/<name>/ könyvtárat
  2. Létrehozza az almodul elérési útjához tartozó könyvtárat, ha még nem létezik
  3. Rögzíti a submodule.<name>.active = true és a submodule.<name>.url értékét a .git/config fájlban

Nem tölt le és nem checkoutol semmit, továbbá nem írja meg az almodul .git fájlját.

Almodulok frissítése

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

A megadott fában rögzített minden almodul esetén a update() átmásolja a forrás-tároló git könyvtárát ide: .git/modules/<name>/, lecseréli az almodul munkafájljait a forrás fájljaira, megírja a .git fájlt, amely a modul könyvtárára mutat, beállítja a core.worktree értékét, majd leválasztja a HEAD-et a rögzített commitnál.

Az almodul URL értékének helyi elérési útnak kell lennie: abszolútnak vagy a szülő munkafájához viszonyítottnak (a git ehelyett a relatív URL-eket a szülő távoli tárolójának URL értékéhez viszonyítva oldja fel). A sémával rendelkező URL (https://...) RuntimeException('Submodule update currently supports only local paths: ...') kivételt dob.

Frissítés után minden almodult külön tárolóként nyithat meg:

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

Rögzített commitok ellenőrzése

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

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

A pinnedCommit() metódus végigjárja a fa hierarchiáját, megkeresi a megadott útvonalon lévő gitlink-bejegyzést, majd visszaadja annak cél commit hash-ét.

Almodul állapota

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

Állapotmezők:

  • name: almodul neve
  • path: elérési út a munkafában
  • expected: a szülő fában rögzített commit hash (null, ha nincs jelen)
  • actual: az almodul aktuális HEAD-je (null, ha nincs inicializálva)
  • dirty: true, ha mindkét commit ismert és különbözik. Az almodul munkafájának módosításait nem ellenőrzi.

Könyvtárszerkezet

Kód
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

Almodul-munkafolyamat

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