From d8c0ca6ff164f79910b315c9525fa77417084edf Mon Sep 17 00:00:00 2001
From: Julian Andres Klode <jak@debian.org>
Date: Thu, 23 Jul 2009 21:42:17 +0200
Subject: doc/source: Big documentation reorganisation.

Due to the new C++ API and because I wanted to include some tutorials,
the documentation is now seperated into 4 sections:

	library   => Documentation of modules.
	tutorials => Tutorials for using python-apt and contributing
	whatsnew  => Release notes
	c++       => Documentation,Tutorials for the C++ API

This commit also includes a new overview page, like the Python
documentation.
---
 doc/source/library/apt.cache.rst | 78 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 doc/source/library/apt.cache.rst

(limited to 'doc/source/library/apt.cache.rst')

diff --git a/doc/source/library/apt.cache.rst b/doc/source/library/apt.cache.rst
new file mode 100644
index 00000000..ddb2dc64
--- /dev/null
+++ b/doc/source/library/apt.cache.rst
@@ -0,0 +1,78 @@
+:mod:`apt.cache` --- The Cache class
+=====================================
+.. automodule:: apt.cache
+
+The Cache class
+---------------
+
+.. autoclass:: Cache
+    :members:
+    :undoc-members:
+
+    .. describe:: cache[pkgname]
+
+        Return a :class:`Package()` for the package with the name *pkgname*.
+
+Example
+^^^^^^^
+
+The following example shows how to load the cache, update it, and upgrade
+all the packages on the system::
+
+    import apt
+    import apt.progress
+
+    # First of all, open the cache
+    cache = apt.Cache()
+    # Now, lets update the package list
+    cache.update()
+    # We need to re-open the cache because it needs to read the package list
+    cache.open(None)
+    # Now we can do the same as 'apt-get upgrade' does
+    cache.upgrade()
+    # or we can play 'apt-get dist-upgrade'
+    cache.upgrade(True)
+    # Q: Why does nothing happen?
+    # A: You forgot to call commit()!
+    cache.commit(apt.progress.TextFetchProgress(),
+                 apt.progress.InstallProgress())
+
+
+
+Working with Filters
+--------------------
+.. autoclass:: Filter
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+.. autoclass:: MarkedChangesFilter
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+.. autoclass:: FilteredCache
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+Example
+^^^^^^^
+
+This is an example for a filtered cache, which only allows access to the
+packages whose state has been changed, eg. packages marked for installation::
+
+    >>> from apt.cache import FilteredCache, Cache, MarkedChangesFilter
+    >>> cache = apt.Cache()
+    >>> changed = apt.FilteredCache(cache)
+    >>> changed.set_filter(MarkedChangesFilter())
+    >>> print len(changed) == len(cache.get_changes()) # Both need to have same length
+    True
+
+
+Exceptions
+----------
+.. autoexception:: FetchCancelledException
+.. autoexception:: FetchFailedException
+.. autoexception:: LockFailedException
-- 
cgit v1.2.3