Rukověť baliče RPM - III (Struktura spec souboru)

2. 6. 2005 | David Nečas | Návody | 10253×

Spec soubor popisuje veškerý průběh konfigurace, kompilace, balení a instalace nebo odinstalace.

Struktura spec souboru

Spec soubor je řádkově orientovaný. Zpětné lomítko v něm obecně nepřipojuje následující řádek; některé jeho části jsou ovšem skripty v shellu a v nich se spojování řádků chová, jak jsme zvyklí. Komentáře se označují standardně #:

# Toto je komentář

Procento je speciální znak (escape character); uvidíme-li procento, víme, že následuje nějaká vymyšlenost RPM, z nichž nejběžnější jsou makra a sekce spec souboru. Chceme-li napsat obyčejné procento, zdvojíme je: %%.

Spec soubor se skládá z hlavičky (preamble) a několika sekcí. Sekce začínají řádkem s názvem sekce

%description

a končí začátkem další sekce nebo koncem souboru. Na pořadí sekcí nezáleží, jsou ale jistá tradiční uspořádání, jež se vesměs dodržují.

Makra se zapisují %{název_makra}, případně jen %název_makra. Makra tedy vypadají stejně jako sekce, ale protože sekcí je jen několik a pevně daných, není problém s konflikty. Rozlišují se velká a malá písmena.

Hlavička začíná na začátku souboru a končí začátkem první sekce. Řádky hlavičky mají tvar název: hodnota, tedy např.:

License: GNU GPL

V názvech položek hlavičky se nerozlišují velká a malá písmena, tradičně se ovšem zapisují maďarskou notací (s velkými počátečními písmeny slov).

Pitva spec souboru

Velmi jednoduchý spec soubor lobster.spec, ke kterému by stačilo nahrát do SOURCES tarovou kouli lobster-1.10.tar.bz2, a mohli bychom zkompilovat binární rpm, by mohl vypadat kupříkladu:

Summary: A poor human doctor emulator
Name: lobster
Version: 1.10
Release: 1
License: GNU GPL
Group: Applications/Emulators
Source: ftp://ftp.example.com/pub/lobster/%{name}-%{version}.tar.bz2
Buildroot: %{_tmppath}/%{name}-%{version}-buildroot

%description
Lobster is a poor emulation of a human doctor, usually
expecting human body parts in completely wrong places,
or assuming people have various strange organs.
On the other hand it can successfully implant human
head to another body.  Lobster is a member of Planet
Express.

%prep
%setup

%build
%configure
make

%install
[ "$RPM_BUILD_ROOT" != "/" ] && rm -rf $RPM_BUILD_ROOT
make install DESTDIR=$RPM_BUILD_ROOT

%clean
[ "$RPM_BUILD_ROOT" != "/" ] && rm -rf $RPM_BUILD_ROOT

%files
%defattr(-,root,root)
%doc %{_mandir}/man1/lobster.1*
%{_bindir}/lobster
%doc README COPYING NEWS

Na to, že má být velmi jednoduchý, obsahuje tedy spoustu věcí. Snadno si v nich ale uděláme pořádek. Soubor začíná hlavičkou s informacemi o balíku (následující seznam položek hlavičky není zdaleka úplný, později si povíme o dalších):

Summary

Stručné jednořádkové shrnutí. Aby se ve výpisu rpm -qi vešlo na řádek i s úvodním Summary:, doporučuje se dodržovat délku do 56 znaků.

Name

Jméno balíčku.

Version

Verze programu.

Release

Vydání (release) balíčku. Vydáváme-li novou verzi rpm, aniž se změnila verze programu samého, zvětšíme číslo vydání.

License

Licence. Obvykle ji uvádíme běžnou zkratkou, obskurní licence se pokusíme alespoň nějak charakterizovat: „proprietary“ či „charityware, GPL compatible“.

Group

Skupina. Každý balíček patří do nějaké skupiny, a každá distribuce má bohužel jinou množinu skupin – zkuste se pak zavděčit všem. Seznam skupin pro vaši distribuci najdete v /usr/share/doc/rpm-verze/GROUPS nebo někde poblíž.

Source

Tarová koule se zdrojovým kódem. Píšeme sice URL, ale hlavně proto, abychom sami věděli, kde se zdrojový kód vzal, rpmbuild ji stejně bude hledat v SOURCES. Ve zdrojovém kódu RPM sice najdeme náznaky, že se přímé stahování (jako v Gentoo) zamýšlelo, ale zatím se rozhodně nic samo nestahuje.

Buildroot

Adresář, kam se bude program při balení instalovat. Uvedená hodnota je typická a prozatím ji necháme takto.

Po hlavičce následuje sekce %description s delším popisem balíku, který se vypisuje např. při rpm -qi. Píšeme ho zásadně anglicky, má-li být balík publikovatelný; stejně tak krátký popis (Summary), proto jsou anglicky i zde. Doplnění případných alternativních popisů v dalších jazycích si popíšeme ve čtrnáctém dílu.

Dále vidíme nějaká makra a sekce. Nebo spíš všude samá makra a sekce. Makra můžeme definovat i ve spec souboru, ale jelikož si nevzpomínáme, že bychom nějaká definovali, asi je definoval někdo jiný někde jinde. Řada maker je předdefinována – např. %{_tmppath}, které jsme shodou okolností měnili v ~/.rpmmacros. Silné povahy se mohou na vlastní riziko už teď podívat do souboru /usr/lib/rpm/macros, kde jsou definována standardní makra; slabším to zatím nedoporučuji. Další makra se definují automaticky podle položek hlavičky – např. %{name} obsahuje hodnotu položky Name a %{version} hodnotu položky Version.

Ve spec souboru definujeme makra direktivou %define, přičemž můžeme samozřejmě využívat již definovaná makra. Vyhodnocení probíhá až při expansi (použití) makra.

Praktický příklad: Programy často mají moduly či data v adresářích, jejichž název obsahuje verzi, ale ne celou, případně nějak transformovanou. Abychom nemuseli při kompilaci nové verze programu přepisovat ve spec souboru číslo verze na dvaceti místech ve třech růzých podobách a nevyhnutelně to někde splést, poskládáme pomocí maker všechny podoby z jediné výchozí definice:

%define version_major 2
%define version_minor 4
%define version_extra 7
%define pkgdir %{name}%{version_major}.%{version_minor}
…
Version: %{version_major}.%{version_minor}.%{version_extra}

Makro %pkgdir se pak expanduje na lobster2.4 a položka Version bude mít hodnotu 2.4.7.

Výkonná část souboru se skládá z několika sekcí, které odpovídají jednotlivým fázím balení a jimž se věnuje následující kapitola.

       

Komentáře

[Michal Marek (twofish)]

Je to feature, že rpmbuild expanduje makra i v komentářích? Třeba

...
%description
blah blah

#%debug_package
%prep
%setup
...

expanduje %debug_package a dopadne to takhle

...
Processing files: test-1-1
Processing files: test-debuginfo-1-1
error: Could not open %files file /home/michal/src/rpm/BUILD/test-1/debugfiles.list: \
No such file or directory

[unchallenger]

Je to feature.