View source for Spec-helper

[[Category:Packaging Guidelines]]
{{introduction|Implementing build policies with spec-helper}}

__TOC__

= How it works =
Spec-helper provides a set ot scripts that are automatically launched during the build process to ease the creation of rpm packages conforming to ROSA Linux packaging policies.

For example, ROSA Linux policy states that {{prog|man}} pages should be compressed with {{prog|xz}}, amongst others. In order to ease the creation of packages, and to keep them as vendor neutral as possible, we use a hook in {{prog|rpm}} to automatically enforce the policy.

Take a look at {{file|/usr/lib/rpm/brp-*}} files. These are the "build root policies", which is a set of rules to be applied after the build. The configuration of the BRP is made by using a macro, {{macro|%_os_install_post}}. For ROSA Linux, you can see it in {{file|/usr/lib/rpm/}}.

So, we see that most of the {{prog|/usr/lib/rpm/brp-*}} files are run when an rpm is built.

Scripts used by spec-helper are located at {{file|/usr/share/spec-helper}} folder. The scripts which will be actually launched are set in the {{file|/etc/rpm/macros.d/spec-helper.macros}} file. We will describe how to add a script to {{prog|spec-helper}}.

= Writing the script =

First, find a name for your script. To give a full exemple, we will add a script that runs [http://pmt.sourceforge.net/pngcrush/ pngcrush] on each {{file|png}} in an rpm. Let's call it {{prog|png_crush_rpm}}. Don't use {{prog|pngcrush}}, because this is already a valid executable on the system. Since {{prog|/usr/share/spec_helper}} is added to the path by the script, it will not work as expected.

It seems that you have a choice for the language. In the current {{prog|spec-helper}} we have scripts in {{prog|perl}}, {{prog|bash}} and {{prog|python}} script. In the examples below, we will use shell.

You can use any language, but remember that using a new language will add a dependancy to the {{pkg|spec-helper}} rpm. Using a new program, such as {{prog|pngcrush}} will also add more dependencies, that should be added to the rpm. Please keep this in mind.

So all you have to do is to apply your script to {{var|$RPM_BUILD_ROOT}}. Don't forget to check if the variable is defined, and it is a valid directory. You should exit in case of problem.

<pre>
#!/bin/sh

# test if $RPM_BUILD_ROOT is set
if [ -z $RPM_BUILD_ROOT ]; then
   exit 0
fi;

# check if it is a valid directory.
[ -d $RPM_BUILD_ROOT ] || exit 0

# find each png, and crush it.
for i in ind $RPM_BUILD_ROOT -type f -name '*.png' ; do
   pngcrush -q $i $i.new
   mv -f $i.new $i
done;
</pre>

Do not forget to set the executable (<b>+x</b>) bit on the file.

Test it by defining <b>RPM_BUILD_ROOT</b> by hand, and check if this is correct.

= Adding the test to spec-helper =

Now we should add it to {{prog|spec-helper}}.

You should add an option to be able to not run the script to {{prog|spec-helper}}. So add these other options:

<pre>
echo "-png don't run pngcrsuh on png." 1>&2
</pre>

and 

<pre>
-png) DONT_PNG_CRUSH=1;;
</pre>

in the switch/case.

Now all that remains is to invoke your script:

<pre>
test -z "$DONT_PNG_CRUSH" && echo -n "Recompressing png..." && png_crush_rpm && echo "done"
</pre>

And now, {{prog|rpm}} will run your script when rebuilding.

Test it, and if you find it is useful, send your patch to ROSA Linux developers.

= Disabling a build policy in a specfiles =

Sometimes, build policies can have an unwanted effect. One example is when you do not want to strip your executable, for debugging purposes.  You can disable it by setting the correct variable in the {{macro|%install}} section :

<pre>
%install
rm -rf %{buildroot}
%makeinstall
....
# prevent the stripping of executable 
export DONT_STRIP=1

%clean
</pre>

See the {{file|/etc/rpm/macros.d/spec-helper.macros}} file for the list of possible variables.  Here is a list ( may not be current ) :

* {{var|DONT_CLEANUP}}, do not remove backup and useless files
* {{var|DONT_CLEAN_PERL}},  remove some {{prog|perl}} files not needed ( {{file|.packlist}}, etc. )
* {{var|DONT_COMPRESS}}, compress manpages and info files in bz2
* {{var|DONT_STRIP}}, strip object files and executable
* {{var|DONT_RELINK}}, relativise symlinks
* {{var|DONT_SYMLINK_LIBS}}, create a symlink of the library
* {{var|DONT_GPRINTIFY}}, replace echo by grpintf in initscript ( see [[Initscripts policy]] )
* {{var|DONT_FIX_PAMD_CONFIGS}}, fix {{file|/lib}} for {{file|/lib64}} in {{prog|pam}} configs
* {{var|DONT_REMOVE_INFO_DIR}}, remove {{file|/usr/share/info/dir/}}
* {{var|DONT_FIX_MO}},  fix some translations
* {{var|DONT_TRANSLATE_MENU}}, translate the menu section from the old scheme to the new one ( see [[Development/Howto/MenuSystem|Menu System Howto]] ).

<hr>

{{message|This page is based on the [http://wiki.mandriva.com/en/Development/Tasks/Packaging/Tools/spec-helper Mandriva spec-helper description].}}