doc: Add filelists related entries to API and configuration docs

rpm-software-management · Nov 7, 2023 · 938d3bf · 938d3bf
1 parent 9188ba1
commit 938d3bf
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/doc/api_cli.rst b/doc/api_cli.rst
@@ -77,6 +77,10 @@ When packaging your custom command, we recommend you to define a virtual provide
 
       If ``True``, also the repository metadata containing changelogs for packages will be downloaded. Defaults to ``False``.
 
+    .. attribute:: filelists
+
+      If ``True``, also the repository metadata containing filelists for packages will be downloaded. Defaults to ``False``.
+
     .. attribute:: success_exit_status
 
       The return status of the DNF command on success. Defaults to ``0``.

diff --git a/doc/conf_ref.rst b/doc/conf_ref.rst
@@ -423,6 +423,22 @@ configuration file by your distribution to override the DNF defaults.
 
     Command-line option: :ref:`--obsoletes <obsoletes_option-label>`
 
+.. _optional_metadata_types-label:
+
+``optional_metadata_types``
+    :ref:`list <list-label>`
+
+    List of metadata types to be loaded in addition to ``primary``, ``modules``, ``comps``, ``updateinfo`` and ``presto``,
+    which are loaded always.
+
+    Note that the list can be extended by individual commands, using demands, to explicitly request
+    loading specific metadata type.
+
+    Currently only ``filelists`` value is supported. Default is ``filelists``.
+
+..
+    # TODO(jkolarik): Change the default to an empty list when the system-wide change proposal is accepted
+
 .. _persistdir-label:
 
 ``persistdir``