Skip to content

Commit

Permalink
[doc] Describe relation of dnf.conf with defaults in conf (RhBug:1738…
Browse files Browse the repository at this point in the history
…837)

Options skip_if_unavailable and best are shipped with different defaults
for particular distributions. Defaults are adjusted by different content
of dnf.conf. The patch mentions the situation for those two options.

https://bugzilla.redhat.com/show_bug.cgi?id=1738837
  • Loading branch information
j-mracek committed Sep 20, 2019
1 parent 1610071 commit 9e5d31f
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
8 changes: 6 additions & 2 deletions doc/api_conf.rst
Expand Up @@ -30,7 +30,10 @@ Configurable settings of the :class:`dnf.Base` object are stored into a :class:`

.. attribute:: best

Boolean option, ``True`` instructs the solver to either use a package with the highest available version or fail. On ``False``, do not fail if the latest version can not be installed. Default is ``True``.
Boolean option, ``True`` instructs the solver to either use a package with the highest available
version or fail. On ``False``, do not fail if the latest version can not be installed. Default
is ``False``. The default can be overridden by :ref:`DNF configuration file <conf_ref-label>`
that could differ for particular distribution.

.. attribute:: cachedir

Expand Down Expand Up @@ -186,7 +189,8 @@ Configurable settings of the :class:`dnf.Base` object are stored into a :class:`

If enabled, DNF will continue running and disable the repository that couldn't be synchronized
for any reason. This option doesn't affect skipping of unavailable packages after dependency
resolution. The default is ``False``.
resolution. The default is ``False``. The default can be overridden by
:ref:`DNF configuration file <conf_ref-label>` that could differ for particular distribution.

.. attribute:: sslcacert

Expand Down
17 changes: 9 additions & 8 deletions doc/cli_vs_yum.rst
Expand Up @@ -117,14 +117,15 @@ Also see related Fedora bugzillas `982947

.. _skip_if_unavailable_default:

============================================
``skip_if_unavailable`` enabled by default
============================================

The important system repos should never be down and we see the third-party repos
down often enough to warrant this change. Note that without this setting and
without an explicit ``skip_if_unavailable=True`` in the relevant repo .ini file
YUM immediately stops on a repo error, confusing and bothering the user.
====================================================
``skip_if_unavailable`` could be enabled by default
====================================================

In some distribution DNF is shipped with ``skip_if_unavailable=True`` in
:ref:`DNF configuration file <conf_ref-label>` file. The reason for the change are the third-party
repository that down often. Note that without this setting and without an explicit
``skip_if_unavailable=True`` in the relevant repo .ini file YUM immediately stops on a repo error,
confusing and bothering the user.

See the related `Fedora bug 984483 <https://bugzilla.redhat.com/show_bug.cgi?id=984483>`_.

Expand Down
5 changes: 4 additions & 1 deletion doc/conf_ref.rst
Expand Up @@ -75,7 +75,8 @@ or :ref:`mirrorlist <mirrorlist-label>` option definition.
When upgrading a package, always try to install its highest version
available, even only to find out some of its deps are not
satisfiable. Enable this if you want to experience broken dependencies in
the repositories firsthand. The default is False.
the repositories firsthand. The default is ``True``. The default can be overridden by
:ref:`DNF configuration file <conf_ref-label>` that could differ for particular distribution.

``cachedir``
:ref:`string <string-label>`
Expand Down Expand Up @@ -600,6 +601,8 @@ configuration.
for any reason. This option doesn't affect skipping of unavailable packages after dependency
resolution. To check inaccessibility of repository use it in combination with
:ref:`refresh command line option <refresh_command-label>`. The default is ``False``.
The default can be overridden by :ref:`DNF configuration file <conf_ref-label>` that could
differ for particular distribution.

.. _sslcacert-label:

Expand Down

0 comments on commit 9e5d31f

Please sign in to comment.