# Příručka k JHBuild

James
Henstridge
C.J.
Adams-Collier
Frederic
Peters
David
Turner
2004, 2008
James Henstridge
Příručka v0.5 k JHBuild
leden 2008
Příručka v0.1 k JHBuild
srpen 2007

JHBuild je nástroj pro sestavení celého uživatelského prostředí GNOME z systému správy verzí. JHBuild může být také uzpůsoben k sestavení jiných projektů.

## Úvod

JHBuild je nástroj navržený ke snadnému sestavení sbírky zdrojových balíčků nazývaných moduly. JHBuild používá soubory se sadami modulů k popisu modulů dostupných k sestavení. V těchto souborech jsou uvedené i informace o závislostech, díky kterým může JHBuild zjistit, které moduly jsou zapotřebí k sestavení a v jakém pořadí.

JHBuild byl původně napsán pro sestavování GNOME, ale časem byl rozšířen tak, aby se dal použít i s jinými projekty. Soubor se sadou modulů může být umístěn na webovém serveru, takže pravidla pro sestavení jsou nezávislá na projektu JHBuild.

JHBuild umí sestavit moduly z různých typů zdrojů, včetně repozitářů CVS, Subversion, Bazaar, Darcs, Git a Mercurial a rovněž archivů Tar a Zip umístěných na webu nebo FTP. JHBuild umí moduly sestavit pomocí různých sestavovacích systémů, včetně Autotools, CMake, Meson, WAF, Python Distutils a Perl Makefiles.

JHBuild není míněn jako náhrada za systém správy balíčků v distribuci, ale usnadňuje sestavení softwaru do oddělených složek, aby nedocházelo k vzájemnému ovlivňování se zbytkem systému.

## Začínáme

Než JHBuild můžete použít k sestavení softwaru, potřebuje projít pár kroků nastavení. JHBuild předpokládá pro svoji činnost přítomnost některého softwaru a je nutné nainstalovat nezbytné nástroje pro získávání a sestavování softwarových modulů.

### Instalace JHBuildu

JHBuild requires a Python runtime. Verify Python >= 3.5 is installed.

Doporučeným způsobem, jak stáhnout JHBuild, je přes systém správy verzí `Git`. To můžete udělat následujícím příkazem. Je také doporučeno spustit příkaz z nové složky, kde budou nainstalovány všechny zdrojové kódy, například `~/jhbuild/checkout`.

    $ git clone https://gitlab.gnome.org/GNOME/jhbuild.git
    …
    $

Tím se stáhne JHBuild do nové složky s názvem `jhbuild` v aktuální složce. Nyní JHBuild sestavte a nainstalujte:

    $ cd jhbuild
    $ ./autogen.sh
    …
    $ make
    …
    $ make install
    …
    $

V případě, že jsou dostupné gnome-common, yelp-tools a autotools, `autogen.sh` nakonfiguruje JHBuild pro instalaci skrze autotools. V případě, že dostupné nejsou, nakonfiguruje `autogen.sh` JHBuild pro instalaci skrze prostý Makefile. Jestli chcete použít prostý Makefile vždy, předejte skriptu `autogen.sh` volbu `--simple-install`.

Když předchozí kroky proběhnou úspěšně, nainstaluje se do `~/.local/bin` malý shellový skript pro spuštění JHBuildu. Přidejte `~/.local/bin` do `PATH`:

    $ PATH=$PATH:~/.local/bin
    $

Pro trvalé přidání `~/.local/bin` do proměnné `PATH` spusťte následující příkaz:

    $ echo 'PATH=$PATH:~/.local/bin' >> ~/.bashrc
    $

### Nastavení JHBuildu

JHBuild se nastavuje pomocí souboru s nastavením. Jeho výchozí umístění je `~/.config/jhbuildrc`. Pokud neexistuje, je vytvořen výchozí. Soubor s nastavením používá syntax jazyka Python. K dispozici je ukázkový soubor, viz `examples/sample.jhbuildrc`. Ten si zkopírujte do složky `~/.config/jhbuildrc` a přizpůsobte si jej svým potřebám.

Ukázkový soubor přiměje JHBuild sestavit moduly meta-gnome-core a meta-gnome-apps-tested a závislosti ze sady modulů gnome-apps. JHBuild rozbalí strom zdrojových kódů do `~/jhbuild/checkout/` a nainstaluje všechny soubory do podsložek v `~/jhbuild/install/`. Obě složky musí být zapisovatelné.

Proměnné v nastavení jsou zdokumentované v kapitole . K nejčastěji používaným proměnným patří:

`repos`

  Slovník, který lze použít k určení umístění alternativního repozitáře. Tato proměnná nastavení je užitečná pro vývojáře modulů. Ve výchozím stavu stahuje JHBuild kód z repozitářů pomocí umístění anonymního repozitáře. Klíči slovníku jsou názvy repozitářů a hodnotami jsou umístění alternativních repozitářů. Například:

      repos['git.gnome.org'] = 'ssh://uživatelské_jméno@git.gnome.org/git/'

`moduleset`

  Řetězec (nebo seznam řetězců) specifikující název sady modulů (nebo názvy sad modulu), které se mají použít. Název může být dán buď název souboru se sadou modulů, která je součástí JHBuildu (cestu a příponu vynechejte) nebo plnou adresou HTTP URL k externě spravované sadě modulů. Externí sada modulů bude uložena v mezipaměti. Pokud se modul se stejným názvem objeví ve více sadách modulů, získá přednost poslední uvedený. Sady modulů zahrnuté přímo v JHBuildu jsou aktualizované, aby odpovídaly aktuálnímu vývojovému vydání GNOME.

`modules`

  Seznam řetězců určujících moduly k sestavení. Seznam skutečně sestavených modulů bude rekurzivně rozvinut, aby pokryl všechny závislosti, vyjma situace, kdy je použit příkaz `buildone`. Výchozí hodnota je `['meta-gnome-desktop']`.

`checkoutroot`

  Řetězec určující složku pro rozbalení stromu se zdrojovými kódy. Pokud je proměnná `buildroot` nastavené na `None`, objeví se v této složce i sestavení. Výchozí hodnotou je `~/jhbuild/checkout`.

`prefix`

  Řetězec určující prefix cesty, do které se mají instalovat moduly. Musí se jednat o absolutní cestu a složka musí být zapisovatelná. Výchozí hodnota je `'~/jhbuild/install/'`.

`autogenargs`

  Řetězec obsahující argumenty, která se předají skriptu `autogen.sh` u všech modulů. Pro konkrétní moduly může být přepsáno pomocí slovníku `module_autogenargs`.

`cmakeargs`

  Řetězec obsahující argumenty, které se předají příkazu `cmake` u všech modulů. Pro konkrétní moduly může být přepsáno pomocí slovníku `module_cmakeargs`.

`makeargs`

  Řetězec uvádějící dodatečné argumenty, které se předají příkazu `make`. JHBuild automaticky připojuje volbu pro paralelní provádění (`-j`) vycházející z počtu jader dostupných v procesoru. Výchozí hodnota je `''`.

`mesonargs`

  Řetězec obsahující argumenty, která se předají pro příkazu `meson` u všech modulů. Pro konkrétní moduly může být přepsáno pomocí slovníku `module_mesonargs`.

`ninjaargs`

  Řetězec uvádějící dodatečné argumenty, které se předají příkazu `ninja`. Výchozí je `''`.

### Předpoklady pro sestavení

Než může být vůbec nějaký modul sestaven, je nutné mít nainstalované určité nástroje. V závislosti na tom, který modul sestavujete, patří mezi běžné nástroje pro sestavení GNU Autotools (autoconf, automake, libtool a gettext), GNU Toolchain (binutils, gcc, g++), make, pkg-config a Python.

JHBuild umí pomocí příkazu `sanitycheck` zkontrolovat, jestli jsou nástroje nainstalované:

    $ jhbuild sanitycheck

V případě, že tento příkaz zobrazí nějakou zprávu, nainstalujte prosím požadovaný balíček z repozitáře své distribuce. Seznam názvů balíčků pro různé distribuce je udržován v rámci wiki projektu GNOME. Po nainstalování distribučního balíčku spusťte příkaz `sanitycheck` znovu, abyste si ověřili, že jsou požadované nástroje přítomny.

### Používání JHBuildu

Když je nastavené dokončené, je možné použít JHBuild k sestavení softwaru. Pro sestavené všech modulů vybraných v souboru `~/.config/jhbuildrc` spusťte následující příkaz:

    $ jhbuild build

JHBuild stáhne, nakonfiguruje, zkompiluje a nainstaluje jednotlivé moduly. V případě, že se objeví v kterémkoliv kroku chyba, zobrazí vám JHBuild nabídku dotazující se co dál. Na výběr máte mimo jiné přepnout se do shellu, abyste mohli chybu opravit, znovu spustit sestavení z různých kroků, vzdát sestavení modulu nebo chybu ignorovat a pokračovat.

Pokud sestavení modulu vzdáte, způsobí to, že selže sestavení všech závisejících modulů.

Níže je příklad zobrazené nabídky:

      [1] Znovu spustit krok sestavení
      [2] Ignorovat chybu a pokračovat k instalaci
      [3] Vzdát práci s modulem
      [4] Spustit shell
      [5] Znovu načíst nastavení
      [6] Přejít ke kroku „vyčistit složku a spustit znovu“
      [7] Přejít ke kroku „configure“
      [8] Přejít ke kroku „clean“
      [9] Přejít ke kroku „distclean“
    volba:

Je také možné sestavit jinou sadu modulů, a jejich závislostí, předáním názvů modulů jako argument příkazu `build`. Například pro sestavení gtk+:

    $ jhbuild build gtk+

Když je JHBuild přerušen v některé části sestavení, je možné pokračovat v sestavení od konkrétního modulu pomocí volby `--start-at`:

    $ jhbuild build --start-at=pango

Pro sestavení jednoho nebo více modulů s ignorováním jejich závislostí poskytuje JHBuild příkaz `buildone`. Aby byl příkaz `buildone` dokončen úspěšně, musí být všechny závislosti sestavené dopředu a nainstalované nebo poskytnuté v balíčcích distribuce.

    $ jhbuild buildone gtk+

Když aktivně vyvíjíte některý modul, nejspíše budete v pracovní složce se zdrojovými kódy. Příkaz `make` spustí systém sestavení a nainstaluje modul. To bude klíčovou částí vašeho cyklu upravit-zkompilovat-nainstalovat-otestovat.

    $ jhbuild make

Abyste získali seznam modulů a závislostí, které bude JHBuild sestavovat, a v jakém pořadí je bude sestavovat, použijte příkaz `list`:

    $ jhbuild list

K získání informací a konkrétním modulu použijte příkaz `info`:

    $ jhbuild info gtk+

