Skip to content

Commit

Permalink
doc: Include comps.Group interface to D-Bus API documentatin
Browse files Browse the repository at this point in the history
  • Loading branch information
m-blaha authored and pkratoch committed Apr 3, 2024
1 parent e19cda9 commit e4cddf9
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 0 deletions.
1 change: 1 addition & 0 deletions dnf5daemon-server/dbus/interfaces/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/org.rpm.dnf.v0.SessionManager.xml ${C
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/org.rpm.dnf.v0.rpm.Repo.xml ${CMAKE_CURRENT_BINARY_DIR}/org.rpm.dnf.v0.rpm.Repo.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/org.rpm.dnf.v0.rpm.Rpm.xml ${CMAKE_CURRENT_BINARY_DIR}/org.rpm.dnf.v0.rpm.Rpm.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/org.rpm.dnf.v0.Advisory.xml ${CMAKE_CURRENT_BINARY_DIR}/org.rpm.dnf.v0.Advisory.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/org.rpm.dnf.v0.comps.Group.xml ${CMAKE_CURRENT_BINARY_DIR}/org.rpm.dnf.v0.comps.Group.xml COPYONLY)
61 changes: 61 additions & 0 deletions dnf5daemon-server/dbus/interfaces/org.rpm.dnf.v0.comps.Group.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">

<!--
Copyright Contributors to the libdnf project.
This file is part of libdnf: https://github.com/rpm-software-management/libdnf/
Libdnf is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.
Libdnf is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with libdnf. If not, see <https://www.gnu.org/licenses/>.
-->

<node>
<!-- org.rpm.dnf.v0.comps.Group:
@short_description: Interface to comps groups
-->
<interface name="org.rpm.dnf.v0.comps.Group">
<!--
list:
@options: an array of key/value pairs
@groups: array of returned groups with requested attributes
Get list of groups that match to given filters.
Following options and filters are supported:
- attributes: list of strings
list of group attributes that are returned
- match_group_id: bool (default true)
match patterns against ids of the groups
- match_group_name: bool (default false)
match patterns against names of the groups
- scope: string (default "all")
limit groups to one of "all", "installed", "available"
- with_hidden: bool (default false)
include hidden groups into the result
- patterns: list of strings
any group matching to any of patterns is returned
- contains_pkgs: list of strings
include only groups containing given packages
Unknown options are ignored.
-->
<method name="list">
<arg name="options" type="a{sv}" direction="in"/>
<arg name="groups" type="aa{sv}" direction="out"/>
</method>

</interface>

</node>
15 changes: 15 additions & 0 deletions doc/dnf_daemon/dnf5daemon_dbus_api.8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,21 @@ Interfaces
:language: xml


.. only:: sphinx4

.. dbus-doc:: dnf5daemon-server/dbus/interfaces/org.rpm.dnf.v0.comps.Group.xml

.. only:: not sphinx4

.. warning::
Sphinx 4 is required to build D-Bus documentation.

This is the content of ``dnf5daemon-server/dbus/interfaces/org.rpm.dnf.v0.comps.Group.xml``:

.. literalinclude:: ../../dnf5daemon-server/dbus/interfaces/org.rpm.dnf.v0.comps.Group.xml
:language: xml


.. only:: sphinx4

.. dbus-doc:: dnf5daemon-server/dbus/interfaces/org.rpm.dnf.v0.Advisory.xml
Expand Down

0 comments on commit e4cddf9

Please sign in to comment.