]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc/build.rst: build with 'apkg' added
authorAleš Mrázek <ales.mrazek@nic.cz>
Tue, 4 Oct 2022 13:34:46 +0000 (15:34 +0200)
committerAleš Mrázek <ales.mrazek@nic.cz>
Sun, 30 Oct 2022 00:48:47 +0000 (02:48 +0200)
doc/build.rst

index d3736586416c0f92ec971443ba3aa78651d719ae..710398e8d381cdddd53baa5da52213c9f2ce3997 100644 (file)
@@ -18,6 +18,49 @@ Beware that some 64-bit systems with LuaJIT 2.1 may be affected by
 
    $ git clone --recursive https://gitlab.nic.cz/knot/knot-resolver.git
 
+
+Building with `apkg`
+-------------------
+
+`apkg <https://pkg.labs.nic.cz/pages/apkg/>` is cross-distro upstream packaging automation tool that is also used by Knot Resolver.
+It allows you to locally build packages for supported distributions, which it then installs.
+`apkg` also takes care of dependencies itself.
+
+First, you need to install and setup `apkg`.
+
+.. code-block:: bash
+
+   $ pip3 install apkg
+   $ apkg system-setup
+
+
+Clone and change dir to `knot-resolver` git repository.
+
+.. code-block:: bash
+
+   $ git clone --recursive https://gitlab.nic.cz/knot/knot-resolver.git
+   $ cd knot-resolver
+
+
+.. tip:: The `apkg status` command can be used to find out useful information, such as whether the current distribution is supported.
+
+When the `apkg` is ready, the package can be build and installed.
+
+.. code-block:: bash
+
+   # takes care of dependencies
+   apkg build-dep
+
+   # build package
+   apkg build
+
+   # (build and) install package, builds package when it is not already built
+   apkg install
+
+
+After that Knot Resolver should be installed.
+
+
 Dependencies
 ------------