Ссылки

Ссылки (refs) — это именованные указатели на коммиты. Ветки, теги, HEAD и ссылки отслеживания удалённых репозиториев — всё это ссылки. Pitmaster читает ссылки из отдельных файлов, packed-refs и Reftable, а записывает в отдельные файлы и packed-refs.

RefDatabase

RefDatabase — это составной слой, который сначала ищет свободные ссылки, затем Reftable (если он есть в репозитории), а потом 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');

В связанных рабочих деревьях RefDatabase хранит HEAD и другие псевдоссылки для каждого рабочего дерева (ORIG_HEAD, MERGE_HEAD, CHERRY_PICK_HEAD, REVERT_HEAD, REBASE_HEAD, BISECT_HEAD) в каталоге git этого рабочего дерева. Ветки, теги и другие записи refs/ записываются в общий каталог, а packed-refs всегда считывается из общего каталога.

Свободные ссылки

Свободные ссылки — это отдельные файлы в .git/refs/. Каждый файл содержит шестнадцатеричный хеш целевого объекта (40 символов или 64 для SHA-256), за которым следует перевод строки.

.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 — это специальная ссылка, которая может быть:

Символьной: указывает на другую ссылку (обычно так бывает, когда выбрана ветка):

ref: refs/heads/main\n

Отсоединённой: указывает непосредственно на хеш коммита:

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

Упакованные ссылки

Файл packed-refs объединяет множество ссылок в один файл для повышения эффективности. Git создаёт его во время git pack-refs или git gc.

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

Строки, начинающиеся с ^, содержат раскрытые значения: коммит, на который в конечном счёте указывает аннотированный тег.

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

Раскрытые значения

Для аннотированных тегов файл packed-refs может содержать раскрытое значение (после разыменования) в строке после ссылки на тег. Это значение — коммит, на который в конечном счёте указывает объект тега (возможно, через несколько объектов тегов).

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

Порядок разрешения ссылок

При разрешении ссылки Pitmaster проверяет источники в таком порядке:

1. Свободная ссылка (файл в .git/refs/)
2. Reftable, если существует .git/reftable/tables.list
3. Упакованная ссылка (запись в .git/packed-refs)

Свободные ссылки имеют приоритет. При обновлении упакованной ссылки новое значение записывается как свободная ссылка (файл packed-refs не переписывается). Удаление ссылки удаляет и отдельный файл, и запись в упакованных ссылках. $repo->packRefs() переписывает packed-refs на основе текущих ссылок и удаляет отдельные файлы.

SymbolicRef

Символьные ссылки указывают на другие ссылки, а не непосредственно на объекты.

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

Журнал ссылок фиксирует изменения ссылок, позволяя git reflog показывать историю HEAD и вершин веток.

Файлы Reflog находятся в .git/logs/:

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

В каждой строке записаны:

<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 используется журнал ссылок refs/stash.

Reftable

Reftable — это более новый двоичный формат хранения ссылок, рассчитанный на повышение производительности при большом их количестве (тысячи веток). Он заменяет свободные ссылки и packed-refs.

Файлы Reftable хранятся в .git/reftable/ и содержат:

• Записи ссылок (отсортированные по имени)
• Записи журнала (записи журнала ссылок)
• Индексацию на уровне блоков для быстрого поиска

Pitmaster считывает записи ссылок из файлов Reftable, если они есть; записи журнала не считываются. Если Reftable существует, он заменяет packed-refs при перечислении ссылок. Обновления ссылок всегда записываются в отдельные файлы, которые git не считывает в репозитории с Reftable, поэтому такие репозитории следует считать доступными только для чтения.

Соглашения об именовании ссылок

Работа со ссылками через 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');