Ke stažení nebo aktualizaci všech zdrojů softwaru, aniž by se sestavily, použijte příkaz `update`. Tím získáte příležitost upravit zdrojové kódy před jejich sestavením a hodí se to i při připojení k Internetu s proměnlivou kvalitou.

    $ jhbuild update

Později může JHBuild sestavit vše bez potřeby stahovat nebo aktualizovat zdrojové kódy:

    $ jhbuild build --no-network

Ke spuštění konkrétního příkazu se stejným prostředím, jako používá JHBuild, použijte příkaz `run`:

    $ jhbuild run program

Ke spuštění shellu se stejným prostředím, jako používá JHBuild, použijte příkaz `shell`:

    $ jhbuild shell

## JHBuild a GNOME

Tento část poskytuje návod k sestavení, instalaci a spuštění GNOME.

### Sestavení GNOME

Pro sestavení GNOME jsou vyžadovány některé vývojářské balíčky. Patří k nim:

- XML DTD DocBook a stylopisy XSLT. Musí být zaregistrované v katalogu XML (`/etc/xml/catalog`)

- Knihovny X.

- `libsmbclient` z projektu Samba (použito k procházení sítí Windows)

- `libbz2` z bzip2

- `libpng`, `libjpeg` a `libtiff` (použito k načítání obrázků)

Když instalujete distribuční balíčky, nainstalujte odpovídající balíčky dev nebo devel, pokud je to tímto způsobem zavedené ve vaší distribuci. Seznam názvů balíčků je udržován v rámci wiki v projektu GNOME.

### Spuštění jedné aplikace z GNOME

Tato část podrobněji rozebírá, jak spustit jednotlivou aplikaci GNOME. Tato aplikace bude spuštěna v rámci aktuálního pracovního prostředí. Jak spustit aplikaci v rámci GNOME celého sestaveného v JHBuildu viz oddíl .

Spusťte shell z JHBuildu. Bude mít nastavené všechny potřebné proměnné prostředí.

    $ jhbuild shell

Ověřte, že bude spuštěna správná aplikace. Například:

    $ which gedit
    /home/wanda/jhbuild/install/bin/gedit

Spusťte aplikaci:

    $ gedit &

Případně spusťte aplikaci pomocí příkazu `run`:

    $ jhbuild run gedit

### Spuštění uživatelského prostředí GNOME

Vytvořte nový uživatelský účet pro běh GNOME sestaveného v JHBuildu. Běh pod jiným uživatelským účtem je doporučován, aby se předešlo problémům způsobeným nastaveními uloženými v domovské složce. Tato příručka v textech pro ilustrační účely používá účet s názvem gnomedev.

Nastavte JHBuild pro nový účet gnomedev. Zkopírujte do domovské složky gnomedev soubory `~/.config/jhbuildrc` a `~/.local/bin/jhbuild`, nebo pro ně vytvořte symbolické odkazy.

Otevřete terminál jako uživatel gnomedev. Trvale přidejte `~/.local/bin` do proměnné `PATH` následujícím příkazem:

    $ echo 'PATH=$PATH:~/.local/bin' >> ~/.bashrc

Otestujte, že JHBuild funguje:

    $ jhbuild run pkg-config gtk+-2.0 --modversion
    2.20.1

#### Nastavení GNOME pro spuštění ze správce zobrazení

Sestavte a nainstalujte GNOME pomocí JHBuildu.

Povolte systémové služby. GNOME používá systémového démona D-Bus z `/usr/bin` a systémové služby z `/usr/share/dbus-1/system-services/`. GNOME z JHBuildu bude používat démona D-Bus ze sezení JHBuild a služby z `~/jhbuild/install//share/dbus-1/services/`. V následujícím příkazu nahreďte `~/jhbuild/install` instalačním prefixem GNOME z proměnné `prefix`:

    $ rm -rf ~/jhbuild/install/var/run/dbus
    $ ln -s /var/run/dbus ~/jhbuild/install/var/run/dbus
    $ rm -rf ~/jhbuild/install/var/lib/dbus/machine-id
    $ ln -s /var/lib/dbus/machine-id ~/jhbuild/install/var/lib/dbus/machine-id

Vytvořte spouštěcí skript pro GNOME v `/usr/bin/gnome-jhbuild-session` následujícím způsobem (`~/jhbuild/install` nahraďte instalačním prefixem GNOME z proměnné `prefix`):

    #!/bin/sh

    GNOME=~/jhbuild/install

    GDK_USE_XFT=1
    XDG_DATA_DIRS=$XDG_DATA_DIRS:$GNOME/share
    XDG_CONFIG_DIRS=$XDG_CONFIG_DIRS:$GNOME/etc/xdg

    jhbuild run gnome-session

Nastavte soubor `/usr/bin/gnome-jhbuild-session`, aby byl spustitelný:

    $ chmod a+x /usr/bin/gnome-jhbuild-session

Pro vytvoření záznamu nového sezení ve správci zobrazení vytvořte soubor `/usr/share/xsessions/gnome-jhbuild.desktop` a zadejte do něj:

    [Desktop Entry]
    Name=GNOME (JHBuild)
    Comment=This session logs you into GNOME testing session
    TryExec=/usr/bin/gnome-jhbuild-session
    Exec=/usr/bin/gnome-jhbuild-session
    Icon=
    Type=Application

Restartujte `gdm`.

#### Spuštění GNOME ze správce zobrazení

Abyste spustili GNOME sestavené v JHBuildu, nejdříve ve správci zobrazení vyberte sezení GNOME (JHBuild) a pak teprve zadejte přihlašovací údaje uživatele gnomedev. Po úspěšném přihlášení se zobrazí správné prostředí GNOME. Pokud přihlášení není úspěšné, podívejte se do souboru se záznamem. Ten najdete v `~gnomedev/.cache/gdm/session.log` nebo v `~gnomedev/.xsession-errors`.

### Statická analýza

JHBuild podporuje spuštění statické analýzy na kód v sestavovaných modulech. Tuto možnost zapnete nastavením proměnné `static_analyzer` v souboru nastavení `.jhbuildrc` na `True`.

Po zapnutí se při každém sestavení modulu pomocí JHBuildu zavolá nad sestavením statický analyzátor, který vygeneruje zprávu o problémech, které našel v kódu. Tato zpráva se uloží jako soubory HTML v podsložkách složky `/tmp/jhbuild_static_analyzer` (ve výchozím stavu, ale cestu lze změnit pomocí proměnné nastavení `static_analyzer_outputdir`).

Statická analýza v současnosti funguje jen pro moduly používající autotools jako svůj systém pro sestavení. Vyžaduje to mít nainstalovaný program `scan-build`, i když příkaz, který se má k tomu používat, je možné změnit pomocí proměnné `static_analyzer_template` v nastavení.

## Příručka k příkazům

JHBuild používá syntax příkazového řádku podobnou nástrojům, jako je CVS:

    jhbuild globalni_volby prikaz argumenty_prikazu

Globální volby JHBuildu jsou:

`-f`, `--file` nastavení

  Použít alternativní soubor s nastavením namísto výchozího `~/.config/jhbuildrc`.

`-m`, `--moduleset` sada_modulů

  Použít jinou sadu modulů, než je uvedena v souboru s nastavením. Touto volbou může být relativní cesta, když se sada modulů nachází ve složce pro sadu modulů JHBuild, nebo absolutní cesta, když jsou umístěny kdekoliv jinde.

`--no-interact`

  Nepožadovat od uživatele žádný vstup. Tato volba se hodí pro bezobslužné sestavení, aby se zajistilo že postup nebude přerušen.

`--exit-on-error`

  Skončit hned, jakmile sestavení některého modulu selže. Tato volba se hodí primárně pro neinteraktivní režim, aby se zajistilo, že jhbuild nebude pokračovat v sestavení žádného dalšího modulu.

`--conditions`

  Změnit podmínečné příznaky, aby byly jiné, než ty, které jsou určené podle operačního systému, a ty, které jsou určené v jhbuildrc. Změny se určují stylem `-wayland` nebo `+docs` pro odebrání nebo přidání podmínky. Více změn můžete oddělit čárkou (`--conditions=+docs,-wayland`) nebo rozdělit do více argumentů `--conditions`.

Navíc JHBuild kontroluje přítomnost a hodnoty následujících proměnných prostředí:

`JHBUILD_RUN_AS_ROOT`

  Standardně se JHBuild nespustí pod uživatelem root, aby předešel případným destruktivním operacím, které mohou ovlivnit celý systém. V některých konkrétních případech je ale spuštění pod uživatelem root přijatelné, například uvnitř kontejneru nebo při průběžné integraci prostředí. Vyexportováním `JHBUILD_RUN_AS_ROOT` se kontrola uživatele při spouštění vypne.

Volby specifické pro jednotlivé příkazy jsou uvedeny níže.

### autobuild

Příkaz `autobuild` automaticky sestaví moduly, tak jak jsou uvedeny v souboru s nastavením, a následně nahraje výsledky do JhAutobuild.

    jhbuild autobuild --autogen --clean --distcheck --skip=modul --start-at=modul --report-url=url_výstupní_zpravy --verbose

Volby `--autogen`, `--clean`, `--distcheck`, `--skip` a `--start-at` jsou zpracovány pro jednotlivé příkazy `build`.

`--report-url=url_výstupní_zpravy`, `-r url_výstupní_zpravy`

  Tato volba určuje adresu URL JhAutobuild, na kterou se má podat výstupní zpráva.

`--verbose`, `-v`

  Když je zadáno, bude výstup z JHBuild mnohem podrobnější.

### bootstrap

Příkaz `bootstrap` nainstaluje sadu sestavovacích nástrojů. K těm patří autoconf, automake a podobné nástroje. Doporučeným způsobem instalace sestavovacích nástrojů je použití systému správy balíčků v distribuci. Příkaz bootstrap by se tak měl používat jen v případě, že tyto nástroje nejsou v systému správy balíčků vaší distribuce poskytovány, například na Mac OS.

    jhbuild bootstrap

Příkaz `bootstrap` sestaví moduly pomocí stejné metody jako příkaz `build`, ale použije sadu modulů `bootstrap.modules`.

Dostupné volby viz dokumentace k příkazu `build`.

### build

Příkaz `build` sestaví jeden nebo více balíčků, včetně jejich závislostí.

    jhbuild build --autogen --clean --check --dist --distcheck --distclean --ignore-suggests --no-network --skip=modul --start-at=modul --tags=štítky -D datum --no-xvfb --try-checkout --no-poison --force --build-optional-modules --min-age=čas --nodeps modul

Když není na příkazovém řádku předán žádný název modulu, použije se seznam modules z nastavení.

`-a`, `--autogen`

  Před sestavením modulů vždy spustit `autogen.sh`.

