more docstrings

[dak.git] / dak / make_overrides.py

diff --git a/dak/make_overrides.py b/dak/make_overrides.py
index 176e563f6358ff45a7b4f0923903831e3165b45a..bff25dd96d539bc4287e26f3607d3b5c0ce630dd 100755 (executable)
--- a/dak/make_overrides.py
+++ b/dak/make_overrides.py
@@ -1,7 +1,11 @@
 #!/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
@@ -25,16 +29,17 @@
 
 ################################################################################
 
-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
 
 ################################################################################
 
@@ -48,6 +53,22 @@ Outputs the override tables to text files.
 ################################################################################
 
 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)