Manjaro Difference between revisions of "Buildiso with AUR packages: Using buildpkg"

Difference between revisions of "Buildiso with AUR packages: Using buildpkg"

From Manjaro
imported>Fhdk
(Marked this version for translation)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
__TOC__
__TOC__


<translate>
<!--T:1-->
This tutorial is about creating your own online repository and building a custom package(set) with the help of ''buildpkg''. Later, you can install those packages to your customized Manjaro ISO using '''buildiso'''.


This tutorial is about creating your own online repository. This repository can be used to download (with the help of ''yaourt'') and build (with the help of ''buildpkg'') packages. Later, you can install those packages to your customized Manjaro ISO using ''buildiso''.
<!--T:2-->
 
 
Before you start with this tutorial make sure you have completed the prerequisite steps in [[Build Manjaro ISOs with buildiso]].
Before you start with this tutorial make sure you have completed the prerequisite steps in [[Build Manjaro ISOs with buildiso]].


<!--T:3-->
The same XFCE ISO profile will be used as example on this Wiki page.
The same XFCE ISO profile will be used as example on this Wiki page.


==Tools to install== <!--T:4-->
Sync your system with the latest packages and ensure you have the following packages installed.


==Create directories==
<!--T:5-->
 
* git
The first thing you should probably do is create a directory for your online repository. The online repository is called '''online-repo''' throughout this tutorial, you however are free to name it to your liking. This'll help keep things organized. Your repository will include two subdirectories for the different architectures:
* manjaro-tools-{base|base-git}
* manjaro-tools-{pkg|pkg-git}


  mkdir -p ~/online-repo/i686 ~/online-repo/x86_64
<!--T:6-->
It is important that you match your tools packages - don't mix the default and git packages.


This online repository is created in your home folder, but you can create it anywhere you want.
==Create directories== <!--T:7-->


<!--T:8-->
The first thing you should probably do is create a directory for your online repository. The online repository is called '''online-repo''' throughout this tutorial and it is located in your home-folder. You however are free to choose name location to your liking. This'll help keep things organized. Your repository consist of only this folder:


Next, you need to create a build directory. During the course of this tutorial you will need it as a temporary directory for files from the AUR:
<!--T:9-->
{{UserCmd|command=mkdir ~/online-repo/x86_64}}


  mkdir -p ~/online-build/
<!--T:10-->
 
This online repository is created in your home folder, but you can create it anywhere you want.
This temporary build directory is created in your home folder, but you can create it anywhere you want.
 
==Download package files from AUR using yaourt==
 
Now, go to your online build directory:
 
cd ~/online-build
 
Next do


yaourt -G <package name>
==Create your custom package tree== <!--T:11-->


in order to download package files from the AUR to your build directory. You will see a new directory with the package name. In it are various files, including a <code>PKGBUILD</code> file.
<!--T:12-->
Create a folder for the packages you want to build. The name is arbitrary decriptor - you can call it anything you think suitable.


===Example:===
<!--T:13-->
You want to add the package <code>pcmanfm-qt-git</code> to your ISO. Therefore, you need to download it to your online repository first. You download and unpack it using
{{UserCmd|command=mkdir ~/pkgbuild}}


yaourt -G pcmanfm-qt-git
<!--T:14-->
Clone the relevant package(s) from AUR or from Github. Later you might create them yourself! You can select any package to build but as example we build the package <code>kickshaw</code>. Kickshaw is modern menu editor for among others openbox. First you add it to your pkgubild repo. Do this using git


You see a new <code>PKGBUILD</code> file in your online build directory:
<!--T:15-->
{{UserCmd|command=cd ~/pkgbuild}}


~/online-build/pcmanfm-qt-git/PKGBUILD
<!--T:16-->
Clone the example package from AUR


