Referencie

Referencie sú pomenované ukazovatele na commity. Vetvy, tagy, HEAD a vzdialené sledovacie referencie sú všetko referencie. Pitmaster číta referencie z voľných súborov, packed-refs a reftable a zapisuje voľné súbory aj packed-refs.

RefDatabase

RefDatabase je zložená vrstva, ktorá najprv vyhľadáva voľné referencie, potom reftable (ak ho repozitár obsahuje) a napokon packed-refs.

use Pitmaster\Ref\RefDatabase;

$refs = new RefDatabase($gitDir, $commonDir);

// Resolve a ref to an ObjectId
$id = $refs->resolve('refs/heads/main');

// Resolve HEAD (follows symbolic refs)
$headId = $refs->resolveHead();

// Read HEAD as a symbolic ref (null when HEAD is detached)
$symref = $refs->readHead();
echo $symref?->target;  // 'refs/heads/main'

// List all refs
foreach ($refs->list() as $name => $id) {
    echo "{$id->hex} {$name}\n";
}

// Update a ref
$refs->update('refs/heads/main', $newCommitId);

// Delete a ref
$refs->delete('refs/heads/old-branch');

Pri prepojených pracovných stromoch uchováva RefDatabase HEAD a ostatné pseudoreferencie špecifické pre pracovný strom (ORIG_HEAD, MERGE_HEAD, CHERRY_PICK_HEAD, REVERT_HEAD, REBASE_HEAD, BISECT_HEAD) v adresári git daného pracovného stromu. Vetvy, tagy a ostatné položky refs/ sa zapisujú do spoločného adresára a packed-refs sa vždy číta zo spoločného adresára.

Voľné referencie

Voľné referencie sú samostatné súbory v .git/refs/. Každý súbor obsahuje hexadecimálny hash cieľového objektu (40 znakov alebo 64 pre SHA-256) a za ním znak nového riadka.

.git/refs/heads/main           -> abc123def456...\n
.git/refs/tags/v1.0.0          -> 789012abc345...\n
.git/refs/remotes/origin/main  -> abc123def456...\n

use Pitmaster\Ref\LooseRefStore;

$store = new LooseRefStore($gitDir, $commonDir); // $commonDir defaults to $gitDir

$id = $store->resolve('refs/heads/main');
$store->update('refs/heads/main', $commitId);
$store->delete('refs/heads/old');

HEAD

HEAD je špeciálna referencia, ktorá môže byť:

Symbolická: ukazuje na inú referenciu (najčastejšie, keď sa nachádzate na vetve):

ref: refs/heads/main\n

Odpojená: ukazuje priamo na hash commitu:

abc123def456789012abc345def678901234abcd\n

use Pitmaster\Ref\SymbolicRef;

$symref = SymbolicRef::parse('HEAD', $headContent);

if ($symref !== null) {
    echo "On branch: {$symref->target}\n";
    // 'refs/heads/main'
} else {
    echo "Detached HEAD\n";
}

Zbalené referencie

Súbor packed-refs spája mnohé referencie do jedného súboru, čím zvyšuje efektívnosť. Git ho vytvára počas git pack-refs alebo git gc.

# pack-refs with: peeled fully-peeled sorted
abc123def456789012abc345def678901234abcd refs/heads/main
789012abc345def678901234abcdabc123def456 refs/tags/v1.0.0
^def456789012abc345def678901234abcdabc12

Riadky začínajúce znakom ^ obsahujú odlúpené hodnoty: commit, na ktorý anotovaný tag v konečnom dôsledku ukazuje.

use Pitmaster\Ref\PackedRefStore;

$store = new PackedRefStore($commonDir);

$id = $store->resolve('refs/heads/main');

foreach ($store->list() as $name => $id) {
    echo "{$id->hex} {$name}\n";
}

Odlúpené hodnoty

Pri anotovaných tagoch môže súbor packed-refs obsahovať odlúpenú (dereferencovanú) hodnotu na riadku za referenciou tagu. Odlúpená hodnota je commit, na ktorý objekt tagu v konečnom dôsledku ukazuje, prípadne cez viacero objektov tagov.

