Co to znamená
Příkaz, který člověk vkládá, není řetězec, který někdo napsal do dokumentu. Jsou to čtyři pole share/distribution.yaml — příkaz ke stažení, základní URL, název skriptu a shell — složená na jednom místě:
{download_command} {base_url}/{script} | {shell}README.md, docs/INSTALL.md, úvodní stránka, stránka začínáme i vlastní nápověda instalátoru ukazují toto složení. Web a průvodce se z něj generují; README se proti němu kontroluje.
Princip
Model::install_command ho skládá, majordomus distribution show na něj odpovídá a site/data/registry/distribution.json ho nese pro šablony. Behaviorální případ test/cases/84_distribution_model.sh se modelu ptá na příkaz a vyžaduje, aby se doslova objevil v README.md a v instalační příručce.
Jak to vidět
majordomus distribution show --format json | grep install_command
bash test/run.sh 84_distribution_modelCo nepokrývá
Text kolem příkazu píší lidé a negeneruje se. Zaručeno je, že se samotný příkaz nemůže tiše lišit mezi README, průvodcem a webem — ani po změně základní URL nebo názvu skriptu.
Proč existuje
Překlep v instalačním příkazu je jedinečně drahá chyba dokumentace: selže u každého čtenáře, selže u první věci, kterou zkusí, a autor ho nevidí, protože ho nikdy nevkládá. Odvozování činí překlep nemožným; kontrola jediného dokumentu, který odvozen není, způsobí, že selže sada testů, a ne čtenář.