`-c`, `--clean`

  Před sestavením modulů spustit příkaz `make clean`.

`--check`

  Po sestavení modulů spustit příkaz `make check`.

`-d`, `--dist`

  Po sestavení modulů spustit příkaz `make dist` .

`--distcheck`

  Po sestavení modulů spustit příkaz `make distcheck`.

`--distclean`

  Pro moduly ze systému Git před sestavením spustit `git clean -dfx`. Pro ostatní moduly před sestavením spustit `make distclean`.

  Tato volba smaže všechny nezařazené změny.

`--ignore-suggests`

  Nesestavovat měkké závislosti.

`-n`, `--no-network`

  Při sestavování nepřestupovat do sítě. Tím se přeskočí kroky stahování a aktualizace. Pokud modul nelze bez přístupu do sítě sestavit, jeho sestavení selže.

`-s`, `--skip`=modul,…

  Nesestavovat uvedené moduly. Používá se k přeskočení sestavení zadaných závislostí.

`--tags`=štítek,…

  Ignorovat moduly, které nevyhovují štítku tag. Moduly jsou automaticky označené štítkem odpovídajícím názvu jejich sady modulů.

`-t`, `--start-at`=modul

  Začít v modulu se zadaným názvem, než aby se začínalo od začátku seznamu. Tato volba se hodí, když před tím došlo k přerušení sestavování.

`-D` datum

  Pokud je to podporováno systémem správy verzí v pozadí, aktualizuje se před sestavením strom se zdrojovými kódy na konkrétní datum. Požadován je formát data podle ISO, např. `"2009-09-18 02:32Z"`.

`-x`, `--no-xvfb`

  Spustit grafický test na současném X serveru, místo v simulovaném Xvfb.

`-C`, `--try-checkout`

  Když sestavení selže, a je to podporováno systémem správy verzí, před opětovným pokusem o sestavení se vynuceně stáhne a spustí `autogen.sh`.

`-N`, `--no-poison`

  I když selže jedna nebo více závislostí modulu, tato volba přinutí JHBuild, aby modul i tak zkusil sestavit.

`-f`, `--force`

  Sestavit moduly, i když zásady říkají, že to není zapotřebí.

`--build-optional-modules`

  Moduly uvedené ve volitelných závislostech nemusí být k sestavení modulu nutně zapotřebí. Tato volba přinutí JHBuild volitelné závislosti sestavit.

`--min-age`=čas

  Přeskočit moduly nainstalované dříve, že je určený relativní čas. Řetězec time je ve formě čísla následovaného jednotkou. Podporované jsou následující jednotky: sekundy (s), minuty (m), hodiny (h) a dny (d). Například `--min-age=2h` přeskočí moduly sestavené před méně jak dvěma hodinami.

`--nodeps`

  Ignorovat chybějící systémové závislosti. Pro ignorován jedné konkrétní závislosti přidejte daný modul do `skip`.

### make

Příkaz `make` je pro aktivní vývoj u konkrétního modulu. Vyžaduje, aby v aktuální složce byly stažené zdrojové kódy a není to to stejné, jako `buildone -nf $(basename $(pwd))`.

    jhbuild make --clean --check --distcheck --quiet

Tyto volby jsou stejné, jako volby dostupné pro příkaz `buildone`.

### buildone

Příkaz `buildone` je podobný příkazu `build`, ale nestavuje závislé moduly. To se hodí pro sestavení jednoho nebo pár konkrétních modulů.

    jhbuild buildone --autogen --clean --check --distcheck --distclean --no-network -D datum --no-xvfb --force --min-age=čas --nodeps modul

Volby `--autogen`, `--check`, `--clean`, `-d`, `--distcheck`, `--distclean`, `--no-network`, `-D`, `-x` a `--nodeps` jsou zpracovány pro jednotlivé příkazy `build`.

Na příkazovém řádku musí být uveden aspoň jeden modul.

### checkbranches

Příkaz `checkbranches` zkontroluje, jestli jsou v systému správy verzí správně nadefinované větve a jestli jsou konzistentní se sadou modulů.

    jhbuild checkbranches --branch=větev

`--branch`=větev, `-b` větev

  Větev, která se má kontrolovat.

    $ jhbuild -m gnome-2.20 checkbranches
    Modulu libgnomecanvas schází definice větve pro větev gnome-2-20
    $

### clean

Příkaz `clean` vyčistí složku sestavení jednoho nebo více modulů.

    jhbuild clean --skip=modul --start-at=modul

Když není na příkazovém řádku předán žádný název modulu, použije se seznam modules z nastavení.

Popis dostupných voleb viz dokumentace k příkazu `build`.

### dot

Příkaz `dot` vygeneruje soubor popisující orientovaný graf tvořený závislostmi mezi sadami modulů. Tento soubor lze následně zpracovat pomocí softwaru GraphViz do podoby výsledného grafu.

    jhbuild dot --soft-deps --clusters modul

Když není na příkazovém řádku předán žádný název modulu, použije se seznam modules z nastavení.

Volba `--soft-deps` přidá tečkované čáry z modulů do měkkých závislostí. Volba `--clusters` seskupí moduly z metamodulů dohromady.

Výstup z příkazu `dot` můžete propojit rourou s nástrojem dot, který vygeneruje postskriptový soubor:

    $ jhbuild dot modules | dot -Tps > závislosti.ps

Nebo obrázek PNG:

    $ jhbuild dot modules | dot -Tpng > závislosti.png

#### Ukázka výstupu příkazu dot v JHBuild

### gui

Příkaz `gui` spustí grafické uživatelské rozhraní JHBuild, které můžete použit k výběru modulů pro sestavení a ke změně některých voleb.

    jhbuild gui

Grafické rozhraní je vykreslováno pomocí GTK, takže jsou zapotřebí některé další podpůrné knihovny.

### info

Příkaz `info` zobrazí informace o jednom nebo více modulech.

    jhbuild info --installed modul

Příkaz zobrazí název modulu, jeho typ, závislosti, závislé balíčky, složku se zdrojovými kódy a čas, kdy byl naposledy nainstalován pomocí JHBuildu. Pokud jsou dostupné, zobrazí se také informace specifické pro daný modul, jako třeba repozitář CVS nebo URL pro stažení.

Když není žádný modul určen, zobrazí příkaz informace o všech modulech definovaných v sadě modulů.

V případě, že je uvedena volba `--installed`, bude výstup filtrován jen na nainstalované balíčky. Výsledný výstup bude obsahovat jen moduly, které jsou aktuálně sestavené a nainstalované pomocí JHBuildu. Výstup nezahrnuje systémové závislosti.

Pokud je u volby `--installed` uveden i jeden nebo více názvů modulů, jsou vypsány jen nainstalované moduly (bez systémových závislostí). V případě, že aspoň jeden ze zadaných modulů není nainstalován, skončí příkaz s návratovou hodnotou 1.

### list

Příkaz `list` zobrazí rozvinutý seznam modulů, které by příkaz `build` sestavil.

    jhbuild list -a -r -s --start-at=modul --tags=štítky --ignore-suggests --list-optional-modules modul

Když není na příkazovém řádku předán žádný název modulu, použije se seznam modules z nastavení.

Volby `--skip`, `--start-at`, `--tags` a `--ignore-suggests` jsou zpracovány pro jednotlivé příkazy `build`.

`-a`, `--all-modules`

  Vypsat všechny moduly ze sady modulů, bez ohledu na závislosti sestavení.

`-r`, `--show-revision`

  Když má modul nastavenou větev, zobrazit u názvu modulu i název větve.

`--list-optional-modules`

  Tato volba přinutí JHBuild vypsat volitelné závislosti.

### rdepends

Příkaz `rdepends` zobrazí zpětné závislosti modulu.

    jhbuild rdepends modul

`--dependencies`

  Vedle modulů zobrazit cestu závislosti.

`--direct`

  Omezit zobrazení na moduly bezprostředně závisející na zadaném modulu.

### run

Příkaz `run` spustí zadaný příkaz v tom stejném prostředí, které používá JHBuild, když sestavuje moduly.

    jhbuild run --in-builddir --in-checkoutdir PROGRAM ARGUMENT

Když se JHBuild používá k sestavení GNOME, může se tento příkaz hodit ve skriptech spouštějících X server.

`--in-builddir`=modul

  Spustit příkaz ve složce sestavení zadaného modulu.

`--in-checkoutdir`=modul

  Spustit příkaz ve zdrojové složce zadaného modulu.

### sanitycheck

Příkaz `sanitycheck` provede řadu kontrol, aby ověřil, že je prostředí pro sestavení v pořádku.

    jhbuild sanitycheck

Součástí kontrol bude mimo jiné:

- Jestli složka pro stažení a složka daná instalačním prefixem jsou zapisovatelné.

- Jestli jsou nainstalované požadované nástroje.

- Jestli jsou v prohledávaných cestách příkazu `alocal` přidruženému k různým verzím `automake` dostupná některá běžně používaná makra.

- Katalog XML obsahující DocBook DTD a stylopisy.

### shell

Příkaz `shell` spustí uživatelský shell se stejným prostředím, jako používá JHBuild, když sestavuje moduly.

    jhbuild shell

Tento příkaz odpovídá následujícímu:

    $ jhbuild run $SHELL

Když je tento shell aktivní, nastaví se proměnná prostředí `UNDER_JHBUILD` na „true“. Přítomnost této proměnné pak můžete využít k přizpůsobení své výzvy shellu k indikaci, že jste opravdu v shellu pod správou JHBildu. Například můžete do svého souboru `.bashrc` vložit:

    	if [ -n "$UNDER_JHBUILD" ]; then
    	    PS1="[jhbuild] $PS1"
    	fi

Tím se zajistí, aby shell bash zobrazoval před normální výzvou `jhbuild`, díky čemuž snadno rozlišíte, ve kterém shellu se v prostředí jhbuild nacházíte.

### sysdeps

Příkaz `sysdeps` zobrazí:

1. Seznam nainstalovaných systémových balíčků, které budou během sestavení použity. JHBuild tyto modulu nebude sestavovat a případně místo toho použije systémový balíček.

2. Seznam požadovaných balíčků. Abyste mohli začít sestavovat, musí být tyto balíčky v systému k dispozici.

3. Seznam volitelných balíčků. Odpovídající systémové balíčky nebyly nalezeny nebo jsou příliš staré. JHBuild tyto moduly bude sestavovat. Volitelné balíčky se nezobrazí, když je `partial_build` nastaveno na `False`.

    jhbuild sysdeps --install

`--install`

  Tato volba nainstaluje systémové balíčky, které jsou závislostmi sady modulů. Způsob instalace záleží na vaší distribuci. Pokud je k dispozici PackageKit, nainstalují se systémové balíčky pomocí něj. U distribucí používajících APT, jako třeba Debian a Ubuntu je zapotřebí mít nainstalován apt-file.

