Referenser

Referenser är namngivna pekare till commits. Grenar, taggar, HEAD och fjärrspårningsreferenser är alla referenser. Pitmaster läser referenser från lösa filer, packed-refs och reftable samt skriver lösa filer och packed-refs.

RefDatabase

RefDatabase är det sammansatta lagret som först söker bland lösa referenser, sedan i reftable (om förrådet har en) och därefter i 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');

För länkade arbetskataloger håller RefDatabase HEAD och de andra pseudo-referenserna per arbetskatalog (ORIG_HEAD, MERGE_HEAD, CHERRY_PICK_HEAD, REVERT_HEAD, REBASE_HEAD, BISECT_HEAD) i arbetskatalogens egen git-katalog. Grenar, taggar och andra poster av typen refs/ skrivs till den gemensamma katalogen, och packed-refs läses alltid från den gemensamma katalogen.

Lösa referenser

Lösa referenser är enskilda filer i .git/refs/. Varje fil innehåller målobjektets hexadecimala hash (40 tecken, eller 64 för SHA-256), följt av en radbrytning.

.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 är en särskild referens som kan vara antingen:

Symbolisk: pekar på en annan referens (vanligast när man står på en gren):

ref: refs/heads/main\n

Frånkopplad: pekar direkt på en commit-hash:

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

Packade referenser

Filen packed-refs samlar många referenser i en enda fil för effektivitet. Git skapar den vid git pack-refs eller git gc.

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

Rader som börjar med ^ är avskalade värden: den commit som en annoterad tagg i slutändan pekar på.

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

Avskalade värden

För annoterade taggar kan packed-refs-filen innehålla det avskalade (derefererade) värdet på raden efter taggreferensen. Det avskalade värdet är den commit som taggobjektet till slut pekar på (möjligen via flera taggobjekt).

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

Referensers upplösningsordning

När en referens löses upp kontrollerar Pitmaster i följande ordning:

1. Lös referens (fil i .git/refs/)
2. Reftable, när .git/reftable/tables.list finns
3. Packad referens (post i .git/packed-refs)

Lösa referenser har företräde. När en packad referens uppdateras skrivs det nya värdet som en lös referens (packed-refs-filen skrivs inte om). Om en referens tas bort raderas både den lösa filen och den packade posten. $repo->packRefs() skriver om packed-refs utifrån de aktuella referenserna och tar bort de lösa filerna.

SymbolicRef

Symboliska referenser är referenser som pekar på andra referenser i stället för direkt på objekt.

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

Refloggen registrerar när referenser ändras, vilket gör att git reflog kan visa historiken för HEAD och grenarnas spetsar.

Reflog-filer finns i .git/logs/:

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

Varje rad registrerar:

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

Stashen använder refloggen för refs/stash som stacklagring.

Reftable

Reftable är ett nyare binärt format för att lagra referenser, utformat för bättre prestanda med många referenser (tusentals grenar). Det ersätter både lösa referenser och packed-refs.

Reftable-filer lagras i .git/reftable/ och innehåller:

• Referensposter (sorterade efter namn)
• Loggposter (reflogposter)
• Indexering på blocknivå för snabba sökningar

Pitmaster läser referensposterna i reftable-filer när sådana finns; loggposter läses inte. När en reftable finns ersätter den packed-refs vid listning. Referensuppdateringar skrivs alltid som lösa filer, vilket git inte läser i ett reftable-förråd, så behandla reftable-förråd som skrivskyddade.

Namnkonventioner för referenser

Arbeta med referenser via 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');