From Fedora Project Wiki
(Build section)
Line 24: Line 24:
 
* Macro <code>%{preupg_number}</code> means source release from which the system is going to be upgraded, e.g. Fedora 22.
 
* Macro <code>%{preupg_number}</code> means source release from which the system is going to be upgraded, e.g. Fedora 22.
 
* Macro <code>%{postupg_number}</code> means target release to which the system is going to be upgraded, e.g. Fedora 23.
 
* Macro <code>%{postupg_number}</code> means target release to which the system is going to be upgraded, e.g. Fedora 23.
 +
* Macro <code>%{preupg_results}</code> means where the contents files are generated
 +
 +
== Prep section ==
 +
Copy all contents files to '''Fedora%{preupg_number}_%{postupg_number}/%{name}''' directory.
 +
 +
Content files are:
 +
* INI file
 +
* check_script (python or bash)
 +
* text file with solution description.
  
 
== Build section ==
 
== Build section ==
 
Run command:
 
Run command:
  %preupgrade_build Fedora%{preupg_number}_%{postupg_number}/
+
  %preupgrade_build Fedora%{preupg_number}_%{postupg_number}/%{name}/
 +
 
 +
%preupgrade_build command has to success. Warning can be suppressed.
  
 
== Install section ==
 
== Install section ==
Line 34: Line 45:
 
  ...
 
  ...
 
  mkdir -p ${buildroot}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
 
  mkdir -p ${buildroot}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
  cp preupgrade/* ${buildroot}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/
+
  cp Fedora%{preupg_number}_%{postupg_number}-%{preupg_results}/%{name}/* ${buildroot}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/
 
+
  rm -f Fedora%{preupg_number}_%{postupg_number}/%{name}/*.ini
== Check section ==
 
* %check_preupgrade needs to be run in %check section.
 
%check
 
  %check_preupgrade %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/
 
  
 
== Files section ==
 
== Files section ==
Line 50: Line 57:
 
  ...
 
  ...
 
  %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.{sh,py}
 
  %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.{sh,py}
  %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.ini
+
  %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.xml
 
* All text files from content should be listed via
 
* All text files from content should be listed via
 
  %files
 
  %files
Line 93: Line 100:
 
%prep
 
%prep
 
# Copy all content files to %{preupgrade_dir}
 
# Copy all content files to %{preupgrade_dir}
mkdir -p preupgrade
+
mkdir -p Fedora%{preupg_number}_%{postupg_number}/%{name}
cp %{SOURCEX} preupgrade/%{SOURCEX}
+
cp %{SOURCEX} Fedora%{preupg_number}_%{postupg_number}/%{name}/%{SOURCEX}
cp %{SOURCEY} preupgrade/%{SOURCEY}
+
cp %{SOURCEY} Fedora%{preupg_number}_%{postupg_number}/%{name}/%{SOURCEY}
cp %{SOURCEZ} preupgrade/%{SOURCEZ}
+
cp %{SOURCEZ} Fedora%{preupg_number}_%{postupg_number}/%{name}/%{SOURCEZ}
 +
 
 +
%build
 +
%preupgrade_build Fedora%{preupg_number}_%{postupg_number}/%{name}
  
 
%install
 
%install
 
mkdir -p %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
 
mkdir -p %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
cp preupgrade/* %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/
+
cp Fedora%{preupg_number}_%{postupg_number}-%{preupg_results}/%{name}/* %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/
 
 
%check
 
%check_preupg %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/
 
  
 
%files -n preupgrade-assistant-contents-%{name}
 
%files -n preupgrade-assistant-contents-%{name}
Line 109: Line 116:
 
%doc %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.txt
 
%doc %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.txt
 
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.{py,sh}
 
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.{py,sh}
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.ini
+
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.xml
 
</pre>
 
</pre>

Revision as of 16:29, 22 January 2015

Warning.png
This is a DRAFT.

Preupgrade Assistant contents Packaging guidelines

How to package a Preupgrade Assistant contents

Contents files are packaged as a subpackage of main package (e.g mariadb)

Naming guidelines

Every Preupgrade Assistant content subpackage name must start with preupgrade-assistant-contents- followed by original package name.

For example Preupgrade Assistant content subpackage for mariadb will be named preupgrade-assistant-contents-mariadb.

Dependencies

  • All packages must have
 Requires: preupgrade-assistant
 BuildRequires: preupgrade-assistant-devel

Devel package contains macros and contents validating check script.

Architecture

  • All preupgrade-assistant-contents-* subpackages must be architecture independent, i.e. have BuildArch: noarch.

Macros

  • Macro denoting the parent directory where the package files go is %{preupgrade_dir}. This currently expands to /usr/share/preupgrade.
  • Macro %{preupg_number} means source release from which the system is going to be upgraded, e.g. Fedora 22.
  • Macro %{postupg_number} means target release to which the system is going to be upgraded, e.g. Fedora 23.
  • Macro %{preupg_results} means where the contents files are generated

Prep section

Copy all contents files to Fedora%{preupg_number}_%{postupg_number}/%{name} directory.

Content files are:

  • INI file
  • check_script (python or bash)
  • text file with solution description.

Build section

Run command:

%preupgrade_build Fedora%{preupg_number}_%{postupg_number}/%{name}/

%preupgrade_build command has to success. Warning can be suppressed.

Install section

All files from preupgrade directory should be installed with

%install
...
mkdir -p ${buildroot}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
cp Fedora%{preupg_number}_%{postupg_number}-%{preupg_results}/%{name}/* ${buildroot}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/
rm -f Fedora%{preupg_number}_%{postupg_number}/%{name}/*.ini

Files section

  • Directory where Preupgrade Assistant installs files and directories must be owned by the subpackage
%files
...
%dir %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
  • All files except text files should be listed like
%files
...
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.{sh,py}
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.xml
  • All text files from content should be listed via
%files
...
%doc %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.txt

Directory ownership

Directories %{preupgrade_dir} and %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number} are owned by package preupgrade-assistant itself.

Sample SPEC

Snapshot of mariadb.spec


Name:             mariadb
Version:          %{compatver}.%{bugfixver}
Release:          4%{?with_debug:.debug}%{?dist}
Epoch:            1

Summary:          A community developed branch of MySQL
Group:            Applications/Databases
URL:              http://mariadb.org
# Exceptions allow client libraries to be linked with most open source SW,
# not only GPL code.  See README.mysql-license
License:          GPLv2 with exceptions and LGPLv2 and BSD

Source0:          http://mirrors.syringanetworks.net/mariadb/mariadb-%{version}/source/mariadb-%{version}.tar.gz

SourceX:          mariadb.ini
SourceY:          mariadb.sh
SourceZ:          mariadb.txt

%package -n preupgrade-assistant-contents-%{name}
BuildRequires:    preupgrade-assistant-devel
Requires:         preupgrade-assistant

%description -n preupgrade-assistant-contents-%{name}
The content is used for assessment before upgrading major release via fedup.

%prep
# Copy all content files to %{preupgrade_dir}
mkdir -p Fedora%{preupg_number}_%{postupg_number}/%{name}
cp %{SOURCEX} Fedora%{preupg_number}_%{postupg_number}/%{name}/%{SOURCEX}
cp %{SOURCEY} Fedora%{preupg_number}_%{postupg_number}/%{name}/%{SOURCEY}
cp %{SOURCEZ} Fedora%{preupg_number}_%{postupg_number}/%{name}/%{SOURCEZ}

%build
%preupgrade_build Fedora%{preupg_number}_%{postupg_number}/%{name}

%install
mkdir -p %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
cp Fedora%{preupg_number}_%{postupg_number}-%{preupg_results}/%{name}/* %{buildroor}%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/

%files -n preupgrade-assistant-contents-%{name}
%dir %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}
%doc %{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.txt
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.{py,sh}
%{preupgrade_dir}/Fedora%{preupg_number}_%{postupg_number}/%{name}/*.xml