diff --git a/doc/changes.rst b/doc/changes.rst index 33d3006bd..f9bf7ca4d 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -411,11 +411,18 @@ Changes to individual options * Supported values are now extended to the following list: ``comps``, ``filelists``, ``other``, ``presto``, ``updateinfo``. -Newly introduced options ------------------------- +Newly introduced configuration options +-------------------------------------- ``allow_downgrade`` * New option used to enable or disable downgrade of dependencies when resolving transaction. ``skip_broken``, ``skip_unavailable``, ``strict`` * New options ``skip_broken``, ``skip_unavailable`` were added due to deprecation of ``strict`` option. * See the :ref:`strict deprecation ` above. + + +Dropped configuration options +----------------------------- +``arch`` and ``basearch`` + * It is no longer possible to change the detected architecute in configuration files. + * See the :manpage:`dnf5-forcearch(7)`, :ref:`Forcearch parameter ` for overriding architecture. diff --git a/doc/dnf5.conf-todo.5.rst b/doc/dnf5.conf-todo.5.rst index affa6789e..f9e385c44 100644 --- a/doc/dnf5.conf-todo.5.rst +++ b/doc/dnf5.conf-todo.5.rst @@ -33,10 +33,6 @@ This section does not track any deprecated option. For such options see :ref:`De [main] Options ============== -.. _arch_options-label: - -``arch`` - .. _autocheck_running_kernel_options-label: ``autocheck_running_kernel`` @@ -49,10 +45,6 @@ This section does not track any deprecated option. For such options see :ref:`De .. NOTE:: YUM compatibility option -.. _basearch_options-label: - -``basearch`` - .. _logfilelevel_options-label: ``logfilelevel`` @@ -61,26 +53,14 @@ This section does not track any deprecated option. For such options see :ref:`De ``log_compress`` -.. _transaction_history_dir_options-label: - -``transaction_history_dir`` - .. _transformdb_options-label: ``transformdb`` -.. _recent_options-label: - -``recent`` - .. _reset_nice_options-label: ``reset_nice`` -.. _system_cachedir_options-label: - -``system_cachedir`` - .. _debuglevel_options-label: ``debuglevel`` @@ -91,10 +71,6 @@ This section does not track any deprecated option. For such options see :ref:`De Default: ``2``. -.. _debugdir_options-label: - -``debugdir`` - .. _diskspacecheck_options-label: ``diskspacecheck`` @@ -149,20 +125,6 @@ This section does not track any deprecated option. For such options see :ref:`De Default: ``False``. -.. _use_host_config_options-label: - -``use_host_config`` - -.. _config_file_age_options-label: - -``config_file_age`` - -.. _allow_downgrade_options-label: - -``allow_downgrade`` - -.. _bugtracker_url_options-label: - ``bugtracker_url`` .. _history_record_options-label: @@ -173,14 +135,6 @@ This section does not track any deprecated option. For such options see :ref:`De ``history_record_packages`` -.. _skip_broken_options-label: - -``skip_broken`` - -.. _skip_unavailable_options-label: - -``skip_unavailable`` - .. _history_list_view_options-label: ``history_list_view`` @@ -189,22 +143,6 @@ This section does not track any deprecated option. For such options see :ref:`De ``comment`` -.. _downloadonly_options-label: - -``downloadonly`` - -.. _build_cache_options-label: - -``build_cache`` - -.. _exclude_from_weak_options-label: - -``exclude_from_weak`` - -.. _exclude_from_weak_autodetect_options-label: - -``exclude_from_weak_autodetect`` - .. _releasever_options-label: ``releasever`` @@ -218,15 +156,6 @@ This section does not track any deprecated option. For such options see :ref:`De Default: ``False``. -.. _module_stream_switch_options-label: - -``module_stream_switch`` - :ref:`boolean ` - - If enabled, allows switching enabled streams of a module. - - Default: ``False``. - .. _rpmverbosity_options-label: ``rpmverbosity`` @@ -302,50 +231,14 @@ This section does not track any deprecated option. For such options see :ref:`De Repo Options ============ -.. _baseurl_repo_options-label: - -``baseurl`` - -.. _cost_repo_options-label: - -``cost`` - -.. _gpgcheck_options-label: - -``gpgcheck`` - -.. _gpgkey_repo_options-label: - -``gpgkey`` - -.. _metalink_repo_options-label: - -``metalink`` - .. _metadata_timer_sync_options-label: ``metadata_timer_sync`` -.. _mirrorlist_repo_options-label: - -``mirrorlist`` - .. _module_hotfixes_repo_options-label: ``module_hotfixes`` -.. _name_repo_options-label: - -``name`` - -.. _priority_repo_options-label: - -``priority`` - -.. _type_repo_options-label: - -``type`` - Repo Variables ============== diff --git a/doc/dnf5.conf.5.rst b/doc/dnf5.conf.5.rst index fdd5c9e07..63b3a3800 100644 --- a/doc/dnf5.conf.5.rst +++ b/doc/dnf5.conf.5.rst @@ -41,6 +41,15 @@ repository configuration file should aside from repo ID consists of baseurl, met [main] Options ============== +.. _allow_downgrade_options-label: + +``allow_downgrade`` + :ref:`boolean ` + + If enabled, DNF5 allows downgrading packages while resolving dependencies. + + Default: ``True``. + .. _allow_vendor_change_options-label: ``allow_vendor_change`` @@ -147,13 +156,23 @@ repository configuration file should aside from repo ID consists of baseurl, met Default: ``True``. +.. _debugdir_options-label: + +``debugdir`` + :ref:`string ` + + Location where libsolv debug files will be created when enabled + by :ref:`debug_solver <_debug_solver_options-label>`. + + Default `./debugdata`. + .. _debug_solver_options-label: ``debug_solver`` :ref:`boolean ` If enabled, libsolv debug files will be created when solving the - transaction. The debug files are created in the `./debugdata` directory. + transaction. The debug files are created in the :ref:`debugdir <_debugdir_options-label>` directory. Default: ``False``. @@ -176,6 +195,29 @@ repository configuration file should aside from repo ID consists of baseurl, met Default: `>/packages +.. _exclude_from_weak_options-label: + +``exclude_from_weak`` + :ref:`list ` + + Prevent installing packages as weak dependencies (recommends or + supplements). The packages can be specified by a name or a glob and + separated by a comma. + + Defaults to []. + +.. _exclude_from_weak_autodetect_options-label: + +``exclude_from_weak_autodetect`` + :ref:`boolean ` + + If enabled, DNF5 will autodetect unmet weak dependencies (recommends or + supplements) of packages installed on the system. Providers of these weak + dependencies will not be installed by dnf as weak dependencies any more + (they will still be installed if pulled in as a regular dependency). + + Defaults to true. + .. _group_package_types_options-label: ``group_package_types`` @@ -304,6 +346,15 @@ repository configuration file should aside from repo ID consists of baseurl, met Default: empty. +.. _module_stream_switch_options-label: + +``module_stream_switch`` + :ref:`boolean ` + + If enabled, allows switching enabled streams of a module. + + Default: ``False``. + .. _multilib_policy_options-label: ``multilib_policy`` @@ -357,7 +408,7 @@ repository configuration file should aside from repo ID consists of baseurl, met ``pluginconfpath`` :ref:`list ` - List of directories that are searched for plugin configurations to load. + List of directories that are searched for libdnf5 plugin configurations to load. All configuration files found in these directories, that are named same as a plugin, are parsed. @@ -369,7 +420,7 @@ repository configuration file should aside from repo ID consists of baseurl, met ``pluginpath`` :ref:`list ` - List of directories that are searched for plugins to load. Plugins found in + List of directories that are searched for libdnf5 plugins to load. Plugins found in *any of the directories* in this configuration option are used. Default: a Python version-specific path. @@ -379,7 +430,7 @@ repository configuration file should aside from repo ID consists of baseurl, met ``plugins`` :ref:`boolean ` - If enabled, DNF5 plugins are enabled. + If enabled, libdnf5 plugins are enabled. Default: ``True``. @@ -413,6 +464,16 @@ repository configuration file should aside from repo ID consists of baseurl, met .. NOTE:: YUM compatibility option +.. _recent_options-label: + +``recent`` + :ref:`integer ` + + Sets the time period in days used for the ``--recent`` option in the :ref:`repoquery `, + :ref:`info ` and :ref:`list ` commands. + + Default: 7 + .. _reposdir_options-label: ``reposdir`` @@ -423,7 +484,27 @@ repository configuration file should aside from repo ID consists of baseurl, met The behavior of ``reposdir`` could differ when it is used along with \-\ :ref:`-installroot ` option. - Default: TODO add default + Default: [``/etc/yum.repos.d``, ``/etc/distro.repos.d``, ``/usr/share/dnf5/repos.d``] + +.. _skip_broken_options-label: + +``skip_broken`` + :ref:`boolean ` + + If enabled, DNF5 will skip uninstallable packages instead of failing while + resolving dependencies. + + Default: ``False``. + +.. _skip_unavailable_options-label: + +``skip_unavailable`` + :ref:`boolean ` + + If enabled, DNF5 will skip unavailable packages instead of failing while + preparing rpm transactions. + + Default: ``False``. .. _system_cachedir_options-label: @@ -446,6 +527,16 @@ repository configuration file should aside from repo ID consists of baseurl, met Default: ``/usr/lib/sysimage/libdnf5``. +.. _transaction_history_dir_options-label: + +``transaction_history_dir`` + + :ref:`string ` + + History database location. + + By default it has the same value as :ref:`system_state_dir <_system_state_dir_options-label>`. + .. _tsflags_options-label: ``tsflags`` @@ -483,6 +574,12 @@ repository configuration file should aside from repo ID consists of baseurl, met ``use_host_config`` + Use configuration files and variable definitions from the host system rather + than the installroot. + :ref:`See ` :manpage:`dnf5-installroot(7)` for more info. + + Default: ``False``. + .. _varsdir_options-label: ``varsdir`` @@ -590,7 +687,28 @@ repository configuration file should aside from repo ID consists of baseurl, met Repo Options ============ -.. _enabled_options-label: +.. _baseurl_repo_options-label: + +``baseurl`` + :ref:`list ` + + List of URLs for the repository. + + Default []. + + URLs are tried in the listed order (equivalent to yum’s “failovermethod=priority” behaviour). + +.. _cost_repo_options-label: + +``cost`` + :ref:`integer ` + + The relative cost of accessing this repository, defaulting to 1000. This + value is compared when the priorities of two repositories are the same. The + repository with the lowest cost is picked. It is useful to make the library + prefer on-disk repositories to remote ones. + +.. _enabled_repo_options-label: ``enabled`` :ref:`boolean ` @@ -599,6 +717,66 @@ Repo Options Default: ``True``. +.. _gpgkey_repo_options-label: + +``gpgkey`` + :ref:`list ` + + URLs of a GPG key files that can be used for signing metadata and packages + of this repository. If a file can not be verified using + the already imported keys, import of keys from this option is attempted and + the keys are then used for verification. + + Default: ``[]`` + +.. _metalink_repo_options-label: + +``metalink`` + :ref:`string ` + + URL of a metalink for the repository. + + Default: ``None``. + +.. _mirrorlist_repo_options-label: + +``mirrorlist`` + :ref:`string ` + + URL of a mirrorlist for the repository. + + Default: ``None``. + + +.. _name_repo_options-label: + +``name`` + :ref:`string ` + + A human-readable name of the repository. Defaults to the ID of the repository. + +.. _priority_repo_options-label: + +``priority`` + :ref:`integer ` + + The priority value of this repository. If there is more than + one candidate package for a particular operation, the one from a repo with + the lowest priority value is picked, possibly despite being less convenient + otherwise (e.g. by being a lower version). + + Default: 99 + +.. _type_repo_options-label: + +``type`` + :ref:`string ` + + Type of repository metadata. Supported values are: ``rpm-md``. Aliases for + ``rpm-md``: ``rpm``, ``repomd``, ``rpmmd``, ``yum``, ``YUM``. + + Default: empty. + Source and debuginfo repository names ===================================== @@ -669,6 +847,17 @@ configuration. Default: ``0``. +.. _build_cache_options-label: + +``build_cache`` + :ref:`boolean ` + + If enabled, DNF5 will save libsolv cache generated from downloaded metadata + to cachedir. These solv files are loaded during subsequent runs which + significantly speeds up DNF5. + + Default: ``True``. + .. _countme_options-label: ``countme`` @@ -783,6 +972,18 @@ configuration. Default: ``False``. +.. _gpgcheck_options-label: + +``gpgcheck`` + :ref:`boolean ` + + Whether to perform GPG signature check on packages found in this repository. + + The default is False. + + Doesn't apply for packages passed directly as arguments, as they are not in any repository, + see :ref:`localpkg_gpgcheck `. + .. _includepkgs_options-label: ``includepkgs`` @@ -818,9 +1019,6 @@ configuration. If enabled, DNF5 will perform a GPG signature check on local packages (packages in a file, not in a repository). - This option is subject to the active RPM security policy - (see :ref:`gpgcheck ` for more details). - Default: ``False``. .. _max_parallel_downloads_options-label: