Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 4.15 KB

README.md

File metadata and controls

105 lines (67 loc) · 4.15 KB
Raw

libdnf

This library provides a high level package-manager. It's core library of dnf, PackageKit and rpm-ostree. It's replacement for deprecated hawkey library which it contains inside and uses librepo under the hood.

⚠️ ⚠️ ⚠️ Note that libdnf is currently being reworked and is considered unstable. Once major users like PackageKit and DNF are fully ported, a new stable release will be considered. ⚠️ ⚠️ ⚠️

License

LGPLv2+

Building for Fedora

To install build requirements, run following command:

dnf install check-devel cmake cppunit-devel gcc gcc-c++ glib2-devel gpgme-devel gtk-doc json-c-devel libmodulemd-devel librepo-devel libsolv-devel libsolv-tools make python2-devel python3-devel python2-sphinx python3-sphinx python2-breathe python3-breathe rpm-devel sqlite-devel swig libsmartcols-devel

From the checkout dir:

mkdir build
cd build/
cmake .. -DPYTHON_DESIRED=3
make

Building the documentation, from the build/ directory::

make doc

Building RPMs:

tito build --rpm --test

Tests

All unit tests should pass after the build finishes:

cd build
make test

There are two parts of unit tests: unit tests in C and unit tests in Python. To run the C part of the tests manually, from hawkey checkout::

build/tests/test_main tests/repos/

To manually execute the Python tests, from libdnf git checkout directory::

PYTHONPATH=`readlink -f ./build/src/python/` python3 -m unittest discover -bt python/hawkey/tests/ -s python/hawkey/tests/tests/

The PYTHONPATH is unfortunately needed as the Python test suite needs to know where to import the built hawkey modules.

Contribution

Here's the most direct way to get your work merged into the project.

  1. Fork the project

  2. Clone down your fork

  3. Implement your feature or bug fix and commit changes

  4. If the change fixes a bug at Red Hat bugzilla, or if it is important to the end user, add the following block to the commit message:

    = changelog =
msg:           message to be included in the changelog
type:          one of: bugfix/enhancement/security (this field is required when message is present)
resolves:      URLs to bugs or issues resolved by this commit (can be specified multiple times)
related:       URLs to any related bugs or issues (can be specified multiple times)

    • For example::

      = changelog =
msg: Do not close the database if it wasn't opened
type: bugfix
resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1761976

    • For your convenience, you can also use git commit template by running the following command in the top-level directory of this project:

      git config commit.template ./.git-commit-template

  5. In a separate commit, add your name and email under Libdnf CONTRIBUTORS section in the authors file as a reward for your generosity

  6. Push the branch to your fork

  7. Send a pull request for your branch

Please do not create pull requests with translation (.po) file improvements. Fix the translation on Fedora Weblate <https://translate.fedoraproject.org/projects/dnf/>_ instead.

Documentation

See the hawkey documentation page.

Information internal to the hawkey development is maintained on a github wiki.

Useful links

Bug database: