Liigu sisu juurde

Viited

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: bfe242f

Viited on nimega osutid commit’idele. Harud, sildid, HEAD ja kaughoidla jälgimisviited on kõik viited. Pitmaster loeb viiteid lahtistest failidest, packed-refs-ist ja reftable’ist ning kirjutab lahtiseid faile ja packed-refs-i.

RefDatabase

RefDatabase on liitkiht, mis otsib esmalt lahtiseid viiteid, seejärel reftable’ist (kui hoidlas see olemas on) ning lõpuks packed-refs-ist.

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

Seotud tööpuude korral hoiab RefDatabase HEAD-i ja teisi tööpuupõhiseid pseudoviiteid (ORIG_HEAD, MERGE_HEAD, CHERRY_PICK_HEAD, REVERT_HEAD, REBASE_HEAD, BISECT_HEAD) tööpuu git-kataloogis. Harud, sildid ja muud refs/ kirjed kirjutatakse ühiskataloogi ning packed-refs loetakse alati ühiskataloogist.

Lahtised viited

Lahtised viited on üksikud failid asukohas .git/refs/. Iga fail sisaldab sihtobjekti kuueteistkümnendräsi (40 märki või SHA-256 korral 64), millele järgneb reavahetus.

Kood
.git/refs/heads/main           -> abc123def456...\n
.git/refs/tags/v1.0.0          -> 789012abc345...\n
.git/refs/remotes/origin/main  -> abc123def456...\n
PHP
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 on eriline viide, mis võib olla kas:

Sümboolne: osutab teisele viitele (kõige tavalisem, kui töötatakse harul):

Kood
ref: refs/heads/main\n

Eraldatud: osutab otse commit’i räsile:

Kood
abc123def456789012abc345def678901234abcd\n
PHP
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";
}

Pakitud viited

Fail packed-refs koondab tõhususe huvides palju viiteid ühte faili. Git loob selle toimingute git pack-refs või git gc käigus.

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

Märgiga ^ algavad read sisaldavad lahtipakitud väärtusi: commit’i, millele kommenteeritud silt lõpuks osutab.

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

Lahtipakitud väärtused

Kommenteeritud siltide korral võib packed-refs-fail sisaldada lahtipakitud (viidatud objektini lahendatud) väärtust sildiviitele järgneval real. Lahtipakitud väärtus on commit, millele sildiobjekt lõpuks osutab, võimalik et mitme sildiobjekti kaudu.

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

Viidete lahendamise järjekord

Viite lahendamisel kontrollib Pitmaster järgmises järjekorras:

  1. Lahtine viide (fail asukohas .git/refs/)
  2. Reftable, kui .git/reftable/tables.list on olemas
  3. Pakitud viide (kirje asukohas .git/packed-refs)

Lahtistel viidetel on eelisjärjekord. Pakitud viite uuendamisel kirjutatakse uus väärtus lahtise viitena (packed-refs-faili ei kirjutata ümber). Viite kustutamisel eemaldatakse nii lahtine fail kui ka pakitud kirje. $repo->packRefs() kirjutab kehtivate viidete põhjal packed-refs ümber ja eemaldab lahtised failid.

SymbolicRef

Sümboolsed viited osutavad teistele viidetele, mitte otse objektidele.

PHP
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 salvestab viidete muutumise, võimaldades git reflog-l kuvada HEAD-i ja haruotste ajalugu.

Reflog failid asuvad asukohas .git/logs/:

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

Iga rida salvestab järgmist:

Kood
<old-hash> <new-hash> <author> <timestamp> <tz>\t<message>
PHP
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',
);

Salvestusvirn kasutab virnasalvestusena refs/stash reflog’i.

Reftable

Reftable on uuem binaarvorming viidete salvestamiseks, loodud parema jõudluse jaoks suure viidete arvu korral (tuhanded harud). See asendab nii lahtised viited kui ka packed-refs-i.

Reftable failid salvestatakse asukohta .git/reftable/ ning sisaldavad järgmist:

  • Viitekirjeid (nime järgi sorditult)
  • Logikirjeid (reflog’i kirjed)
  • Plokitaseme indekseerimist kiireks otsinguks

Pitmaster loeb olemasolu korral reftable-failide viitekirjeid, kuid logikirjeid ei loe. Kui reftable on olemas, asendab see loendamisel packed-refs. Viidete uuendused kirjutatakse alati lahtiste failidena, mida git reftable-hoidlas ei loe, seega käsitlege reftable-hoidlaid kirjutuskaitstuna.

Viidete nimetamise kokkulepped

Muster Tähendus
refs/heads/<name> Kohalik haru
refs/tags/<name> Silt (kerge või annoteeritud)
refs/remotes/<remote>/<name> Kaugjälgitav haru
refs/stash Pinu
refs/notes/<namespace> Git märkmed
HEAD Praegune väljavõte (sümboolne või eraldatud)
FETCH_HEAD Viimase toomise tulemus (kirjutatud Giti poolt; Pitmaster fetch() seda ei kirjuta)
MERGE_HEAD Ühendatav haru (ühendamise ajal)
ORIG_HEAD Eelmine HEAD (enne ohtlikke toiminguid)

Töö viidetega Repository kaudu

PHP
// 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');