#### Příklad pro `sysdeps`

    $ jhbuild sysdeps
    Balíčky nainstalované v systému, které nejsou dostatečně nové:
      speex (speex.pc required=1.2rc1, installed=1.2rc1)
      lcms2 (lcms2.pc required=2.2, installed=2.2)
      …
    Vyžadované balíčky:
      Balíčky nainstalované v systému, které jsou příliš staré:
        (none)
      V systému nejsou nainstalované balíčky odpovídajíc:
        zlib (zlib.pc required=1.2)
    Volitelné balíčky: (JHBuild chybějící balíčky sestaví)
      Balíčky nainstalované v systému, které jsou příliš staré:
        WebKit (webkitgtk-3.0.pc required=1.5.1, installed=1.4.0)
        …
      V systému nejsou nainstalované balíčky odpovídajíc:
        pulseaudio (libpulse.pc required=2.0)
        …

### tinderbox

Příkaz `tinderbox` je podobný příkazu `build`, ale zapisuje veškeré terminálové výstupy do souborů HTML vhodných k publikování na webu. Může být použit k vytvoření podobných systémů, jako je Tinderbox od Mozilly nebo Buildd u Debianu.

    jhbuild tinderbox --autogen --clean --distclean --no-network --output=složka --skip=modul --start-at=modul -D datum -C -N -f --nodeps modul

Volby `--autogen`, `--clean`, `--distclean`, `--no-network`, `--skip`, `--start-at`, `-D`, `-C`, `-N`, `-f` a `--nodeps` jsou zpracovány pro jednotlivé příkazy `build`.

`-o`, `--output`=složka

  Složka pro zápis souborů HTML. JHBuild vytvoří indexovou stránku (`index.html`) a soubory HTML pro jednotlivé moduly.

### uninstall

Příkaz `uninstall` odinstaluje jeden nebo více modulů.

    jhbuild uninstall modul

### update

Příkaz `update` je podobný příkazu `build`, ale provede pro moduly jen krok stažení nebo aktualizace, bez jejich následného sestavení.

    jhbuild update --skip=modul --start-at=modul --tags=štítky --ignore-suggests -D datum modul

Volby `--skip`, `--start-at`, `--tags`, `--ignore-suggests` a `-D` jsou zpracovány pro jednotlivé příkazy `build`.

### updateone

Příkaz `updateone` je podobný příkazu `update`, ale neaktualizuje závislé moduly. To se hodí při aktualizaci jen jednoho nebo pár modulů.

    jhbuild updateone -D datum modul

Volba `-D` je zpracována pro jednotlivé příkazy `build`.

Na příkazovém řádku musí být uveden aspoň jeden modul.

## Referenční příručka k souboru nastavení

Soubor `~/.config/jhbuildrc` používá standardní syntax jazyka Python. Soubor je spuštěn a výsledné proměnné definované ve jmenném prostoru se použijí k řízení činností, které JHBuild provádí. Než se uživatelská verze souboru spustí, je do jmenného prostoru vložena sada výchozích hodnot.

Pravdivostní proměnné v nastavení se definují pomocí syntaxe ukázané v následujícím příkladu:

    use_local_modulesets = True

Řetězcové proměnné v nastavení se definují pomocí syntaxe ukázané v následujícím příkladu:

    autogenargs = '--disable-static --disable-gtk-doc'

Seznamové proměnné v nastavení se definují pomocí syntaxe ukázané v následujícím příkladu:

    skip = ['mozilla', 'pulseaudio']

Slovníkové proměnné v nastavení se definují pomocí syntaxe ukázané v následujícím příkladu:

    repos['git.gnome.org'] = 'ssh://uzivatelske_jmeno@git.gnome.org/git/'

### Proměnné nastavení

`alwaysautogen`

  Pravdivostní hodnota. Když je nastavená na `True`, spustí se vždy `autogen.sh`, což odpovídá předání volby `--autogen`. Výchozí je `False`.

`autogenargs`

  Řetězec obsahující argumenty předávané pro všechny moduly skriptu `autogen.sh`. Pro konkrétní moduly může být přepsán pomocí slovníku `module_autogenargs`.

`branches`

  Slovník určující, která větev se má použít pro které konkrétní moduly. To se hodí, když děláte nějaké změny ve větvi modulu a chcete aby JHBuild sestavil danou tuto větev místo větve uvedené v sadě modulů.

  Definice větví závisejících na modulu VCS:

  - CVS: revize. Např. `'BRANCH-PROJECT-0_8'`

  - Bazaar: adresa URI větve modulu. Např. `'http://bzr.example.net/project/gnome-2-28'`

  - Git: dvojice s první částí tvořenou volitelným repozitářem (nebo hodnotou None) a druhou částí tvořenou názvem větve. Např. `('git://git.example.net/project', 'gnome-2-28')`

    #### Jednoduchý příklad

        branches['nazev_modulu'] = (None, 'nazev_vetve')

  - Subversion: adresa URI větve modulu. Např. `'svn://svn.example.net/project/gnome-2-28'`

`builddir_pattern`

  Vzor pro formátování pomocí `printf` použitý ke generování názvů složek pro sestavení. To se využije, jen když používáte oddělené stromy pro zdrojové kódy a pro sestavení. `%s` ve formátovacím řetězci bude nahrazeno hodnotou z `checkoutdir`. Výchozí je `'%s'`.

`buildroot`

  Řetězec určující rodičovskou složku pro umístění stromu sestavení. Výchozí hodnota je `~/.cache/jhbuild/build`. Nastavení na `None` způsobí, že sestavení bude provedeno ve stromu zdrojových kódů.

`buildscript`

  Řetězec určující, který sestavovací skript použít. Doporučuje se výchozí nastavení `terminal`. Zejména nenastavujte na `gtk`.

`build_policy`

  Řetězec určující, které moduly se mají sestavit. Tři možné volby jsou `all` pro sestavení všech požadovaných modulů, `updated` pro sestavení pouze modulů, ve kterých jsou změny, a `updated-deps` pro sestavení modulů, ve kterých jsou změny, nebo které mají závislosti, ve kterých jsou změny. Výchozí hodnota je `updated-deps`.

`checkoutroot`

  Řetězec určující složku, do které se má rozbalit strom se zdrojovými kódy. Pokud není nastaveno `buildroot`, objeví se v této složce i sestavení. Výchozí hodnota je `~/checkout/gnome`.

`checkout_mode`

  Řetězec určující, jak se má provádět stahování pro složky ve správě verzí. Výchozí je `update`. Pomocí `module_checkout_mode` může být nastaven pro každý modul zvlášť. Možné hodnoty jsou `update` (aktualizovat stahovanou složku), `clobber` (před stažením zdrojových kódů složku vyprázdnit), `export` (složku vyprázdnit a pak vytvořit archiv obsahující záplaty) a `copy` (stáhnout do jiné složky, než ve které se provádí sestavení).

`cmakeargs`

  Řetězec obsahující argumenty předávané všem voláním `cmake` pro jednotlivé moduly. Pro konkrétní moduly může být přepsán pomocí slovníku `module_cmakeargs`. Výchozí je `''`.

`copy_dir`

  Řetězec určující složku, do které se má kopírovat, když se používá režim kopírování `checkout_mode`. Výchozí je složka pro stahování z repozitářů.

`export_dir`

  Řetězec určující složku, do které se má exportovat, když se používá režim exportování `checkout_mode`. Výchozí je složka pro stahování z repozitářů.

`cvs_program`

  Řetězec určující, který program se má použít pro podporu CVS. Může to být `git-cvsimport` nebo `cvs`. Výchozí je `cvs`.

`disable_Werror`

  Pravdivostní hodnota (výchozí je `True`), která řídí předání volby `--disable-Werror` do sestavení pomocí automake. Řada balíčků používá tento příznak jako způsob, jak zabránit kritickým varováním kompilátoru. Hodnota `True` je vybrána jako rozumná výchozí pro ty, kteří používají JHBuild k získání aktuální verze softwarových balíčků, aniž by se chtěli zabývat selháním sestavení v modulech jiných lidí. Nastavení této hodnoty na `False` může mít smysl pro ty, kteří používají JHBuild jako součást průběžné integrace nebo jako testovací systém.

`dvcs_mirror_dir`

  Řetězec určující složku s místní zrcadlovou kopií. JHBuild vytvoří místní zrcadlovou kopii repozitářů v této složce. Zrcadlové kopie mohou být sdílené více skupinami repozitářů, čímž se ušetří místo a čas, protože v místních klonech se používají pevné odkazy. Příkazy `update` a `updateone` vytvoří zrcadlové kopie a získají nová zařazení z repozitářů on-line. Tato volba je podporovaná jen repozitáři Git a Bazaar.

`exit_on_error`

  Pravdivostní hodnota určující, že se má skončit okamžitě po té, co selže sestavení modulu. To má význam hlavně v neinteraktivním režimu, aby se zabránilo v sestavení dalších modulů, když sestavení nějakého modulu selže. Nastavení této hodnoty na `True` odpovídá předání volby `--exit-on-error`. Výchozí hodnota je `False`.

`extra_prefixes`

  Seznam řetězců určující, v zadaném pořadí, seznam zvláštních prefixů. JHBuild nastavuje řadu proměnných prostředí (jako třeba `LD_LIBRARY_PATH`, `PKG_CONFIG_PATH` a `XDG_DATA_DIRS`) podle proměnné `prefix`. Přidání složek do `extra_prefixes` způsobí, že tyto prefixy budou zahrnuty také, s nižší prioritou než z proměnné `prefix`, ale s vyšší prioritou než jsou systémové složky. Ve výchozím stavu je tato proměnná prázdná vyjma systémů, které instalují software do složky `/usr/local`, kdy obsahuje právě tuto složku.

`help_website`

  Dvojice určující název webové stránky s nápovědou a její adresu URL. Webová stránka se zobrazí v souboru HTML vygenerovaném pomocí tinderbox pro moduly, jejich sestavení selže. `%(module)s` adrese URL bude nahrazeno názvem modulu. Pro zakázání nastavte `help_website` na `None`. Výchozí hodnota je `('Gnome Live!', 'http://live.gnome.org/JhbuildIssues/%(module)s')`.

`installprog`

  Řetězec určující program, který se použije jako náhrada pro `/usr/bin/install`.

`ignore_suggests`

  Pravdivostní hodnota určující, jestli při výpočtu stromu závislostí ignorovat měkké závislosti. Výchozí hodnota je `False`.

`interact`

  Pravdivostní hodnota určující, jestli se má komunikovat s uživatelem. Nastavení na hodnotu `False` odpovídá předání volby `--no-interact`. Výchozí hodnota je `True`.