$peeled = $store->peeled('refs/tags/v1.0.0');
// Returns the commit ObjectId, or null if not peeled

Poradie rozlíšenia referencií

Pri rozlišovaní referencie Pitmaster kontroluje v tomto poradí:

1. Voľnú referenciu (súbor v .git/refs/)
2. Reftable, ak existuje .git/reftable/tables.list
3. Zbalenú referenciu (položku v .git/packed-refs)

Voľné referencie majú prednosť. Pri aktualizácii zbalenej referencie sa nová hodnota zapíše ako voľná referencia (súbor packed-refs sa neprepisuje). Odstránením referencie sa odstráni voľný súbor aj zbalená položka. $repo->packRefs() znovu vytvorí packed-refs z aktuálnych referencií a odstráni voľné súbory.

SymbolicRef

Symbolické referencie ukazujú na iné referencie namiesto priameho ukazovania na objekty.

use Pitmaster\Ref\SymbolicRef;

// Parse
$ref = SymbolicRef::parse('HEAD', "ref: refs/heads/main\n");
echo $ref->name;    // 'HEAD'
echo $ref->target;  // 'refs/heads/main'

// Update
$refs->updateSymbolic('HEAD', 'refs/heads/feature');

Reflog

Reflog zaznamenáva zmeny referencií a umožňuje git reflog zobrazovať históriu HEAD a vrcholov vetiev.

Súbory Reflog sa nachádzajú v .git/logs/:

.git/logs/HEAD
.git/logs/refs/heads/main
.git/logs/refs/stash

Každý riadok zaznamenáva:

<old-hash> <new-hash> <author> <timestamp> <tz>\t<message>

use Pitmaster\Ref\Reflog;

$reflog = Reflog::open($gitDir, 'HEAD');

// Read entries
$entries = $reflog->entries();
foreach ($entries as $entry) {
    echo "{$entry['old']} -> {$entry['new']}: {$entry['message']}\n";
}

// Append an entry
$reflog->append(
    $oldId,
    $newId,
    'Name <email> 1700000000 +0000',
    'commit: Add feature',
);

Zásobník stash používa reflog refs/stash na ukladanie svojich položiek.

Reftable

Reftable je novší binárny formát na ukladanie referencií, navrhnutý pre vyšší výkon pri veľkom počte referencií (tisíce vetiev). Nahrádza voľné referencie aj packed-refs.

Súbory Reftable sa ukladajú v .git/reftable/ a obsahujú:

• Záznamy referencií (zoradené podľa názvu)
• Záznamy denníka (položky reflogu)
• Indexovanie na úrovni blokov pre rýchle vyhľadávanie

Pitmaster číta záznamy referencií zo súborov reftable, ak sú dostupné; záznamy denníka sa nečítajú. Ak reftable existuje, pri výpise nahrádza packed-refs. Aktualizácie referencií sa vždy zapisujú ako voľné súbory, ktoré git v repozitári s reftable nečíta, preto považujte repozitáre s reftable za určené iba na čítanie.

Pravidlá pomenúvania referencií

Práca s referenciami cez Repository

// Read
$branch = $repo->branch();          // Current branch name
$branches = $repo->branches();      // All branch names
$tags = $repo->tags();              // All tag names
$refs = $repo->allRefs();           // All refs as name => hash

// Write
$repo->createBranch('feature');     // Create refs/heads/feature
$repo->deleteBranch('feature');     // Delete refs/heads/feature
$repo->createTag('v1.0', 'Release');// Create annotated tag
$repo->createLightweightTag('v1.0-lite'); // Create lightweight tag
$repo->updateRef('refs/heads/main', $id); // Direct ref update

// Resolve
$id = $repo->resolve('HEAD');
$id = $repo->resolve('main');
$id = $repo->resolve('v1.0.0');
$id = $repo->resolve('HEAD~3');