EPEL:Packaging

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Created page with '== EPEL Specific Packaging Guidelines == This page contains guidelines which are no longer relevant to Fedora, but still apply to EPEL packages (EL-4 and/or EL-5). These guidelin...')
 
(Add scrollkeeper)
Line 3: Line 3:
  
 
As a reminder, these guidelines only apply to EPEL packages, not to Fedora packages.
 
As a reminder, these guidelines only apply to EPEL packages, not to Fedora packages.
 +
 +
{{Anchor|scrollkeeper}}
 +
== Scrollkeeper ==
 +
For EL-4 and EL-5, Gnome and KDE use the scrollkeeper cataloging system to keep track of documentation installed on the system.  Scrollkeeper allows the help system to sort and search documentation metadata stored in .omf files.  When you add documentation in these systems you need to make scrollkeeper aware that the documentation has been changed.
 +
 +
Note that we ''''''BuildRequires scrollkeeper as most Makefile's are setup to install the necessary scrollkeeper files only if scrollkeeper is present at install time.
 +
<pre>
 +
BuildRequires:  scrollkeeper
 +
Requires(post): scrollkeeper
 +
Requires(postun): scrollkeeper
 +
...
 +
%post
 +
scrollkeeper-update -q -o %{_datadir}/omf/%{name} || :
 +
 +
%postun
 +
scrollkeeper-update -q || :
 +
</pre>
 +
These two scriptlets tell scrollkeeper to update its indexes to account for the new scrollkeeper files.

Revision as of 19:15, 15 September 2009

EPEL Specific Packaging Guidelines

This page contains guidelines which are no longer relevant to Fedora, but still apply to EPEL packages (EL-4 and/or EL-5). These guidelines are designed to avoid conflict with the larger Fedora Packaging Guidelines, but should any conflicts occur, these guidelines should take precedence (on EPEL packages).

As a reminder, these guidelines only apply to EPEL packages, not to Fedora packages.

Scrollkeeper

For EL-4 and EL-5, Gnome and KDE use the scrollkeeper cataloging system to keep track of documentation installed on the system. Scrollkeeper allows the help system to sort and search documentation metadata stored in .omf files. When you add documentation in these systems you need to make scrollkeeper aware that the documentation has been changed.

Note that we 'BuildRequires scrollkeeper as most Makefile's are setup to install the necessary scrollkeeper files only if scrollkeeper is present at install time.

BuildRequires:  scrollkeeper
Requires(post): scrollkeeper
Requires(postun): scrollkeeper
...
%post
scrollkeeper-update -q -o %{_datadir}/omf/%{name} || :

%postun
scrollkeeper-update -q || :

These two scriptlets tell scrollkeeper to update its indexes to account for the new scrollkeeper files.