* doc/: Heavily improve documentation

Complete the documentation of pkgCache, pkgDepCache, pkgCache::Package.

Introduce new documentation for pkgCache::Version, pkgCache::Dependency,
pkgCache::PackageFile, pkgcache::Description.

There is also an example now which checks for missing dependencies.

1 files changed, 29 insertions, 0 deletions

diff --git a/doc/source/examples/cache-pkgfile.py b/doc/source/examples/cache-pkgfile.py
new file mode 100644
index 00000000..f25975d3
--- /dev/null
+++ b/doc/source/examples/cache-pkgfile.py
@@ -0,0 +1,29 @@
+#!/usr/bin/python
+import apt_pkg
+
+
+def main():
+    """Example for PackageFile()"""
+    apt_pkg.init()
+    cache = apt_pkg.GetCache()
+    for pkgfile in cache.FileList:
+        print 'Package-File:', pkgfile.FileName
+        print 'Index-Type:', pkgfile.IndexType # 'Debian Package Index'
+        if pkgfile.NotSource:
+            print 'Source: None'
+        else:
+            if pkgfile.Site:
+                # There is a source, and a site, print the site
+                print 'Source:', pkgfile.Site
+            else:
+                # It seems to be a local repository
+                print 'Source: Local package file'
+        if pkgfile.NotAutomatic:
+            # The system won't be updated automatically (eg. experimental)
+            print 'Automatic: No'
+        else:
+            print 'Automatic: Yes'
+        print
+
+if __name__ == '__main__':
+    main()