<!--T:17-->
{{UserCmd|command=git clone <nowiki>https://aur.archlinux.org/kickshaw</nowiki>}}


==Building with buildpkg==
<!--T:18-->
Now you have a folder with a <code>PKGBUILD</code> file in your pkgbuild repository.


Up to this point, you have only downloaded and unpacked files from the AUR. Next, you need to build those files into proper packages:
<!--T:19-->
{{UserCmd|command=ls -R ~/pkgbuild}}


cd ~/online-build
<!--T:20-->
It is best practice to always familarize yourself with the content of the package to ensure everything is as expected.


buildpkg -p <package name>
==Building with buildpkg== <!--T:21-->


<!--T:22-->
The '''buildpkg''' has some options you need to familiarize yourself with.


If you want to build 32-Bit packages on a 64-Bit system, you can do this by specifying the architecture:
<!--T:23-->
{{File|file=buildpkg -h|content=<pre>
Usage: buildpkg [options]
  -p <pkg>          Build list or pkg [default: default]
  -a <arch>          Arch [default: x86_64]
  -b <branch>        Branch [default: unstable]
  -r <dir>          Chroots directory
                      [default: /var/cache/manjaro-tools]
  -i <pkgs>          Install packages into the working copy of the chroot
  -c                Recreate chroot
  -w                Clean up cache and sources
  -n                Install and run namcap check
  -s                Sign packages
  -u                Udev base-devel group (no systemd)
  -q                Query settings and pretend build
  -h                This help
</pre>}}


buildpkg -a i686 -p <package name>
<!--T:24-->
Next thing to do is build the package. Please note that you must be located one level above your actual PKGBUILD. Understand this as the <code>-p</code> argument is '''the name of the folder''' holding the PKGBUILD instructionset.


<!--T:25-->
{{UserCmd|command=buildpkg -p kickchaw}}


For more examples how to use ''buildpkg'', look [https://wiki.manjaro.org/index.php?title=Manjaro-tools#buildpkg here].
<!--T:26-->
For more examples how to use '''buildpkg''', look [https://wiki.manjaro.org/index.php?title=Manjaro-tools#buildpkg here].


===Example:===
<!--T:27-->
As instructed above, try to build <code>pcmanfm-qt-git</code>:
The buildpkg script creates a closed environment for building the package. This is done, so not to pollute your system with build artifacts.


buildpkg -p pcmanfm-qt-git
==Copy package files to online repository== <!--T:28-->


The build gets aborted with the following error message:
<!--T:29-->
The resulting package is saved in the location defined in your manjaro-tools.conf on your system (default is the cache folder)


==> Installing missing dependencies...
<!--T:30-->
error: target not found: liblxqt-git
{{UserCmd|command=ls /var/cache/manjaro-tools/pkg/stable/x86_64}}
==> ERROR: 'pacman' failed to install missing dependencies.


This means <code>liblxqt-git</code> is a dependency of <code>pcmanfm-qt-git</code>. You need to download and build <code>liblxqt-git</code> before you can build <code>pcmanfm-qt-git</code> successfully.
<!--T:31-->
Therefore, do the same (with one slight difference) as you did with <code>pcmanfm-qt-git</code>:
You should see compressed package files. The file name should end with <code>.pkg.tar.zst</code>.


yaourt -G liblxqt-git
<!--T:32-->
buildpkg '''-n''' -p liblxqt-git
Copy or move your package files to your online repository:


Please note the additional <code>-n</code> argument. This argument installs <code>liblxqt-git</code> in your build environment (<code>pcmanfm-qt-git</code> needs <code>liblxqt-git</code> installed in order to utilize it).
<!--T:33-->
{{UserCmd|command=mv /var/cache/manjaro-tools/pkg/stable/x86_64 ~/online-repo}}


Again, you receive an error:
==Build a .db file== <!--T:34-->


==> Installing missing dependencies...
<!--T:35-->
error: target not found: libqtxdg-git
To keep track of available packages the ''pacman'' package manager uses database files which is downloaded and kept on your computer. You need to create such a database file for your repo. It is crucial that your database filename is the same as your repo name. If your repo is named '''online-repo''' then your database name must be '''online-repo.db.tar.gz'''.
==> ERROR: 'pacman' failed to install missing dependencies.


So, <code>liblxqt-git</code> has another dependency: <code>libqtxdg-git</code>
<!--T:36-->
Repeat the whole process with <code>libqtxdg-git</code>:
Use the command <code>repo-add</code> to build a database file inside your designated repo folder


yaourt -G libqtxdg-git
<!--T:37-->
buildpkg -n -p libqtxdg-git
{{UserCmd|command=cd ~/online-repo/x86_64}}
{{UserCmd|command=repo-add online-repo.db.tar.gz *.pkg.tar.*}}
{{File|file=~/online-repo/x86_64|content=<pre>
kickshaw-0.5-2-x86_64.pkg.tar.zst
online-repo.db
online-repo.db.tar.gz
online-repo.files
online-repo.files.tar.gz
</pre>}}


Finally, a package gets built (and installed in your build environment) successfully!
<!--T:38-->
Every time you change the content of your online repository, the database must be rebuild! Otherwise, ''buildiso'' will complain later about missing packages in your online repository.


Now, build the other packages (in reverse order):
<!--T:39-->
Two of the files are symlinks which may or may not work on your chosen host so they can be left out.


buildpkg -n -p liblxqt-git
==Upload online-repo to Host Server== <!--T:40-->
buildpkg -p pcmanfm-qt-git


<!--T:41-->
Now you need to upload online-repo to your Host Server. Upload everything from online-repo to your Host Server. Your web address as to match the name of the directory folder you created. This is what your web address should look like after upload online-repo to your Host Server.


==Copy package files to online repository==
<!--T:42-->
<nowiki>http://www.myserver.com/repository/online-repo/x86_64/</nowiki>


In the last chapter you have built packages. These packages were created in this directory on your system:
==Add online-repo to your iso-profile== <!--T:43-->


/var/cache/manjaro-tools/
<!--T:44-->
Create a file
{{File|file=${profile_dir}/user-repos.conf|content=<pre>
[online-repo]
SigLevel = Never
Server = <nowiki>http://www.myserver.com/repository/online-repo/$repo/$arch</nowiki></pre>}}


On a 64-Bit system using the unstable branch the exact path is
<!--T:45-->
Custom online repositories will be added to the resulting '''pacman.conf'''. This means AUR packages cannot be installed unless you are using webserver to provide <code>[online-repo]</code> as shown this article).


/var/cache/manjaro-tools/pkg/unstable/x86_64
<!--T:56-->
NB: '''${profile_dir}''' is not the '''iso-profiles''' directory but the specific sub-directory for a build, e.g. '''iso-profiles/manjaro/kde'''. Put your file '''user-repos.conf''' there to be found during the build process.


You should see compressed package files. The file name should end with <code>.pkg.tar.xz</code>.
==Add package names to ISO profile== <!--T:46-->


<!--T:47-->
Now you add <code>kickshaw</code> to your package list for your ISO profile. This means your '''Packages-Desktop''' file should look something like this:


Move all package files to your online repository:
<!--T:48-->
{{File|file=~/iso-profiles/manjaro/xfce/Packages-Desktop|content=<pre>
ffmpegthumbnailer
gconf # fix qt-theme
gnome-keyring # fix wlan segfault
gufw # firewall
accountsservice
lightdm-gtk-greeter
lightdm-gtk-greeter-settings
light-locker
manjaro-settings-manager
menulibre


~/online-repo/x86_64
<!--T:49-->
## AUR packages
kickshaw</pre>}}


===Example:===
==Cleaning build environment== <!--T:50-->
Your online repository should now look like this:
 
liblxqt-git-0.8.0.23.g079768e-1-x86_64.pkg.tar.xz 
libqtxdg-git-1.0.0.7.g0503cf7-1-x86_64.pkg.tar.xz 
pcmanfm-qt-git-0.8.0.4.g99987af-1-x86_64.pkg.tar.xz
 
 
==Build a .db file==
 
Use the command <code>repo-add</code> to build a database file. Run the following commands in a terminal:
 
cd ~/online-repo/x86_64
repo-add online-repo.db.tar.gz *.pkg.tar.*
 
Every time you add packages to your online repositories, these commands need to be executed again! Otherwise, ''buildiso'' will complain later about missing packages in your online repository.
 
===Example:===
After running those commands, your online repository looks like this:
 
online-repo.db.tar
online-repo.db
liblxqt-git-0.8.0.23.g079768e-1-x86_64.pkg.tar.xz 
libqtxdg-git-1.0.0.7.g0503cf7-1-x86_64.pkg.tar.xz 
pcmanfm-qt-git-0.8.0.4.g99987af-1-x86_64.pkg.tar.xz
 
 
==Upload online-repo to Host Server==
 
Now you need to upload online-repo to your Host Server. Upload everything from online-repo to your Host Server. Your web address as to match the name of the directory folder you created.
 
===Example:===
This is what your web address should look like after upload online-repo to your Host Server.
 
64-Bit Repository
http://www.myserver.com/repository/online-repo/x86/
 
32-Bit Repository
http://www.myserver.com/repository/online-repo/i686
 
 
==Add online-repo to your iso-profile==
 
Create a file
 
${profile_dir}/user-repos.conf
 
Add these lines
 
[online-repo]
SigLevel = Never
Server = http://www.myserver.com/repository/online-repo/$repo/$arch
 
===Example:===
 
[online-repo]
SigLevel = Never
Server = http://www.myserver.com/repository/online-repo/$repo/$arch
 
Custom online repositories will get removed automatically from this file before it gets copied over to the installed system, whereas custom non-online repositories will be kept. This means AUR packages are best installed from a custom online repository (as demonstrated by <code>[online-repo]</code> in this tutorial). Packages neither available in the Manjaro repositories nor in the AUR are best installed from a custom non-online repository (see <code>[infinality-bundle]</code> as example).
 
==Add package names to ISO profile==
 
Using the example mentioned in [https://wiki.manjaro.org/index.php?title=Build_Manjaro_ISOs_with_buildiso#Packages-Xfce here], you can now add the AUR package names to your <code>Packages-Xfce</code> file.
 
Attention: You need to add all dependency names '''before''' the package name (only for dependencies from the AUR).
 
===Example:===
You can now add <code>pcmanfm-qt-git</code> to your package list for your ISO profile. This means your <code>/usr/share/manjaro-tools/iso-profiles/official/xfce/Packages-Xfce</code> file should look exactly like this:
 
## XFCE Main Packages
ffmpegthumbnailer
gconf # fix qt-theme
gnome-keyring # fix wlan segfault
gufw # firewall
accountsservice
lightdm-gtk-greeter
lightdm-gtk-greeter-settings
light-locker
manjaro-settings-manager
menulibre
...
## AUR packages
'''libqtxdg-git'''
'''liblxqt-git'''
'''pcmanfm-qt-git'''
 
The order of package installations to your ISO is from top to bottom. Please note the '''exact''' order of the last 3 packages. <code>pcmanfm-qt-git</code> depends on <code>liblxqt-git</code>, which depends on <code>libqtxdg-git</code> (see chapter 4.1). Therefore, <code>liblxqt-git</code> needs to be the first package, which gets installed!
 
 
=Cleaning build environment=


<!--T:51-->
For removing your build environment from your hard drive, execute:
For removing your build environment from your hard drive, execute:


sudo rm -r /var/lib/manjaro-tools/buildpkg
<!--T:52-->
{{UserCmd|command=sudo rm -r /var/lib/manjaro-tools/buildpkg}}


==NOTE== <!--T:53-->


=More=
<!--T:54-->
 
Now, you can continue to [https://wiki.manjaro.org/index.php?title=Build_Manjaro_ISOs_with_buildiso#manjaro-tools.conf adjust your manjaro-tools.conf] or [https://wiki.manjaro.org/index.php?title=Build_Manjaro_ISOs_with_buildiso#Build_your_ISO build your ISO].
Now, you can continue to [https://wiki.manjaro.org/index.php?title=Build_Manjaro_ISOs_with_buildiso#manjaro-tools.conf adjust your manjaro-tools.conf] or [https://wiki.manjaro.org/index.php?title=Build_Manjaro_ISOs_with_buildiso#Build_your_ISO build your ISO].


 
<!--T:55-->
Please remember to install <code>yaourt</code>, <code>octopi</code>, or <code>pamac</code> on your ISO, too. Only these Programs can update packages from the AUR.
Creating an online repo requires you to keep the repo up-to-date when changes are made upstream.
 
</translate>
 
[[Category:Contents Page{{#translation:}}]]
[[Category:Contents Page]]
[[Category:ISO{{#translation:}}]]
[[Category:Development{{#translation:}}]]

Latest revision as of 06:46, 13 May 2024

Other languages:
English • ‎русский

This tutorial is about creating your own online repository and building a custom package(set) with the help of buildpkg. Later, you can install those packages to your customized Manjaro ISO using buildiso.

Before you start with this tutorial make sure you have completed the prerequisite steps in Build Manjaro ISOs with buildiso.

The same XFCE ISO profile will be used as example on this Wiki page.

Tools to install

Sync your system with the latest packages and ensure you have the following packages installed.

  • git
  • manjaro-tools-{base|base-git}
  • manjaro-tools-{pkg|pkg-git}

It is important that you match your tools packages - don't mix the default and git packages.

Create directories

The first thing you should probably do is create a directory for your online repository. The online repository is called online-repo throughout this tutorial and it is located in your home-folder. You however are free to choose name location to your liking. This'll help keep things organized. Your repository consist of only this folder:

user $ mkdir ~/online-repo/x86_64 COPY TO CLIPBOARD


This online repository is created in your home folder, but you can create it anywhere you want.

Create your custom package tree

Create a folder for the packages you want to build. The name is arbitrary decriptor - you can call it anything you think suitable.

user $ mkdir ~/pkgbuild COPY TO CLIPBOARD


Clone the relevant package(s) from AUR or from Github. Later you might create them yourself! You can select any package to build but as example we build the package kickshaw. Kickshaw is modern menu editor for among others openbox. First you add it to your pkgubild repo. Do this using git

user $ cd ~/pkgbuild COPY TO CLIPBOARD


Clone the example package from AUR

user $ git clone https://aur.archlinux.org/kickshaw COPY TO CLIPBOARD


Now you have a folder with a PKGBUILD file in your pkgbuild repository.

user $ ls -R ~/pkgbuild COPY TO CLIPBOARD


It is best practice to always familarize yourself with the content of the package to ensure everything is as expected.

Building with buildpkg

The buildpkg has some options you need to familiarize yourself with.

buildpkg -h
Usage: buildpkg [options]
   -p <pkg>           Build list or pkg [default: default]
   -a <arch>          Arch [default: x86_64]
   -b <branch>        Branch [default: unstable]
   -r <dir>           Chroots directory
                      [default: /var/cache/manjaro-tools]
   -i <pkgs>          Install packages into the working copy of the chroot
   -c                 Recreate chroot
   -w                 Clean up cache and sources
   -n                 Install and run namcap check
   -s                 Sign packages
   -u                 Udev base-devel group (no systemd)
   -q                 Query settings and pretend build
   -h                 This help

Next thing to do is build the package. Please note that you must be located one level above your actual PKGBUILD. Understand this as the -p argument is the name of the folder holding the PKGBUILD instructionset.

user $ buildpkg -p kickchaw COPY TO CLIPBOARD


For more examples how to use buildpkg, look here.

The buildpkg script creates a closed environment for building the package. This is done, so not to pollute your system with build artifacts.

Copy package files to online repository

The resulting package is saved in the location defined in your manjaro-tools.conf on your system (default is the cache folder)

user $ ls /var/cache/manjaro-tools/pkg/stable/x86_64 COPY TO CLIPBOARD


You should see compressed package files. The file name should end with .pkg.tar.zst.

Copy or move your package files to your online repository:

user $ mv /var/cache/manjaro-tools/pkg/stable/x86_64 ~/online-repo COPY TO CLIPBOARD


Build a .db file

To keep track of available packages the pacman package manager uses database files which is downloaded and kept on your computer. You need to create such a database file for your repo. It is crucial that your database filename is the same as your repo name. If your repo is named online-repo then your database name must be online-repo.db.tar.gz.

Use the command repo-add to build a database file inside your designated repo folder

user $ cd ~/online-repo/x86_64 COPY TO CLIPBOARD


user $ repo-add online-repo.db.tar.gz *.pkg.tar.* COPY TO CLIPBOARD


~/online-repo/x86_64
kickshaw-0.5-2-x86_64.pkg.tar.zst
online-repo.db
online-repo.db.tar.gz
online-repo.files
online-repo.files.tar.gz

Every time you change the content of your online repository, the database must be rebuild! Otherwise, buildiso will complain later about missing packages in your online repository.

Two of the files are symlinks which may or may not work on your chosen host so they can be left out.

Upload online-repo to Host Server

Now you need to upload online-repo to your Host Server. Upload everything from online-repo to your Host Server. Your web address as to match the name of the directory folder you created. This is what your web address should look like after upload online-repo to your Host Server. 

http://www.myserver.com/repository/online-repo/x86_64/

Add online-repo to your iso-profile

Create a file

${profile_dir}/user-repos.conf
[online-repo]
SigLevel = Never
Server = http://www.myserver.com/repository/online-repo/$repo/$arch

Custom online repositories will be added to the resulting pacman.conf. This means AUR packages cannot be installed unless you are using webserver to provide [online-repo] as shown this article).

NB: ${profile_dir} is not the iso-profiles directory but the specific sub-directory for a build, e.g. iso-profiles/manjaro/kde. Put your file user-repos.conf there to be found during the build process.

Add package names to ISO profile

Now you add kickshaw to your package list for your ISO profile. This means your Packages-Desktop file should look something like this:

~/iso-profiles/manjaro/xfce/Packages-Desktop
ffmpegthumbnailer
gconf # fix qt-theme
gnome-keyring # fix wlan segfault
gufw # firewall
accountsservice
lightdm-gtk-greeter
lightdm-gtk-greeter-settings
light-locker
manjaro-settings-manager
menulibre

## AUR packages
kickshaw

Cleaning build environment

For removing your build environment from your hard drive, execute:

user $ sudo rm -r /var/lib/manjaro-tools/buildpkg COPY TO CLIPBOARD


NOTE

Now, you can continue to adjust your manjaro-tools.conf or build your ISO.

Creating an online repo requires you to keep the repo up-to-date when changes are made upstream.

Retrieved from "https://wiki.manjaro.org/index.php?title=Buildiso_with_AUR_packages:_Using_buildpkg&oldid=51739"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.