r200 - branches/rewrite/doc

Otavio Salvador partial-mirror-devel@lists.alioth.debian.org
Mon, 26 Jul 2004 16:07:06 -0600


Author: otavio
Date: Mon Jul 26 16:07:05 2004
New Revision: 200

Added:
   branches/rewrite/doc/
   branches/rewrite/doc/HACKING
Log:
Initial documentation about class layout.

Added: branches/rewrite/doc/HACKING
==============================================================================
--- (empty file)
+++ branches/rewrite/doc/HACKING	Mon Jul 26 16:07:05 2004
@@ -0,0 +1,34 @@
+This small file, documents how is the current class layout of
+debpartial-mirror tool.
+
+Package - store information about a package
+
+PackageList - just what it sounds like, a listing of packages from a
+               single source
+
+(Functionality: provide a list of packages and where to get them from; 
+tell what packages depend on other packages; perform filtering on the 
+list and provide a subset of packages)
+
+PackageSource - a way to get packages
+      |
+      +-----> RemotePackageSource - a remote APT repository
+      |
+      +-----> LocalPackageSource - a locally-stored set of packages
+
+(Functionality: when constructed, generate a PackageList; grab packages 
+into a MirrorBackend by whatever means are appropriate)
+
+Backend - a locally-stored APT repository that debpartial-mirror
+    |      generates
+    |
+    +-----> MirrorBackend - gets packages from a PackageSource, with
+    |                       optional filtering
+    |
+    +-----> MergeBackend - gets packages from MirrorBackends, with
+                           optional additional filtering
+
+(Functionality: figure out which packages need updating; pull updates 
+from source)
+
+$Id$
\ No newline at end of file