#!/usr/bin/env python
-# Output override files for apt-ftparchive and indices/
-# Copyright (C) 2000, 2001, 2002, 2004, 2006 James Troup <james@nocrew.org>
+"""
+Output override files for apt-ftparchive and indices/
+@contact: Debian FTP Master <ftpmaster@debian.org>
+@copyright: 2000, 2001, 2002, 2004, 2006 James Troup <james@nocrew.org>
+@license: GNU General Public License version 2 or later
+"""
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
################################################################################
-import pg, sys
+import pg
+import sys
import apt_pkg
from daklib import database
from daklib import utils
################################################################################
-Cnf = None
-projectB = None
-override = {}
+Cnf = None #: Configuration, apt_pkg.Configuration
+projectB = None #: database connection, pgobject
+override = {} #: override data to write out
################################################################################
################################################################################
def do_list(output_file, suite, component, otype):
+ """
+ Fetch override data for suite from the database and dump it.
+
+ @type output_file: fileobject
+ @param output_file: where to write the overrides to
+
+ @type suite: string
+ @param suite: The name of the suite
+
+ @type component: string
+ @param component: The name of the component
+
+ @type otype: string
+ @param otype: type of override. deb/udeb/dsc
+
+ """
global override
suite_id = database.get_suite_id(suite)