folkslinux
/
dnf5
mirror of https://github.com/rpm-software-management/dnf5.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Include modularity documentation

This commit is contained in:
Marek Blaha 2024-08-16 13:23:36 +02:00 committed by Petr Pisar
parent e725459f2a
commit ea4055fa38
6 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
dnf5.spec
View File

@ -333,8 +333,7 @@ It supports RPM packages, modulemd modules, and comps groups & environments.
%{_mandir}/man7/dnf*-filtering.7.*
%{_mandir}/man7/dnf*-forcearch.7.*
%{_mandir}/man7/dnf*-installroot.7.*
# TODO(jkolarik): modularity is not ready yet
# %%{_mandir}/man7/dnf*-modularity.7.*
%%{_mandir}/man7/dnf*-modularity.7.*
%{_mandir}/man7/dnf*-specs.7.*
%{_mandir}/man5/dnf*.conf.5.*
%{_mandir}/man5/dnf*.conf-todo.5.*

3
doc/CMakeLists.txt
View File

@ -91,8 +91,7 @@ if(WITH_MAN)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-filtering.7 DESTINATION share/man/man7)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-forcearch.7 DESTINATION share/man/man7)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-installroot.7 DESTINATION share/man/man7)
# TODO(jkolarik): modularity is not ready yet
# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-modularity.7 DESTINATION share/man/man7)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-modularity.7 DESTINATION share/man/man7)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/dnf5-specs.7 DESTINATION share/man/man7)
# plugin commands

2
doc/conf.py.in
View File

@ -156,7 +156,7 @@ man_pages = [
('misc/filtering.7', 'dnf5-filtering', 'Packages Filtering', AUTHORS, 7),
('misc/forcearch.7', 'dnf5-forcearch', 'Forcearch Parameter', AUTHORS, 7),
('misc/installroot.7', 'dnf5-installroot', 'Installroot Parameter', AUTHORS, 7),
# TODO(jkolarik): ('misc/modularity.7', 'dnf5-modularity', 'Modularity Overview', AUTHORS, 7),
('misc/modularity.7', 'dnf5-modularity', 'Modularity Overview', AUTHORS, 7),
('misc/specs.7', 'dnf5-specs', 'Patterns Specification', AUTHORS, 7),
('dnf_daemon/dnf5daemon_client.8', 'dnf5daemon-client', 'Command-line interface for Dnf5daemon', AUTHORS, 8),
('dnf_daemon/dnf5daemon_server.8', 'dnf5daemon-server', 'Package management service with a DBus interface', AUTHORS, 8),

2
doc/misc/filtering.7.rst
View File

@ -61,7 +61,7 @@ For details see :manpage:`dnf5-versionlock(8)`, :ref:`Versionlock command <versi
Modular filtering
=================
Please see `the modularity documentation` for details on how Modular Filtering works.
For details on how modular filtering works please see :manpage:`dnf5-modularity(7)`, :ref:`the modularity documentation <modularity_misc_ref-label>`.
With modularity, only RPM packages from ``active`` module streams are included in the available package set. RPM packages from ``inactive`` module streams, as well as non-modular packages with the same name or provides as a package from an ``active`` module stream, are filtered out. Modular filtering is not applied to packages added from the command line, installed packages, or packages from repositories with ``module_hotfixes=true`` in their ``.repo`` file.

6
doc/misc/index.rst
View File

@ -12,9 +12,5 @@ Miscellaneous
filtering.7
forcearch.7
installroot.7
specs.7
..
# TODO(jkolarik): Modularity is not ready yet
modularity.7
specs.7

10
doc/misc/modularity.7.rst
View File

@ -104,18 +104,18 @@ Non-modular RPMs must remain unavailable and must never get on the system.
This happens when:
* user disables a repository via ``--disablerepo`` or uses ``--repoid``
* user disables a repository via ``--disable-repo`` or uses ``--repo``
* user removes a .repo file from disk
* repository is not available and has ``skip_if_unavailable=true``
DNF keeps copies of the latest modulemd for every active stream
DNF5 keeps copies of the latest modulemd for every active stream
and uses them if there's no modulemd available for the stream.
This keeps package filtering working correctly.
The copies are made any time a transaction is resolved and started.
That includes RPM transactions as well as any ``dnf module <enable|disable|reset>`` operations.
That includes RPM transactions as well as any ``dnf5 module <enable|disable|reset>`` operations.
When the fail-safe data is used, dnf show such modules as part of @modulefailsafe repository.
When the fail-safe data is used, DNF5 show such modules as part of @modulefailsafe repository.
Orphaned modular packages
@ -123,6 +123,6 @@ Orphaned modular packages
All packages that are built as a part of a module have ``%{modularitylabel}`` RPM header set.
If such package becomes part of RPM transaction and cannot be associated with any available
modulemd, DNF prevents from getting it on the system (package is available, but cannot be
modulemd, DNF5 prevents from getting it on the system (package is available, but cannot be
installed, upgraded, etc.). Packages from Hotfix repositories or Commandline repository are not
affected by Fail-safe mechanisms.