`makeargs`

  Řetězec uvádějící dodatečné argumenty, které se předají příkazu `make`. JHBuild automaticky připojuje volbu pro paralelní provádění (`-j`) vycházející z počtu jader dostupných v procesoru. Výchozí hodnota je `''`.

`makecheck`

  Pravdivostní hodnota určující, jestli po `make` spustit `make check`. Výchozí hodnota je `False`.

`makecheck_advisory`

  Pravdivostní hodnota určující, jestli selhání při běhu `make check` má být jen informativní a nezpůsobit selhání celého sestavení. Výchozí hodnota je `False`.

`makeclean`

  Pravdivostní hodnota určující, jestli se má před `make` nejdříve spustit `make clean`. Výchozí hodnota je `False`.

`makedist`

  Pravdivostní hodnota určující, jestli se má po příkazu `make` spustit `make dist`. Výchozí hodnota je `False`. Toto nastavení odpovídá předání volby `--dist`.

`makedistcheck`

  Pravdivostní hodnota určující, jestli se má po příkazu `make` spustit `make distcheck`. Výchozí hodnota je `False`. Toto nastavení odpovídá předání volby `--distcheck`.

`mesonargs`

  Řetězec obsahující argumenty předávané pro všechna volání `meson` pro jednotlivé moduly. Pro konkrétní moduly může být přepsán pomocí slovníku `module_mesonargs`. Výchozí je `''`.

`module_autogenargs`

  Slovník mapující názvy modulů na řetězce určující argumenty, které se předají skriptu `autogen.sh`. Nastavení v `module_autogenargs` se použije místo globálního nastavení `autogenargs`. Pokud některý modul ve slovníku není uveden, použije se globální `autogenargs`.

`module_checkout_mode`

  Slovník určující režimy stahování použité jednotlivými moduly. Přepíše globální nastavení `checkout_mode`.

`module_cmakeargs`

  Slovník mapující názvy modulů na řetězce určující argumenty, které se předají příkazu `cmake`. Nastavení v `module_cmakeargs` se použije místo globálního nastavení `cmakeargs`. Pokud některý modul ve slovníku není uveden, použije se globální `cmakeargs`.

`module_makeargs`

  Slovník mapující názvy modulů na řetězce určující argumenty, které se předají příkazu `make`. Nastavení v `module_makeargs` se použije místo globálního nastavení `makeargs`. Pokud některý modul ve slovníku není uveden, použije se globální `makeargs`.

`module_makecheck`

  Slovník mapující názvy modulů na pravdivostní hodnoty určující, jestli se má po příkazu `make` spustit `make check`. Nastavení v `module_makecheck` nahradí hodnoty z nastavení `makecheck`. Pokud některý modul ve slovníku není uveden, použije se globální `makecheck`.

`module_mesonargs`

  Slovník mapující názvy modulů na řetězce určující argumenty, které se předají příkazu `meson`. Nastavení v `module_mesonargs` se použije místo globálního nastavení `mesonargs`. Pokud některý modul ve slovníku není uveden, použije se globální `mesonargs`.

`module_ninjaargs`

  Slovník mapující názvy modulů na řetězce určující argumenty, které se předají příkazu `ninja`. Nastavení v `module_makeargs` se použije místo globálního nastavení `makeargs`. Pokud některý modul ve slovníku není uveden, použije se globální `makeargs`.

`module_nopoison`

  Slovník mapující názvy modulů na pravdivostní hodnoty. Když je modul nastaven na `True`, pokusí se JHBuild sestavit závislé moduly, i když zadaný modul selže. Nastavení v `module_nopoison` nahradí hodnoty z nastavení `nopoison`. Pokud některý modul ve slovníku není uveden, použije se globální `nopoison`.

`module_extra_env`

  Slovník mapující názvy modulů na slovníky s dodatečnými proměnnými prostředí, které se předají při spuštění příkazů pro modul.

`module_static_analyzer`

  Slovník mapující názvy modulů na pravdivostní hodnoty, které určují, jestli se má při sestavování modulu provést statická analýza. Umožňuje přepsat globální volbu nastavení `static_analyzer`.

`modules`

  Seznam řetězců určujících moduly k sestavení. Seznam skutečně sestavených modulů bude rekurzivně rozvinut, aby pokryl všechny závislosti, vyjma situace, kdy je použit příkaz `buildone`. Výchozí hodnota je `['meta-gnome-desktop']`.

`moduleset`

  Řetězec (nebo seznam řetězců) specifikující název sady modulů (nebo názvy sad modulu), které se mají použít. Název může být dán buď název souboru se sadou modulů, která je součástí JHBuildu (cestu a příponu vynechejte) nebo plnou adresou HTTP URL k externě spravované sadě modulů. Externí sada modulů bude uložena v mezipaměti. Pokud se modul se stejným názvem objeví ve více sadách modulů, získá přednost poslední uvedený. Sady modulů zahrnuté přímo v JHBuildu jsou aktualizované, aby odpovídaly aktuálnímu vývojovému vydání GNOME.

`modulesets_dir`

  Řetězec určující složku, která obsahuje sadu modulů, která se má použít. Výchozí hodnotou je složka `modulesets/` ve zdrojích systému JHBuild.

`nice_build`

  Spustí sestavení s prioritou `SCHED_IDLE` v Linuxu, případně `nice` v jiných Unixových systémech. Tím se významně zvýší odezva uživatelského prostředí při paralelním sestavování, zatímco na propustnost sestavení to má zanedbatelný vliv.

`ninjaargs`

  Řetězec uvádějící dodatečné argumenty, které se předají příkazu `ninja`. Výchozí je `''`.

`nobuild`

  Pravdivostní hodnota. Když je nastavená na `True`, nebude JHBuild sestavovat moduly, jen stáhne a rozbalí zdrojové kódy. Výchozí hodnota je `False`.

`nonetwork`

  Pravdivostní hodnota určující, jestli se má přistupovat k síti. Ovlivňuje stahování a aktualizace modulů CVS, stahování archivů tarball a aktualizace sad modulů. Nastavení na `True` odpovídá předání volby `--no-network`. Výchozí hodnota je `False`.

`nonotify`

  Pravdivostní hodnota určující, jestli se mají vysílat upozornění pomocí démona upozornění. Když je nastaveno na `False`, jsou upozornění vysílána. Výchozí hodnota je `True`.

`nopoison`

  Pravdivostní hodnota. Když je nastavená na `True`, pokusí se JHBuild sestavit moduly, i když selže sestavení jednoho nebo více modulů závislostí. Tato volba odpovídá argumentu `--no-poison`. Výchozí hodnota je `False`.

`notrayicon`

  Pravdivostní hodnota určující, jestli se má v systémové liště zobrazit pomocí Zenity ikona. Když je nastavené na `False`, zobrazí se ikona. Výchozí hodnota je `True`.

`noxvfb`

  Pravdivostní hodnota. Když je nastavená na `True`, spustí JHBuild grafické testy na skutečném X serveru, místo aby použil `Xvfb`. Tato volba odpovídá předání `--no-xvfb`. Výchozí hodnota je `False`.

`partial_build`

  Pravdivostní hodnota, která, když je nastavená na `True`, přiměje JHBuild, aby nesestavoval moduly závislostí v případě, že je nainstalován odpovídající systémový balíček a je v dostačující verzi. Výchozí hodnota je `True`.

`prefix`

  Řetězec určující prefix cesty, do které se mají instalovat moduly. Musí se jednat o absolutní cestu a složka musí být zapisovatelná. Výchozí hodnota je `'~/jhbuild/install/'`.

`pretty_print`

  Pravdivostní hodnota určující hezké formátování výstupu z podřízeného procesu. Hezké formátování podporuje jen výstup CVS. Pokud toto formátování způsobuje problémy, vypněte jej. Výchozí hodnota je `True`.

`print_command_pattern`

  Řetězec, který se zobrazí, než JHBuild provede příkaz. `%s(command)s` bude v řetězci nahrazeno příkazem, který má být proveden. `%(cwd)s` bude nahrazeno aktuální pracovní složkou. Výchozí hodnotu je `'%(command)s'`.

`progress_bar`

  Pravdivostní hodnota určující, jestli se má během tichého režimu zobrazovat ukazatel průběhu. Výchozí hodnota je `True`.

`quiet_mode`

  Pravdivostní hodnota, která když je nastavená na `True`, zakáže výpisy z běžícího příkazu. Výchozí hodnota je `False`.

`repos`

  Slovník určující cesty k alternativním repozitářům. Tato proměnná nastavení je užitečná pro vývojáře modulů. Ve výchozím stavu JHBuild stáhne zdrojové kódy z repozitářů pro anonymní přístup. Klíči slovníku jsou krátké názvy repozitářů a hodnotami jsou cesty alternativních repozitářů. Například:

      repos['git.gnome.org'] = 'ssh://uzivatelske_jmeno@git.gnome.org/git/'

`shallow_clone`

  A boolean value specifying if JHBuild should prefer smaller version control downloads. Equivalent to `git clone --depth 1` or `bzr co --light`. Defaults to `False`.

`skip`

  Seznam modulů, které se mají přeskočit. Volba příkazového řádku `--skip` seznam rozvine. Ve výchozím stavu je tento seznam prázdný. Pokud seznam obsahuje speciální hodnotu `'*'`, přeskočí JHBuild všechny moduly, které nejsou výslovně uvedené v proměnné `modules`. To se může hodit, když chcete sestavit moduly bez jejich přirozených závislostí.

`static_analyzer`

  Pravdivostní hodnota. Když je nastavená na `True`, spustí se statická analýza pro jednotlivé moduly, tak jak jsou sestavovány. Výchozí hodnota je `False`.

`static_analyzer_outputdir`

  Kořenová složka, do které budou ukládány výstupní zprávy statické analýzy (když je `static_analyzer` nastaveno na `True`). Výchozí hodnota je `/tmp/jhbuild_static_analyzer`.

`static_analyzer_template`

  Šablona příkazu pro statickou analýzu. Může mít parametry `outputdir` (hodnota proměnné nastavení `static_analyzer_outputdir`) a `module` (název právě sestavovaného modulu), které se nahradí ve stylu `printf`. Výsledný příkaz je použit jako prefix k příkazu `make` při sestavení modulu. Výchozí hodnota je `scan-build`.

`sticky_date`

  Řetězec, který když je nastaven, a když to podporuje systém správy verzí v pozadí, zajistí, že JHBuild před sestavením aktualizuje strom se zdrojovými kódy na konkrétní datum. Datum je požadováno ve formátu ISO, např. `'rrrr-mm-dd'`. Výchozí hodnota je `None`.

`svn_program`

  Řetězec určující program, který se použije pro podporu systému subversion. Možné hodnoty jsou `svn`, `git-svn` a `bzr`. Výchozí hodnota je `svn`.

