Reference

Reference so poimenovani kazalci na commite. Veje, oznake, HEAD in reference za sledenje oddaljenim repozitorijem so vse reference. Pitmaster bere reference iz nepripetih datotek, packed-refs in reftable ter zapisuje nepripete datoteke in packed-refs.

RefDatabase

RefDatabase je sestavljena plast, ki najprej išče nepripete reference, nato reftable (če ga repozitorij ima) in nazadnje 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 povezanih delovnih drevesih RefDatabase hrani HEAD in druge psevdo-reference za posamezno delovno drevo (ORIG_HEAD, MERGE_HEAD, CHERRY_PICK_HEAD, REVERT_HEAD, REBASE_HEAD, BISECT_HEAD) v imeniku git, ki pripada posameznemu delovnemu drevesu. Veje, oznake in drugi vnosi refs/ se zapišejo v skupni imenik, packed-refs pa se vedno bere iz skupnega imenika.

Nepripete reference

Nepripete reference so posamezne datoteke v .git/refs/. Vsaka datoteka vsebuje šestnajstiško zgoščeno vrednost ciljnega objekta (40 znakov ali 64 za SHA-256), ki ji sledi nova vrstica.

.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 posebna referenca, ki je lahko:

Simbolna: kaže na drugo referenco (najpogosteje, ko ste na veji):

ref: refs/heads/main\n

Odvezana: kaže neposredno na zgoščeno vrednost commita:

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

Pakirane reference

Datoteka packed-refs zaradi učinkovitosti združuje veliko referenc v eno datoteko. Git jo ustvari med git pack-refs ali git gc.

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

Vrstice, ki se začnejo z ^, so razvezane vrednosti: commit, na katerega opremljena oznaka na koncu kaže.

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

Razvezane vrednosti

Datoteka packed-refs lahko pri opremljenih oznakah vključuje razvezano vrednost v vrstici za referenco oznake. Razvezana vrednost je commit, na katerega objekt oznake na koncu kaže (prek morebitnih več objektov oznak).

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

Vrstni red razreševanja referenc

Pri razreševanju reference Pitmaster preveri po tem vrstnem redu:

1. Nepripeta referenca (datoteka v .git/refs/)
2. Reftable, če obstaja .git/reftable/tables.list
3. Pakirana referenca (vnos v .git/packed-refs)

Prednost imajo nepripete reference. Ko se pakirana referenca posodobi, se nova vrednost zapiše kot nepripeta referenca (datoteka packed-refs se ne prepiše). Brisanje reference odstrani nepripeto datoteko in pakirani vnos. $repo->packRefs() znova zapiše packed-refs iz trenutnih referenc in odstrani nepripete datoteke.

SymbolicRef

Simbolne reference so reference, ki kažejo na druge reference, ne neposredno na objekte.

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 beleži spremembe referenc, kar omogoča, da git reflog prikaže zgodovino HEAD-a in vrhov vej.

Datoteke Reflog so v .git/logs/:

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

Vsaka vrstica beleži:

<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',
);

Shramba stash uporablja reflog za refs/stash kot sklad.

Reftable

Reftable je novejša binarna oblika za shranjevanje referenc, zasnovana za boljše delovanje pri velikem številu referenc (na tisoče vej). Nadomešča nepripete reference in packed-refs.

Datoteke Reftable so shranjene v .git/reftable/ in vsebujejo:

• Zapise referenc (razvrščene po imenu)
• Zapise dnevnika (vnose refloga)
• Indeksiranje na ravni blokov za hitra iskanja

Pitmaster bere zapise referenc iz datotek reftable, kadar so na voljo; zapisov dnevnika ne bere. Ko obstaja reftable, pri naštevanju nadomesti packed-refs. Posodobitve referenc se vedno zapišejo kot nepripete datoteke, ki jih git v repozitoriju z reftable ne bere. Zato repozitorije z reftable obravnavajte kot samo za branje.

Pravila poimenovanja referenc

Delo z referencami prek 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');