Bug 585190 - there is no api documentation for yum
there is no api documentation for yum
Product: Fedora
Classification: Fedora
Component: yum (Show other bugs)
All Linux
low Severity medium
: ---
: ---
Assigned To: Seth Vidal
Fedora Extras Quality Assurance
Depends On:
  Show dependency treegraph
Reported: 2010-04-23 07:58 EDT by Richard Hughes
Modified: 2014-01-21 18:14 EST (History)
5 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Last Closed: 2010-04-28 05:31:14 EDT
Type: ---
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Richard Hughes 2010-04-23 07:58:37 EDT
Description of problem:

There is no api documentation for yum, which really makes writing yumBackend.py for PackageKit hard. Short of looking at the yum code and trying to figure out what it does there are no generated docs for people to use.

If you do happen to find a function, you've got no idea when it was added to the yum codebase, and most of the time what kind of data it returns (triple, list, ?). It also doesn't state if this is a trivial unstable helper function, or something that forms part of the stable API (that I can legitimately use and rely on being there in future releases).

For instance, I want to be able to set the uid for the yum transaction so that the output from yum history to not show "System <unset>" but the users login name. Without reading the code it's impossible to find out what to do. Even after looking at the code I'm none-the-wiser.

Steps to Reproduce:
1. Install yum
2. Look for docs
3. Find none

Additional info:

I'm a pretty competent python programmer now, and if I'm finding this hard, people who just want to use yum are going to find it next to impossible.
Comment 1 James Antill 2010-04-23 11:17:47 EDT
In regards to the third paragraph, you need to set the loginuid then audit+yum+blah will all know who the logged in uid is.

I'm also unsure if we could ever document the API to the extent that we would iterate all the system/environment settings we are using in each function.
Comment 2 Tim Lauridsen 2010-04-28 05:31:14 EDT
I have started to make epydoc API documentation.


The plan is to make new doc for every release, so it should be easier to track the API for each release.

Yum is a complex system, and there is many levels of API, so the more advanced stuff is hard to use, if you not track the yum development very closely.

Note You need to log in before you can comment on or make changes to this bug.