`system_libdirs`

  Seznam řetězců určující cesty k systémovým knihovnám. Použije se, když se nastavují výchozí hodnoty některých proměnných prostředí, jako je třeba `PKG_CONFIG_PATH`.

`tarballdir`

  Řetězec, který když je nastaven, způsobí stažení archivu tarball do zadané složky, místo do `checkoutroot`. To se hodí, když máte více prostředí JHBuild nebo pravidelně čistíte `checkoutroot` a nechcete stahovat pořád dokola to stejné. Výchozí je `'~/.cache/jhbuild/downloads'`.

`tinderbox_outputdir`

  Řetězec určující složku pro uložení výstupu z `jhbuild tinderbox`. Tento řetězec může být přepsán volbou `--output`. Výchozí volbou je `None`, takže buď je potřeba zadat volbu v příkazové řádce nebo tuto proměnnou v souboru s nastavením opravdu nastavit.

`trycheckout`

  Pravdivostní hodnota. Když je nastavená na `True`, bude se JHBuild automaticky pokoušet vyřešit selhání, a to 1) opětovným spuštěním `autogen.sh` a 2) stažením novější verze modulu ze správy verzí. Toto nastavení odpovídá předání volby `--try-checkout`.

`use_local_modulesets`

  Pravdivostní hodnota, která říká, že se má použít sada modulů stažená mimo zdrojové kódy v JHBuildu, místo aby se stahovala za běhu ze systému správy verzí projektu GNOME. Výchozí hodnota je `False`.

`xvfbargs`

  Argumenty uvádějící řetězce, které se předají `Xvfb` při spuštění grafických testů.

`conditions`

  Množina podmínek (řetězců), které ovlivní moduly, které jsou sestavovány a volby, které jsou použity při jejich sestavení. Když chcete provést změny, měli byste pro úpravu seznamu použít `conditions.add()` a `conditions.discard()`.

  Originální množina podmínek je dána podle operačního systému a lze ji změnit pomocí argumentu příkazového řádku `--conditions=`. Změny provedené pomocí `--conditions` jsou viditelné, když je vytvářen jhbuild, takže můžete nastavit jiné proměnné podle aktuální hodnoty množiny, ale `--conditions` budou znovu použity po té, co dojde k nějaké změně v jhbuildrc.

### Další struktury souboru nastavení

Mimo proměnných zmíněných výše, existují další nastavení, která mohou být nastavena v souboru s nastavením:

`os.environ`

  Slovník představující prostředí. Toto prostředí se předává do procesů, které JHBuild vytváří.

  Mezi proměnné prostředí mající vliv patří `CPPFLAGS`, `CFLAGS`, `INSTALL` a `LDFLAGS`. Naříklad:

      os.environ['CFLAGS'] = '-O0 -g'

`addpath`(`envvar`, `pathname`)

  Tímto se přidá složka do proměnné prostředí `PATH`. `addpath` bude správně fungovat, v případech, kdy je proměnná prostředí na počátku prázdná (zbloudilá dvojtečka na začátku nebo na konci může mít nečekané následky).

`prependpath`(`envvar`, `pathname`)

  Po zpracování souboru s nastavením změní JHBuild některé cesty pomocí proměnných, jako je třeba `prefix` (např. přidá `$prefix/bin` na začátek do proměnné `PATH`).

  Funkce `prependpath` funguje podobně jako `addpath`, akorát, že proměnné prostředí jsou změněny až po té, co v prostředí provede změny JHBuild.

## Syntax pro soubor sady modulů

JHBuild používá k popisu závislostí mezi moduly soubory XML. Schéma RELAX-NG a definici typu dokumentu DTD má JHBuild uložené v rámci složky `modulesets/`. Schéma RELAX-NG můžete použít k úpravám sady modulů pomocí režimu `nxml-mode` v editoru Emacs.

Prvek nejvyšší úrovně v souboru sady modulů je `moduleset`. Nepoužívá se žádný jmenný prostor XML. Prvky pod hlavní úrovní jsou tří typů: zdroje modulů, vložené sady modulů a definice modulů.

Obsah v souboru sady modulů může být podmíněně vkládán pomocí značky `<if>` obalující podmíněný obsah. V současnosti je možné rozhodovat o vložení pouze na základě toho, jestli je, nebo není, nastaven konkrétní podmíněný příznak, a to pomocí konstrukce `<if condition-set='podmínka'>` nebo `<if condition-unset='podmínka'>`. Podmínky jsou nastavené jako výchozí podle operačního systému, ale mohou být ovlivněny proměnnou `conditions` v jhbuildrc nebo argumentem příkazového řádku `--conditions=`.

### Zdroje modulů

Než abyste vypisovali celou cestu pro každý modul, můžete v každé sadě modulů uvést několik „zdrojů modulů“ a pak se v definicích modulů odkazovat na jejich názvy. Nejenže se tím omezí množství nadbytečných informací v sadě modulů, ale pro uživatel je snazší i určit alternativní zdroj pro tyto moduly (u CVS a Subversion je běžné používat jinou metodu přístupu k repozitáři pro vývojáře a jinou pro uživatele).

Prvek `repozitory` se používá k popisu všech typů repozitářů. Prvek `branch` se používá uvnitř definice modulu k určení dodatečných nastavení.

    <repository name="název"
      type="typ"
      [ default="výchozí" ]
      [ password="heslo" ]
      [ cvsroot="kořen_cvs" ]
      [ archive="archiv" ]
      [ href="odkaz" ]
      [ server="server" ]
      [ database="databáze" ]
      [ defbranch="výchozí_větev" ]
      [ trunk-template="šablona_kmene" ]
      [ branches-template="šablona_větve" ]
      [ tags-template="šablona_štítků" ]
      [ developer-href-example="příklad_odkazu_pro_vývojáře" ] />

Atribut `name` je jedinečný identifikátor pro repozitář.

Atribut `default` určuje, jestli je tento repozitář výchozím zdrojem pro tento modul.

Atribut `type` určuje typ repozitáře. Může se jednat o jednu z hodnot: `bzr`, `cvs`, `darcs`, `fossil`, `git`, `hg`, `mnt`, `svn` a `tarball`. Ostatní atributy závisí na konkrétním typu, stejně jako u prvku `branch` uvnitř definice modulu. Popsané jsou níže v částech věnovaných jednotlivým typům repozitářů.

Atribut `developer-href-example` se používá k určení formátu adresy URL pro repozitáře používané vývojáři. Slouží jen k informačním účelům.

Prvek `branch` je použit uvnitř definicí modulů.

    <branch
      [ repo="repozitář" ]
      [ module="název_modulu" ]
      [ checkoutdir="složka_pro_stažení" ]
      [ revision="revize" ]
      [ tag="štítek" ]
      [ update-new-dirs="složka_pro_nové_aktualizace" ]
      [ override-checkoutdir="přepsat_složku_pro_stažení" ]
      [ subdir="podsložka" ]
      [ branch="větev" ]
      [ version="verze" ]
      [ size="velikost" ]
      [ source-subdir="podsložka_zdrojových_kódů" ]
      [ hash="haš" ]/>

Všechny atributy ve výchozím nastavení reagují podle definice modulu a repozitáře. Běžné atributy jsou popsány zde.

Atribut `repo` se používá k určení jiného názvu repozitáře, než je výchozí.

Atribut `module` se používá k určení názvu modulu, který se má stáhnout z repozitáře. Výchozí je id modulu.

Atribut `checkoutdir` se používá k určení názvu složky pro stažení. Výchozí hodnotu je id modulu.

Ostatní atributy jsou popsány níže

#### Bazaar

Tento typ repozitáře je použit k definici repozitáře Bazar. Je doporučováno mít Bazaar 1.16 nebo novější.

    <repository type="bzr" name="launchpad.net"
          href="lp:"/>

