[doc] Change description of skip_if_unavailable option

skip_if_unavailable option is now not only a repo option but also option of the main config. The commit provides a enhanced description. Additionally there is a change in default. Formerly it was skip_if_unavailable=true, but it was changed to False to provide a better security to users. The commit also change the description according to new default.
rpm-software-management · Mar 22, 2019 · e0ba4a1 · e0ba4a1
1 parent f5a8d97
commit e0ba4a1
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 8 deletions.
diff --git a/doc/api_conf.rst b/doc/api_conf.rst
@@ -182,6 +182,12 @@ Configurable settings of the :class:`dnf.Base` object are stored into a :class:`
 
     Number of times any attempt to retrieve a file should retry before returning an error. Setting this to `0` makes it try forever. Defaults to `10`.
 
+  .. attribute:: skip_if_unavailable
+
+    If enabled, DNF will continue running and disable the repository that couldn't be contacted for
+    any reason when downloading metadata. This option doesn't affect skipping of unavailable
+    packages after dependency resolution. The default is ``False``.
+
   .. attribute:: sslcacert
 
     Path to the directory or file containing the certificate authorities to verify SSL certificates.

diff --git a/doc/api_repos.rst b/doc/api_repos.rst
@@ -164,7 +164,10 @@ Repository Configuration
 
   .. attribute:: skip_if_unavailable
 
-    If enabled, DNF will continue running and disable the repository that couldn't be contacted for any reason when downloading metadata. This option doesn't affect skipping of unavailable packages after dependency resolution. The default is ``True``.
+    If enabled, DNF will continue running and disable the repository that couldn't be contacted for
+    any reason when downloading metadata. This option doesn't affect skipping of unavailable
+    packages after dependency resolution. The default is inherited from
+    :attr:`dnf.conf.Conf.skip_if_unavailable`.
 
   .. attribute:: sslcacert
 

diff --git a/doc/conf_ref.rst b/doc/conf_ref.rst
@@ -357,13 +357,6 @@ or :ref:`mirrorlist <mirrorlist-label>` option definition.
 
     Overrides the retries option from the [main] section for this repository.
 
-.. _skip_if_unavailable-label:
-
-``skip_if_unavailable``
-    :ref:`boolean <boolean-label>`
-
-    If enabled, DNF will continue running and disable the repository that couldn't be contacted for any reason when downloading metadata. 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 True.
-
 .. _strict-label:
 
 ``strict``
@@ -544,6 +537,17 @@ configuration.
 
     Set the number of times any attempt to retrieve a file should retry before returning an error. Setting this to `0` makes dnf try forever. Default is `10`.
 
+.. _skip_if_unavailable-label:
+
+``skip_if_unavailable``
+    :ref:`boolean <boolean-label>`
+
+    If enabled, DNF will continue running and disable the repository that couldn't be contacted for
+    any reason when downloading metadata. 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.
+
 .. _sslcacert-label:
 
 ``sslcacert``