PackagingDrafts/WeakDependencies

Implementation Status / Todo

• Check repository meta data if createrepo is on proper version
• DNF:
  • add configuration option 'install_weak_deps' with allowed values auto/always/never for dealing with weak dependencies. The auto will be set by default. Auto will install recommended and supplemented packages only if there's no conflict.
  • add 'install_weak_deps' optional argument for dnf.Base.install/update methods
  • implement command 'install-recommended' which install recommended packages of already installed package and suggested packages.
  • implement plugin: when package is removed then it will added to recommend exclude set and will not be pulled in when another package recommends it during installation.
  • when showing the transaction confirmation overview, include packages that are recommended/suggested but will not be installed
  • (?) in the same overview, maybe show a section saying which packages can be removed from the transaction without breaking it? (they are in only because they are recommended)

Weak Dependencies Policy

Introduction

Weak dependencies are basically variant of the Requires: tag and are matched against (virtual) Provides: and package names using Epoch-Version-Release range comparisons - just like regular Requires. They come in two strengths: "weak" and "hint" and two directions "forward" (as are Requires) and "backwards":

	Forward	Backward
Weak	Recommends:	Supplements:
Hint	Suggests:	Enhances:

Weak dependencies allow smaller minimal installations while keeping the default installation feature rich. They also allow packages to specify preference for specific providers while maintaining the flexibility of virtual provides - e.g. preferring ruby vs jruby, community-mysql vs mariadb

Weak dependencies

Weak dependencies are by default treated similarly to regular Requires:. Matching packages are added to the transaction. If adding the package would lead to an error dnf will ignore the depenency. This allows users to exclude packages that would be added by weak dependencies or remove them later. In addition dnf can be told with XXX to ignore weak dependencies all together.

Weak dependencies though may only be used if not installing the target package will not create an error. But it is OK to create packages that are not useful without adding some of its weak requirements. Weak dependencies should be used were it allows to minimize the installation for reasonable use cases - especially for building virtual machines or containers that have a single purpose only and do not require the full feature set of the package.

Typical use cases for weak dependencies are:

• Documentation
  • Documentation viewers if missing them is handled gracefully
• Examples
• Plug-ins or add-ons
  • Support for file formats
  • Support for protocols
  • ...

Hints

Hints are by default ignored by dnf. They may be used by GUI tools to offer add-on packages that are not installed by default but might be useful in combination with the installed packages. Hint may not be used were the packages common use cases - use strong (Requires) or weak dependencies for that.

Forward vs Backward Dependencies

Forward dependencies are - as Requires - evaluated for packages that are being installed. The best of the matching (fulfilling) packages are also installed. For reverse dependencies the packages containing the dependency are installed if a matching package is getting installed also.

In general forward dependencies should be used. Add the dependency to the package getting the other package added to the system.

Reverse dependencies are mainly designed for 3rd party vendors which can attach their plug-ins/add-ons/extensions to distribution or other 3rd party packages. Within Fedora the control over which packages a package requires should stay with the package maintainer. But there are cases when it is easier for the requiring package not needing to care about all add-ons. In this cases reverse dependencies may be used with the agreement of the package maintainer of the targeted package.

Note, that EPEL or other third party repositories may have (and are encouraged to have) a different policy.

Package Preference

Dnf (or more precisely libsolv) will use weak dependencies and hints to decide which package to use if there are multiple equally valid packages to choose from. In these cases packages that are pointed at by dependencies from installed or to be installed packages are preferred. Note, that this does not alter the rules of dependency resolutions - e.g. weak dependencies cannot enforce a older version of a package to be chosen.

If there are multiple (typically virtual) providers for a dependencies the requiring package may add a Suggests: to hint for the preferred package. Enhances: should only be used for the rare occasion when the main package and other providers agree that adding the hint to the required package is for some reason the cleaner solution.

Real life example

Pkg A: Requires: mysql

Pkg mariadb: Provides: mysql

Pkg community-mysql: Provides: mysql

If you want to prefer mariadb instead of community-mysql -> add Suggests: mariadb into Pkg A spec or Enhances: A into Pkg mariadb spec. With help of Rich dependencies you could also change Requires: mariadb OR mysql in Pkg A - similar concept to Gentoo distro approach.

Compatibility

Weak dependencies are not supported and just ignored by yum . Therefore packages must not rely on weak dependencies up to Fedora 22 where yum is still supported. While hints can still be used Requires: must not be replaced by Recommends: until Fedora 23.