Odwołania

Odwołania (refs) to nazwane wskaźniki do commitów. Gałęzie, tagi, HEAD i odwołania śledzące zdalne repozytoria to odwołania. Pitmaster odczytuje odwołania z luźnych plików, packed-refs i reftable oraz zapisuje luźne pliki i packed-refs.

RefDatabase

RefDatabase to warstwa złożona, która najpierw przeszukuje luźne odwołania, następnie reftable (jeśli repozytorium z niego korzysta), a na końcu 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');

W przypadku połączonych drzew roboczych RefDatabase przechowuje HEAD i pozostałe pseudo-odwołania właściwe dla drzewa roboczego (ORIG_HEAD, MERGE_HEAD, CHERRY_PICK_HEAD, REVERT_HEAD, REBASE_HEAD, BISECT_HEAD) w katalogu git danego drzewa roboczego. Gałęzie, tagi i inne wpisy refs/ są zapisywane we wspólnym katalogu, a packed-refs jest zawsze odczytywane ze wspólnego katalogu.

Luźne odwołania

Luźne odwołania to osobne pliki w .git/refs/. Każdy plik zawiera szesnastkowy skrót obiektu docelowego (40 znaków lub 64 dla SHA-256), po którym następuje znak nowej linii.

.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 to specjalne odwołanie, które może być:

Symboliczne: wskazuje na inne odwołanie (najczęściej, gdy jesteś na gałęzi):

ref: refs/heads/main\n

Odłączone: wskazuje bezpośrednio na skrót 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";
}

Spakowane odwołania

Plik packed-refs łączy wiele odwołań w jednym pliku, aby zwiększyć wydajność. Git tworzy go podczas git pack-refs lub git gc.

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

Wartości spłaszczone to linie zaczynające się od ^: commit, na który ostatecznie wskazuje tag z adnotacją.

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

Wartości spłaszczone

W przypadku tagów z adnotacją plik packed-refs może zawierać wartość spłaszczoną (wyłuskaną) w wierszu za odwołaniem do taga. Wartość spłaszczona to commit, na który ostatecznie wskazuje obiekt taga (być może przez kilka obiektów tagów).

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

Kolejność rozwiązywania odwołań

Podczas rozwiązywania odwołania Pitmaster sprawdza kolejno:

1. Luźne odwołanie (plik w .git/refs/)
2. Reftable, jeśli istnieje .git/reftable/tables.list
3. Spakowane odwołanie (wpis w .git/packed-refs)

Luźne odwołania mają pierwszeństwo. Po zaktualizowaniu spakowanego odwołania nowa wartość jest zapisywana jako luźne odwołanie (plik packed-refs nie jest przepisywany). Usunięcie odwołania usuwa zarówno luźny plik, jak i wpis spakowany. $repo->packRefs() przepisuje packed-refs na podstawie bieżących odwołań i usuwa luźne pliki.

SymbolicRef

Odwołania symboliczne wskazują na inne odwołania, a nie bezpośrednio na obiekty.

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 zapisuje zmiany odwołań, dzięki czemu git reflog może wyświetlić historię HEAD i końców gałęzi.

Pliki Reflog znajdują się w .git/logs/:

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

Każdy wiersz zawiera:

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

Stash używa refloga refs/stash jako magazynu stosu.

Reftable

Reftable to nowszy format binarny do przechowywania odwołań, zaprojektowany z myślą o lepszej wydajności przy dużej liczbie odwołań (tysiącach gałęzi). Zastępuje zarówno luźne odwołania, jak i packed-refs.

Pliki Reftable są przechowywane w .git/reftable/ i zawierają:

• Rekordy odwołań (posortowane według nazwy)
• Rekordy dziennika (wpisy refloga)
• Indeksowanie na poziomie bloków, umożliwiające szybkie wyszukiwanie

Pitmaster odczytuje rekordy odwołań z plików reftable, jeśli są dostępne; rekordy dziennika nie są odczytywane. Gdy istnieje reftable, zastępuje ona packed-refs przy wyświetlaniu. Aktualizacje odwołań są zawsze zapisywane jako luźne pliki, których git nie odczytuje w repozytorium z reftable, dlatego repozytoria reftable należy traktować jako tylko do odczytu.

Konwencje nazewnictwa odwołań

Praca z odwołaniami za pośrednictwem 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');