Dalšími atributy jsou: `trunk-template` (výchozí hodnota je `"%(module)s"`) a `branches-template` (výchozí hodnota je `"%(module)s/%(branch)s`"). Tyto atributy se používají jako šablony pro vytvoření adresy URL. Prvek `branch` v definici modulu může obsahovat atributy `branch` a `user`. Tyto hodnoty budou nahrazeny do šablony. Když je některá z nich definovaná, použije se `branches-template`, jinak se použije `trunk-template`. Tímto způsobem můžete přepsat repozitáře pro sestavení modulů z vaší soukromé větve nebo pro sestavení několika modulů z repozitáře s nestandardním rozvržením.

Prvek `branch` navíc přijímá atribut `revspec` pro ukotvení konkrétní revize. Přijímáno je jakékoliv platné `bzr revspec`, například `date:yesterday, -5, tag:0.1` pro první revizi od včerejška, 5 zařazení od konce nebo štítku „0.1“. Možné hodnoty viz `bzr help revisionspec`.

Příklad repozitáře s uvedeným atributem `template`:

    <repository type="bzr" name="launchpad.net"
          href="lp:"
          trunk-template="~bzr-pqm/%(module)s/bzr.dev"
          branches-template="~bzr-pqm/%(module)s/%(branch)s"/>

Příklad prvků `branch` pro repozitář uvedený výše:

    <branch repo="launchpad.net"
          module="bzr"
          checkoutdir="bzr-next"/>

    <branch repo="launchpad.net"
          module="bzr"
          branch="2.2"
          checkoutdir="bzr-beta"/>

#### CVS

Tento typ repozitáře je použit k definici repozitáře CVS.

Atribut `password` se používá k určení hesla pro repozitář.

Atribut `svsroot` se používá k určení kořene repozitáře.

    <repository type="cvs" name="tango.freedesktop.org"
        cvsroot=":pserver:anoncvs@anoncvs.freedesktop.org:/cvs/tango"
        password=""/>

Dodatečné atributy jsou: `revision`, `update-new-dirs` a `override-checkoutdir`.

#### Darcs

Tento typ repozitáře je použit k definici repozitáře Darcs.

    <repository type="darcs" name="telepathy.freedesktop.org"
          href="http://projects.collabora.co.uk/darcs/telepathy/"/>

#### Git

Tento typ repozitáře je použit k definici repozitáře Git.

    <repository type="git" name="git.freedesktop.org"
        href="git://anongit.freedesktop.org/git/"/>

U prvku `branch` jsou možné následující atributy:

Atribut `revision` se používá k určení místní nebo vzdáleně sledované větve, do které se má přepnout v kroku aktualizace. Výchozí hodnota je `'master'`. Tento atribut je možné přepsat pomocí proměnné nastavení `branches`. Přepnutí bude provedeno, jen když je aktuální větev sledováním vzdálené větve, aby nedošlo k narušení vaší vlastní práce.

Atribut `tag` se používá k určení revize, která se bezpodmínečně stáhne v kroku aktualizace. Přepisuje atribut `revision`.

    <branch repo="git.freedesktop.org" module="swfdec/swfdec"
            checkoutdir="swfdec"
            revision="local-or-remote-branch"
            tag="tree-ish"/>

#### Mercurial

Tento typ repozitáře je použit k definici repozitáře Mercurial.

    <repository type="hg" name="hg.gtk-vnc"
        href="http://gtk-vnc.codemonkey.ws/hg/" />

    <branch repo="hg.gtk-vnc" module="vystup.hg" checkoutdir="gtk-vnc"/>

#### Monotone

Tento typ repozitáře je použit k definici repozitáře Monotone.

Atribut `server` se používá k určení serveru s repozitářem.

Atribut `database` se používá k určení databáze, která se má použít pro repozitář.

Atribut `defbranch` se používá k určení větve repozitáře, která se má použít.

    <repository type="mtn" name="pidgin.im"
        server="pidgin.im" database="pidgin.im.mtn"
        defbranch="im.pidgin.pidgin"/>

#### Subversion

Tento typ repozitáře je použit k definici repozitáře Subversion.

    <repository type="svn" name="svn.gnome.org" default="yes"
        href="http://svn.gnome.org/svn/"/>

Umožňuje zadat revizi `revision` v prvku `branch`. Určuje větev, která se má stánout, nebo, pokud se jedná o číslo, revizi, která se má stáhnout.

    <branch revision="gnome-2-20"/>

Pomocí `trunk-template` (výchozí hodnota je `'%(module)s/trunk'`), `branches-template` (výchozí hodnota je `'%(module)s/branches/%(branch)s'`) a `tags-template` (výchozí hodnota je `'%(module)s/tags/%(tag)s'`) je možné určit vlastní rozvržení `svn`.

#### System

Tento typ repozitáře se používá k definici falešných systémových repozitářů. Systémový repozitář je vyžadován pro vytvoření `systemmodules`.

    <repository type="system" name="system"/>

#### Tarball

Tento typ repozitáře je použit k definici repozitáře tarball.

    <repository type="tarball" name="dbus/dbus-python"
        href="http://dbus.freedesktop.org/releases/dbus-python/"/>

U prvku `branch` jsou možné následující atributy:

Atribut `module` určuje soubor, který se má stáhnout a zkompilovat, atribut `version` určuje verzi modulu.

Atributy `size` a `hash`, stejně jako zastaralý atribut `md5sum`, jsou volitelné. Pokud jsou přítomny, použijí se ke kontrole, jestli byl balíček se zdrojovými kódy stažen v pořádku.

Atribut `rename-tarball` můžete použít k přejmenování archivního souboru tarball při stahování v situaci, kdy je původní název v konfliktu s jiným modulem.

Uvnitř prvku `branch` může být vnořený libovolný počet prvků `patch`. Tyto prvky určují záplaty, které se použijí v zadaném pořadí na strom se zdrojovými kódy po té, co je rozbalen. Atribut `file` poskytuje název souboru se záplatou a atribut `strip` říká, do jaké úrovně složek se má při použití záplaty jít.

Pro sady modulů šířené v rámci JHBuildu se soubory se záplatami hledají ve složce `jhbuild/patches/`. Pro sady modulů dané pomocí adresy URI se hledají ve stejné složce, jako soubor sady modulů nebo v její podsložce `patches/`. Je také možné pomocí atributu `file` určit adresu URI a pak budou záplaty staženy z příslušného umístění.

    <branch module="dbus-python-0.80.2.tar.gz" version="0.80.2"
        repo="dbus/dbus-python"
        hash="md5:2807bc85215c995bd595e01edd9d2077" size="453499">
      <patch file="dbus-glib-build.patch" strip="1" />
    </branch>

Prvek `branch` u repozitáře typu tarball může obsahovat také prvek `quilt`, který určuje vnořenou větev `branch`, která se má importovat.

### Vložení dalších sad modulů

JHBuild umožňuje, aby jedna sada modulů obsahovala jinou sadu modulů, na kterou odkazuje prvek `include`.

    <include href="URI"/>

Atribut `href` je odkaz v podobě adresy URI, který odkazuje na sadu modulů, která se má vložit, a to relativně k souboru obsahujícímu prvek `include`.

Z odkazované sady modulů se naimportují jen definice modulů – zdroje modulů ne. Je možné i víceúrovňové vložení, ale nesmí dojít k uzavřené smyčce (zatím neexistuje kód, který by takovou smyčku ošetřil).

### Definice modulů

Existuje řada typů definicí modulů, které mohou být použity v souboru sady modulů, a seznam lze jednoduše rozšiřovat. Zde jsou zmíněné jen ty nejběžnější.

Všechny jsou v podstatě založeny na prvku `branch` popisujícím, jak modul získat, a prvcích `dependencies`, `suggests` a `after` deklarujících závislosti mezi moduly.

Moduly uvedené v prvku `dependencies` budou přidány do seznamu modulů pro `jhbuild build`, pokud v něm již nejsou, a zajistí se, aby moduly závislostí byly sestaveny jako první.

Po vytvoření seznamu modulů budou moduly uvedené v prvku `suggestes` použity k dalšímu seřazení seznamu modulů (ačkoliv nevloží žádné další moduly). To je pro případy, kdy moduly mají volitelné závislosti v jiném modulu.

#### autotools

Prvek `autotools` se používá k definici modulu, který se kompiluje pomocí systému sestavení Autotools.

    <autotools id="id"
    	      [ autogenargs="argumenty_pro_autogen" ]
    	      [ makeargs="argumenty_pro_make" ]
    	      [ makeinstallargs="argumenty_pro_makeinstall" ]
    	      [ autogen-sh="autogen-sh" ]
    	      [ makefile="makefile" ]
    	      [ skip-autogen="přeskočit-autogen" ]
    	      [ skip-install="přeskočit-install" ]
    	      [ uninstall-before-install="před_instalací_odinstalovat" ]
    	      [ autogen-template="šaplona_pro_autogen" ]
    	      [ check-target="cíl_pro_stažení" ]
    	      [ supports-non-srcdir-builds="podporuje_sestavení_mimo_zdrojovu_složku" ]
    	      [ force-non-srcdir-builds="vynutit_sestavení_mimo_zdrojovou_složku" ]
    	      [ supports-unknown-configure-options="podporuje_neznámé_volby_nastavení" ]
    	      [ supports-static-analyzer="podporuje_statickou_analýzu" ]>

      <branch [ … ] >
        […]
      </branch>

      <dependencies>
        <dep package="název_modulu"/>
        …
      </dependencies>
      <after>
        <dep package="název_modulu"/>
        …
      </after>

    </autotools>

Atributy `autogenargs`, `makeargs` a `makeinstallargs` se používají k určení dodatečných argumentů, které se předávají do `autogen.sh` respektive `make` respektive `make install`.

Atribut `autogen-sh` určuje název skriptu autogen.sh, který se má spustit. Pokud váš modul nemá odpovídající skript `autogen.sh`, je možné použít hodnotu `autoreconf`. V takovém případě JHBuild spustí `autoreconf -fi` následovaný příslušným `configure`. `skip-autogen` volí, jestli spustit či nespustit `autogen.sh`. `skip-install` je pravdivostní hodnota říkající, jestli v modulu přeskočit příkaz `make install`. `makefile` určuje název souboru makefile, který se má použít.

Atribut `uninstall-before-install` říká, jestli se mají před spuštěním instalačního kroku odstranit staré nainstalované soubory z modulu. To se může hodit k obejití problému, kdy libtool zkouší linkovat jednu instalovanou knihovnu vůči jiné instalované knihovně, ale protože JHBuilt používá DESTDIR, najde místo toho starou nainstalovanou knihovnu. Nevýhodou tohoto řešení ale může být, že mohou nastat problémy, když má uživatel právě spuštěný kód, který spoléhá na soubory nainstalované z modulu.

Atribut `supports-non-srcdir-builds` se používá k označení modulů, které nemohou být čistě sestavené pomocí odděleného stromu se zdrojovými kódy.

Atribut `force-non-srcdir-builds` se používá k označení modulů, které nemohou být čistě sestavené ze stromu se zdrojovými kódy, ale mohou být sestavené mimo něj.

Atribut `autogen-template` můžete použít, když potřebujete podrobnější kontrolu nad příkazovým řádkem pro autogen. Jedná se o řetězec formátovaný ve stylu jazyka Python a jsou v něm nahrazeny následující proměnné: `srcdir`, `autogen-sh`, `prefix`, `libdir` a `autogenargs`. Zde je například výchozí autogen-template:

    %(srcdir)s/%(autogen-sh)s --prefix %(prefix)s --libdir %(libdir)s %(autogenargs)s

Atribut `check-target` musí být uveden (s hodnotou flase) pro moduly, které nemají cíl `make check`.

Atribut `supports-static-analyzer` musí být uveden (s hodnotou false) pro moduly, které nepodporují sestavení pod nástroji statické analýzy, jako je třeba `scan-build`.

Atribut `supports-unknown-configure-options` se používá k označení modulů, které se dostanou do chybového stavu, když je příkazu `configure` předána neznámá volba. Pro tento modul se nebudou používat globální konfigurační volby.

#### cmake

Prvek `cmake` se používá k definici modulu, který se sestavuje pomocí sestavovacího systému CMake.

      <cmake id="nazev_modulu"
                [ cmakeargs="argumenty_cmake" ]
                [ ninjaargs="argumenty_ninja" ]
                [ makeargs="argumenty_make" ]
                [skip-install="preskocit_instalaci"]
                [cmakedir="složka_cmake"]>
                [ use-ninja="použít_ninja" ]
                [ force-non-srcdir-builds="vynutit_sestavení_bez_zdrojové_složky" ]>
      <branch […] >
        […]
      </branch>

      <dependencies>
        <dep package="nazev_modulu"/>
        ...
      </dependencies>
      <after>
        <dep package="nazev_modulu"/>
        …
      </after>
    </cmake>

Atribut `cmakeargs` je použit k určení dodatečných argumentů, které se předají příkazu `cmake`.

Atribut `ninjaargs` je použit k určení dodatečných argumentů, které se předají příkazu `ninja`.

Atribut `makeargs` je použit k určení dodatečných argumentů, které se předají příkazu `make`.

Atribut `cmakedir` určuje podsložku, vekteré se spustí cmake relativně ke složce se zdrojovými kódy.

Atribut `force-non-srcdir-builds` se používá k označení modulů, které nemohou být čistě sestavené ze stromu se zdrojovými kódy, ale mohou být sestavené mimo něj.

Atribut `use-ninja` se používá k označení modulů, které by měly být sestaveny pomocí nástroje Ninja pro cmake, namísto Make. Výchozí je použití nástroje Ninja.

#### Meson

Prvek `meson` se používá k definici modulu, který používá sestavovací systém Meson a je sestavován pomocí sestavovacího nástroje Ninja.

      <meson id="nazev_modulu"
                [ mesonargs="argumenty_meson" ]
                [ ninjaargs="argumenty_ninja" ]
                [skip-install="preskocit_instalaci"]>
      <branch […] >
        […]
      </branch>

      <dependencies>
        <dep package="nazev_modulu"/>
        ...
      </dependencies>
      <after>
        <dep package="nazev_modulu"/>
        …
      </after>
    </meson>

Atribut `mesonargs` je použit k určení dodatečných argumentů, které se předají příkazu `meson`.

Atribut `ninjaargs` je použit k určení dodatečných argumentů, které se předají příkazu `ninja`.

#### distutils

Prvek `distutils` se používá k definici modulu, který se sestavuje pomocí distutils od Pythonu.

    <distutils id="název_modulu"
                [ supports-non-srcdir-builds="yes|no" ]>
      <branch [ … ] >
        […]
      </branch>

      <dependencies>
        <dep package="název_modulu"/>
        …
      </dependencies>
      <after>
        <dep package="název_modulu"/>
        …
      </after>
    </distutils>

#### linux

Prvek `linux` definuje modul používaný k sestavení linuxového jádra. Navíc lze zvolit oddělené nastavení jádra pomocí podřízeného prvku `kconfig`.

    <linux id="id"
    	  [ makeargs="argumenty_pro_make" ]>

      <branch [ … ] >
        […]
      </branch>

      <dependencies>
        <dep package="název_modulu"/>
        …
      </dependencies>
      <after>
        <dep package="název_modulu"/>
        …
      </after>

      <kconfig [ repo="repozitář" ]
    	    version="verze"
    	    [ module="modul" ]
    	    [ config="nastavení" ] />

    </linux>

#### perl

Prvek `perl` je použit k sestavení modulů jazyka Perl.

Atribut `makeargs` je použit k určení dodatečných argumentů, které se předají příkazu `make`.

    <perl id="nazev_modulu"
    	 [ makeargs="argumenty_pro_make" ]>

      <branch [ … ] >
        […]
      </branch>

      <dependencies>
        <dep package="nazev_modulu"/>
        …
      </dependencies>
      <after>
        <dep package="nazev_modulu"/>
        …
      </after>

    </perl>

#### systemmodule

Prvek `systemmodule` se používá k určení modulů, které musí být poskytnuté systémem. Moduly by měly být nainstalované skrze systém správy balíčků vaší distribuce.

    <systemmodule id="nazev_modulu">
      <pkg-config>pkg-config.pc</pkg-config>

      <branch repo="system" version="verze" />
    </systemmodule>

V případě, že systémový modul neposkytuje soubor pkg-config, lze použít k určení závislostí značku `systemdependencies`. Podporované jsou dvě hodnoty pomocí atributu `type` značky `dep`:

1. Hodnota `path`. V této cestě se hledají odpovídající názvy programů.

2. Hodnota `c_include`. V této cestě se hledají příslušné hlavičkové soubory. Součástí `name` může být vložení podsložky. Cesta pro vkládání souborů v jazyce C může být změněna nastavením `CPPFLAGS` v rámci proměnné nastavení `cflags` nebo pomocí `module_autogenargs`.

    <systemmodule id="název_modulu">
      <branch repo="systém" version="verze" />
      <systemdependencies>
        <dep type="path" name="název-spustitelného-souboru" />
      </systemdependencies>
    </systemmodule>

    <systemmodule id="název_modulu">
      <branch repo="systém" version="verze" />
      <systemdependencies>
        <dep type="c_include" name="název-hlavičkového-souboru" />
      </systemdependencies>
    </systemmodule>

V případě, že může být systémový modul nainstalován v jiném umístění nebo nainstalován jinou distribucí pod jiným názvem, můžete použít značku `altdep` jako podřízený prvek značky `dep` k určení alternativního umístění nebo názvu. Značka `altdep` podporuje stejné atributy jako značka `dep`.

    <systemmodule id="název_modulu">
      <branch repo="systém" version="verze" />
      <systemdependencies>
        <dep type="path" name="název-spustitelného-souboru">
          <altdep type="path" name="název-alternativního-spustitelného-souboru-1" />
          <altdep type="path" name="název-alternativního-spustitelného-souboru-2" />
          …
        <dep>
      </systemdependencies>
    </systemmodule>

    <systemmodule id="název_modulu">
      <branch repo="systém" version="verze" />
      <systemdependencies>
        <dep type="c_include" name="název-hlavičkového-souboru">
          <altdep type="c_include" name="název-alternativního-hlavičkového-souboru-1" />
          <altdep type="c_include" name="název-alternativního-hlavičkového-souboru-2" />
          …
        <dep>
      </systemdependencies>
    </systemmodule>

#### waf

Prvek `waf` se používá k definici modulu, který je sestavován pomocí systému sestavení Waf.

Atribut `waf-command` se používá k určení příkazového skriptu waf, který se má použít. Výchozím je `waf`.

Atribut `python-command` se používá k určení spustitelného souboru pro Python. Výchozím je `python`. Hodí se to při sestavování modulu v jazyce Python verze 3.

    <waf id="název_modulu">
    	 [ python-command="příkaz-python" ]
    	 [ waf-command="příkaz-waf" ]>
      <branch [ … ] >
        […]
      </branch>

      <dependencies>
        <dep package="název_modulu"/>
        …
      </dependencies>
      <after>
        <dep package="název_modulu"/>
        …
      </after>
    </waf>

#### testmodule

Prvek `testmodule` se používá k vytvoření modulu, který spustí sadu testů používající LDTP nebo Dogtail.

    <testmodule id="id"
    	       type="typ">

      <branch [ … ] >
        […]
      </branch>

      <dependencies>
        <dep package="název_modulu"/>
        …
      </dependencies>
      <after>
        <dep package="název_modulu"/>
        …
      </after>

      <testedmodules>
        <tested package="balíček" />
      </testedmodules>

    </testmodule>

Atribut `type` poskytuje typ testů, které se mají v modulu spustit. „dogtail“ používá Python k vyvolání všech souborů .py. „ldtp“ vyvolá „ldtprunner run.xml“.

Pokud není nastavena volba noxvfb, je spuštěn server Xvfb, aby se v něm provedly testy.

#### metamodule

Prvek `metamodule` definuje modul, který ve skutečnosti nic nedělá. Jediným účelem takového modulu jsou jeho závislosti.

Například meta-gnome-desktop závisí na všech klíčkových komponentách uživatelského prostředí GNOME, a proto říká, ža má JHBuild ve skutečnosti nainstalovat kompletní uživatelské prostředí.

    <metamodule id="název_modulu">
      <dependencies>
        <dep package="název_modulu"/>
        …
      </dependencies>
      <suggests>
        <dep package="název_modulu"/>
        …
      </suggests>
    </metamodule>

Atribut `id` poskytuje názve modulu. Synovské prvky jsou obsluhovány podobně jako u `autotools`.

### Zavržené prvky

#### Zdroje modulů

##### cvsroot

Prvek `cvsroot` je nyní zavržený, místo něj by se měl použít prvek `repository`.

Prvek `csvroot` je použit k popisu repozitáře CVS.

      <cvsroot name="název_kořene"
               [ default="yes|no" ]
               root="kořen-anonymního-cvs"
               password="heslo-anonymního-cvs"/>

Atribut `name` by měl být jedinečný identifikátor pro repozitář CVS.

Atribut `default` říká, jestli se jedná o výchozí zdroj modulu pro tento soubor sady modulů.

Atribut `root` uvádí kořen CVS použitý pro anonymní přístup do tohoto repozitáře a atribut `password` poskytuje heslo použité pro anonymní přístup.

##### svnroot

Prvek `svnroot` je zavržený, místo něj by se měl použít prvek `repository`.

Prvek `svnroot` je použit k popisu repozitáře Subversion.

      <svnroot name="název_kořene"
               [ default="yes|no" ]
               href="kořen-anonymního-svn"/>

Atribut `name` by měl být jedinečný identifikátor pro repozitář Subversion.

Atribut `default` říká, jestli se jedná o výchozí zdroj modulu pro tento soubor sady modulů.

Atribut `href` uvádí základní adresu URL pro repozitář. Bude se nejspíše jednat o URL typu `http` nebo `https` nebo `svn`.

#### Zavržené typy modulů

Tento oddíl popisuje zavržené prvky, které je sice stále možné použít ve stávajících sadách modulů, ale není doporučováno je používat napříště.

##### tarball

Tento zastaralý prvek je jen lehkým obalením okolo typu modulu `autotools` a typem repozitáře `tarball`.

Prvek `tarball` se používá k definici modulu, který je sestavován z archivu tarball.

      <tarball id="název_modulu"
                  [ version="verze" ]
                  [ checkoutdir="složka_pro_stažení" ]
                  [ autogenargs="argumenty_pro_autogen" ]
                  [ makeargs="argumenty_pro_make" ]
                  [ autogen-sh="autogen-sh" ]
                  [ supports-non-srcdir-builds="yes|no" ]>
        <source href="url_zdrojových_kódů"
                [ size="velikost_zdrojových_kódů" ]
                [ hash="algoritmus:haš_zdrojových_kódů" ]
                [ md5sum="md5sum_zdrojových_kódů" ]/>
        <patches>
          <patch file="název_souboru" strip="level"/>
          …
        </patches>
        <dependencies>
          <dep package="název_modulu"/>
          …
        </dependencies>
        <suggests>
          <dep package="název_modulu"/>
          …
        </suggests>
      </tarball>

Atributy `id` a `version` se používají k identifikaci modulu.

Prvek `source` určuje soubor, který se má stáhnout a zkompilovat. Atribut `href` je povinný, zatímco atributy `size` a `hash`, stejně jako zastaralý atribut `md5sum`, jsou volitelné. Pokud se objeví poslední dva zmíněné atributy, použijí se ke kontrole, že byl balíček se zdrojovými kódy stažen v pořádku.

Prvek `patches` se používá k určení jedné nebo více záplat, které se mají použít na strom se zdrojovými kódy po jeho rozbalení. Atribut `file` poskytuje název souboru se záplatou a atribut `strip` říká, do jaké úrovně složek se má při použití záplaty jít.

Pro sady modulů šířené v rámci JHBuildu se soubory se záplatami hledají ve složce `jhbuild/patches/`. Pro sady modulů dané pomocí adresy URI se hledají ve stejné složce, jako soubor sady modulů nebo v její podsložce `patches/`. Je také možné pomocí atributu `file` určit adresu URI a pak budou záplaty staženy z příslušného umístění.

Ostatní atributy a prvky `dependencies`, `suggests` a `after` jsou zpracovány stejně jako v autotools.