| 1 |
.\" Man page generated from reStructuredText |
| 2 |
.\" by the Docutils 0.22.4 manpage writer. |
| 3 |
. |
| 4 |
. |
| 5 |
.nr rst2man-indent-level 0 |
| 6 |
. |
| 7 |
.de1 rstReportMargin |
| 8 |
\\$1 \\n[an-margin] |
| 9 |
level \\n[rst2man-indent-level] |
| 10 |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 11 |
- |
| 12 |
\\n[rst2man-indent0] |
| 13 |
\\n[rst2man-indent1] |
| 14 |
\\n[rst2man-indent2] |
| 15 |
.. |
| 16 |
.de1 INDENT |
| 17 |
.\" .rstReportMargin pre: |
| 18 |
. RS \\$1 |
| 19 |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
| 20 |
. nr rst2man-indent-level +1 |
| 21 |
.\" .rstReportMargin post: |
| 22 |
.. |
| 23 |
.de UNINDENT |
| 24 |
. RE |
| 25 |
.\" indent \\n[an-margin] |
| 26 |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 27 |
.nr rst2man-indent-level -1 |
| 28 |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 29 |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
| 30 |
.. |
| 31 |
.TH "DNF5-MODULARITY" "7" "May 09, 2026" "" "dnf5" |
| 32 |
.SH NAME |
| 33 |
dnf5-modularity \- Modularity Overview |
| 34 |
.SH DESCRIPTION |
| 35 |
.sp |
| 36 |
Modularity is an alternative way of building, organizing and delivering packages. |
| 37 |
For more details see: \%<https://\:docs\:.pagure\:.org/\:modularity/>\&. |
| 38 |
.SH DEFINITIONS |
| 39 |
.INDENT 0.0 |
| 40 |
.TP |
| 41 |
.B modulemd |
| 42 |
Every repository can contain \fBmodules\fP metadata with modulemd documents. |
| 43 |
These documents hold metadata about modules such as \fBName\fP, \fBStream\fP or list of packages. |
| 44 |
.TP |
| 45 |
.B (non\-modular) package |
| 46 |
Package that doesn\(aqt belong to a module. |
| 47 |
.TP |
| 48 |
.B modular package |
| 49 |
Package that belongs to a module. It is listed in modulemd under the \fBartifacts\fP section. |
| 50 |
Modular packages can be also identified by having \fB%{modularitylabel}\fP RPM header set. |
| 51 |
.TP |
| 52 |
.B (module) stream |
| 53 |
Stream is a collection of packages, a virtual repository. It is identified with |
| 54 |
\fBName\fP and \fBStream\fP from modulemd separated with colon, for example \(dqpostgresql:9.6\(dq. |
| 55 |
.sp |
| 56 |
Module streams can be \fBactive\fP or \fBinactive\fP\&. \fBactive\fP means the RPM |
| 57 |
packages from this stream are included in the set of available packages. |
| 58 |
Packages from \fBinactive\fP streams are filtered out. Streams are |
| 59 |
\fBactive\fP either if marked as \fBdefault\fP or if they are explicitly |
| 60 |
\fBenabled\fP by a user action. Streams that satisfy dependencies of |
| 61 |
\fBdefault\fP or \fBenabled\fP streams are also considered \fBactive\fP\&. Only |
| 62 |
one stream of a particular module can be \fBactive\fP at a given point in |
| 63 |
time. |
| 64 |
.UNINDENT |
| 65 |
.SH PACKAGE FILTERING |
| 66 |
.sp |
| 67 |
Without modules, packages with the highest version are used by default. |
| 68 |
.sp |
| 69 |
Module streams can distribute packages with lower versions than available in the |
| 70 |
repositories available to the operating system. To make such packages available |
| 71 |
for installs and upgrades, the non\-modular packages are filtered out when their |
| 72 |
name or provide matches against a modular package name from any enabled, default, |
| 73 |
or dependent stream. Modular source packages will not cause non\-modular binary |
| 74 |
packages to be filtered out. |
| 75 |
.SH DEMODULARIZED RPMS |
| 76 |
.sp |
| 77 |
Contains names of RPMs excluded from package filtering for particular module stream. When defined in the latest active |
| 78 |
module, non\-modular RPMs with the same name or provide which were previously filtered out will reappear. |
| 79 |
.SH HOTFIX REPOSITORIES |
| 80 |
.sp |
| 81 |
In special cases, a user wants to cherry\-pick individual packages provided outside module |
| 82 |
streams and make them available on along with packages from the active streams. |
| 83 |
Under normal circumstances, such packages are filtered out or rejected from getting on the system by |
| 84 |
Fail\-safe mechanisms. |
| 85 |
To make the system use packages from a repository regardless of their modularity, |
| 86 |
specify \fBmodule_hotfixes=true\fP in the .repo file. This protects the repository from package filtering. |
| 87 |
.sp |
| 88 |
Please note the hotfix packages do not override module packages, they only become |
| 89 |
part of available package set. It\(aqs the package \fBEpoch\fP, \fBVersion\fP and \fBRelease\fP |
| 90 |
what determines if the package is the latest. |
| 91 |
.SH FAIL-SAFE MECHANISMS |
| 92 |
.SH REPOSITORIES WITH MODULE METADATA ARE UNAVAILABLE |
| 93 |
.sp |
| 94 |
When a repository with module metadata is unavailable, package filtering must keep working. |
| 95 |
Non\-modular RPMs must remain unavailable and must never get on the system. |
| 96 |
.sp |
| 97 |
This happens when: |
| 98 |
.INDENT 0.0 |
| 99 |
.IP \(bu 2 |
| 100 |
user disables a repository via \fB\-\-disable\-repo\fP or uses \fB\-\-repo\fP |
| 101 |
.IP \(bu 2 |
| 102 |
user removes a .repo file from disk |
| 103 |
.IP \(bu 2 |
| 104 |
repository is not available and has \fBskip_if_unavailable=true\fP |
| 105 |
.UNINDENT |
| 106 |
.sp |
| 107 |
DNF5 keeps copies of the latest modulemd for every active stream |
| 108 |
and uses them if there\(aqs no modulemd available for the stream. |
| 109 |
This keeps package filtering working correctly. |
| 110 |
.sp |
| 111 |
The copies are made any time a transaction is resolved and started. |
| 112 |
That includes RPM transactions as well as any \fBdnf5 module <enable|disable|reset>\fP operations. |
| 113 |
.sp |
| 114 |
When the fail\-safe data is used, DNF5 show such modules as part of @modulefailsafe repository. |
| 115 |
.SH ORPHANED MODULAR PACKAGES |
| 116 |
.sp |
| 117 |
All packages that are built as a part of a module have \fB%{modularitylabel}\fP RPM header set. |
| 118 |
If such package becomes part of RPM transaction and cannot be associated with any available |
| 119 |
modulemd, DNF5 prevents from getting it on the system (package is available, but cannot be |
| 120 |
installed, upgraded, etc.). Packages from Hotfix repositories or Commandline repository are not |
| 121 |
affected by Fail\-safe mechanisms. |
| 122 |
.SH Author |
| 123 |
See AUTHORS.md in dnf5 source distribution. |
| 124 |
.SH Copyright |
| 125 |
Contributors to the dnf5 project. |
| 126 |
.\" End of generated man page. |