particle-os/debian-koji
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

hub: document packageListRemove method

Browse source 
Update the packageListRemove RPC docstring to describe all parameters
and the return value.

Remove the statement about prefering the block and unblock functions.
In many cases it's simpler and faster to put fewer packages into a tag
than to block many extraneous packages in a tag.
This commit is contained in:
Ken Dreyer 2021-10-25 13:07:30 -04:00
parent 068ccedd0b
commit 8d9633cff7
1 changed files with 17 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

21
hub/kojihub.py
View file

@ -1018,12 +1018,25 @@ def _direct_pkglist_add(taginfo, pkginfo, owner, block, extra_arches, force,
def pkglist_remove(taginfo, pkginfo, force=False):
"""Remove package from the list for tag
"""Remove a package from a tag's package list
Most of the time you really want to use the block or unblock functions
One reason to remove an entry like this is to remove an override so that
the package data can be inherited from elsewhere.
The main reason to remove an entry like this is to remove an override so
that the package data can be inherited from elsewhere.
Alternatively you can use the block or unblock functions.
This method always returns None, even if the package does not exist in the
tag.
:param int|str taginfo: tag id or name to remove the package
:param int|str pkginfo: package id or name to remove
:param bool force: If False (default), Koji will check this
operation against the package_list hub policy. If hub
policy does not allow the current user to remove
packages from this tag, then this method will raise
an error.
If True, then this method will bypass hub policy
settings. Only admin users can set force to True.
"""
_direct_pkglist_remove(taginfo, pkginfo, force, policy=True)