From 74c5a1256401a709d74c496b972cc0bd38decaa8 Mon Sep 17 00:00:00 2001 From: Joerg Jaspert Date: Sun, 25 Jan 2009 01:27:16 +0100 Subject: [PATCH] lotsa files doc strings, dont we love em? Signed-off-by: Joerg Jaspert --- dak/check_archive.py | 2 +- dak/check_overrides.py | 2 +- dak/check_proposed_updates.py | 2 +- dak/clean_proposed_updates.py | 2 +- dak/clean_queues.py | 2 +- dak/clean_suites.py | 2 +- dak/compare_suites.py | 2 +- dak/control_overrides.py | 2 +- dak/control_suite.py | 2 +- dak/cruft_report.py | 2 +- dak/dakdb/update1.py | 2 +- dak/dakdb/update2.py | 2 +- dak/dakdb/update3.py | 2 +- dak/decode_dot_dak.py | 2 +- dak/examine_package.py | 2 +- dak/find_null_maintainers.py | 2 +- dak/generate_index_diffs.py | 3 ++- dak/generate_releases.py | 2 +- dak/import_archive.py | 2 +- dak/import_keyring.py | 2 +- dak/import_ldap_fingerprints.py | 2 +- dak/import_users_from_passwd.py | 2 +- dak/ls.py | 2 +- dak/make_maintainers.py | 2 +- dak/make_overrides.py | 2 +- dak/make_suite_file_list.py | 2 +- dak/new_security_install.py | 2 +- dak/override.py | 2 +- dak/poolize.py | 2 +- dak/process_accepted.py | 2 +- dak/process_new.py | 2 +- dak/process_unchecked.py | 2 +- dak/queue_report.py | 2 +- dak/reject_proposed_updates.py | 2 +- dak/rm.py | 2 +- dak/show_deferred.py | 2 +- dak/show_new.py | 2 +- dak/split_done.py | 2 ++ dak/stats.py | 2 +- dak/transitions.py | 2 +- dak/update_db.py | 4 ++-- daklib/dak_exceptions.py | 4 +++- daklib/database.py | 2 +- daklib/extensions.py | 2 +- daklib/logging.py | 2 +- daklib/queue.py | 2 +- daklib/utils.py | 2 +- 47 files changed, 52 insertions(+), 47 deletions(-) mode change 100644 => 100755 dak/check_overrides.py mode change 100644 => 100755 dak/control_overrides.py mode change 100644 => 100755 dak/control_suite.py mode change 100644 => 100755 dak/dakdb/update1.py mode change 100644 => 100755 dak/decode_dot_dak.py mode change 100644 => 100755 dak/poolize.py mode change 100644 => 100755 daklib/dak_exceptions.py mode change 100644 => 100755 daklib/extensions.py mode change 100644 => 100755 daklib/logging.py diff --git a/dak/check_archive.py b/dak/check_archive.py index 26a85cb5..004fcddd 100755 --- a/dak/check_archive.py +++ b/dak/check_archive.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Various different sanity checks +""" Various different sanity checks """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/check_overrides.py b/dak/check_overrides.py old mode 100644 new mode 100755 index f276dbae..ff01306d --- a/dak/check_overrides.py +++ b/dak/check_overrides.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Cruft checker and hole filler for overrides +""" Cruft checker and hole filler for overrides """ # Copyright (C) 2000, 2001, 2002, 2004, 2006 James Troup # Copyright (C) 2005 Jeroen van Wolffelaar diff --git a/dak/check_proposed_updates.py b/dak/check_proposed_updates.py index 05728ab8..5b9283f7 100755 --- a/dak/check_proposed_updates.py +++ b/dak/check_proposed_updates.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Dependency check proposed-updates +""" Dependency check proposed-updates """ # Copyright (C) 2001, 2002, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/clean_proposed_updates.py b/dak/clean_proposed_updates.py index b408184e..0e9c0b6e 100755 --- a/dak/clean_proposed_updates.py +++ b/dak/clean_proposed_updates.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Remove obsolete .changes files from proposed-updates +""" Remove obsolete .changes files from proposed-updates """ # Copyright (C) 2001, 2002, 2003, 2004, 2006, 2008 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/clean_queues.py b/dak/clean_queues.py index 9f771b72..34d90473 100755 --- a/dak/clean_queues.py +++ b/dak/clean_queues.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Clean incoming of old unused files +""" Clean incoming of old unused files """ # Copyright (C) 2000, 2001, 2002, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/clean_suites.py b/dak/clean_suites.py index fc4b8473..5523d633 100755 --- a/dak/clean_suites.py +++ b/dak/clean_suites.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Cleans up unassociated binary and source packages +""" Cleans up unassociated binary and source packages """ # Copyright (C) 2000, 2001, 2002, 2003, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/compare_suites.py b/dak/compare_suites.py index 8c367582..ab0ab3c0 100755 --- a/dak/compare_suites.py +++ b/dak/compare_suites.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Check for fixable discrepancies between stable and unstable +""" Check for fixable discrepancies between stable and unstable """ # Copyright (C) 2000, 2001, 2002, 2003, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/control_overrides.py b/dak/control_overrides.py old mode 100644 new mode 100755 index 78ae68d4..730ce252 --- a/dak/control_overrides.py +++ b/dak/control_overrides.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Bulk manipulation of the overrides +""" Bulk manipulation of the overrides """ # Copyright (C) 2000, 2001, 2002, 2003, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/control_suite.py b/dak/control_suite.py old mode 100644 new mode 100755 index 4b704b97..95b24bc6 --- a/dak/control_suite.py +++ b/dak/control_suite.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Manipulate suite tags +""" Manipulate suite tags """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/cruft_report.py b/dak/cruft_report.py index f8695df7..d88c799b 100755 --- a/dak/cruft_report.py +++ b/dak/cruft_report.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Check for obsolete binary packages +""" Check for obsolete binary packages """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/dakdb/update1.py b/dak/dakdb/update1.py old mode 100644 new mode 100755 index 3f0aa801..7778b1be --- a/dak/dakdb/update1.py +++ b/dak/dakdb/update1.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Debian Archive Kit Database Update Script +""" Database Update Script - Saner DM db schema """ # Copyright (C) 2008 Michael Casadevall # This program is free software; you can redistribute it and/or modify diff --git a/dak/dakdb/update2.py b/dak/dakdb/update2.py index 20154b07..71b43fa7 100755 --- a/dak/dakdb/update2.py +++ b/dak/dakdb/update2.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # coding=utf8 -# Debian Archive Kit Database Update Script +""" Database Update Script - debversion """ # Copyright © 2008 Michael Casadevall # Copyright © 2008 Roger Leigh diff --git a/dak/dakdb/update3.py b/dak/dakdb/update3.py index cc297863..df89fb9d 100755 --- a/dak/dakdb/update3.py +++ b/dak/dakdb/update3.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Debian Archive Kit Database Update Script +""" Database Update Script - Remove unused versioncmp """ # Copyright (C) 2008 Michael Casadevall # Copyright (C) 2009 Joerg Jaspert diff --git a/dak/decode_dot_dak.py b/dak/decode_dot_dak.py old mode 100644 new mode 100755 index 7ea342bd..e6bc45b6 --- a/dak/decode_dot_dak.py +++ b/dak/decode_dot_dak.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Dump variables from a .dak file to stdout +""" Dump variables from a .dak file to stdout """ # Copyright (C) 2001, 2002, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/examine_package.py b/dak/examine_package.py index 70b1f3ca..d0e1e53a 100755 --- a/dak/examine_package.py +++ b/dak/examine_package.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Script to automate some parts of checking NEW packages +""" Script to automate some parts of checking NEW packages """ # Copyright (C) 2000, 2001, 2002, 2003, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/find_null_maintainers.py b/dak/find_null_maintainers.py index 652edfd2..c943335a 100755 --- a/dak/find_null_maintainers.py +++ b/dak/find_null_maintainers.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Check for users with no packages in the archive +""" Check for users with no packages in the archive """ # Copyright (C) 2003, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/generate_index_diffs.py b/dak/generate_index_diffs.py index f3f7a4a1..84b0a67c 100755 --- a/dak/generate_index_diffs.py +++ b/dak/generate_index_diffs.py @@ -1,7 +1,8 @@ #!/usr/bin/env python +""" generates partial package updates list""" + ########################################################### -# generates partial package updates list # idea and basic implementation by Anthony, some changes by Andreas # parts are stolen from 'dak generate-releases' diff --git a/dak/generate_releases.py b/dak/generate_releases.py index a1552451..1c258bd5 100755 --- a/dak/generate_releases.py +++ b/dak/generate_releases.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Create all the Release files +""" Create all the Release files """ # Copyright (C) 2001, 2002, 2006 Anthony Towns diff --git a/dak/import_archive.py b/dak/import_archive.py index 00b5d1b6..d87d6ca9 100755 --- a/dak/import_archive.py +++ b/dak/import_archive.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Populate the DB +""" Populate the DB """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/import_keyring.py b/dak/import_keyring.py index c8013d6e..ca325d0d 100755 --- a/dak/import_keyring.py +++ b/dak/import_keyring.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Imports a keyring into the database +""" Imports a keyring into the database """ # Copyright (C) 2007 Anthony Towns # This program is free software; you can redistribute it and/or modify diff --git a/dak/import_ldap_fingerprints.py b/dak/import_ldap_fingerprints.py index 1fac652c..cdffbd0a 100755 --- a/dak/import_ldap_fingerprints.py +++ b/dak/import_ldap_fingerprints.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Sync fingerprint and uid tables with a debian.org LDAP DB +""" Sync fingerprint and uid tables with a debian.org LDAP DB """ # Copyright (C) 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/import_users_from_passwd.py b/dak/import_users_from_passwd.py index b182f604..d38a3c93 100755 --- a/dak/import_users_from_passwd.py +++ b/dak/import_users_from_passwd.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Sync PostgreSQL users with system users +""" Sync PostgreSQL users with system users """ # Copyright (C) 2001, 2002, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/ls.py b/dak/ls.py index baf13733..b9753b48 100755 --- a/dak/ls.py +++ b/dak/ls.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Display information about package(s) (suite, version, etc.) +""" Display information about package(s) (suite, version, etc.) """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/make_maintainers.py b/dak/make_maintainers.py index 55cc4a9b..91353750 100755 --- a/dak/make_maintainers.py +++ b/dak/make_maintainers.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Generate Maintainers file used by e.g. the Debian Bug Tracking System +""" Generate Maintainers file used by e.g. the Debian Bug Tracking System """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/make_overrides.py b/dak/make_overrides.py index 2ed4f4ba..176e563f 100755 --- a/dak/make_overrides.py +++ b/dak/make_overrides.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Output override files for apt-ftparchive and indices/ +""" Output override files for apt-ftparchive and indices/ """ # Copyright (C) 2000, 2001, 2002, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/make_suite_file_list.py b/dak/make_suite_file_list.py index dbbab7ec..d6dbf9d0 100755 --- a/dak/make_suite_file_list.py +++ b/dak/make_suite_file_list.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Generate file lists used by apt-ftparchive to generate Packages and Sources files +""" Generate file lists used by apt-ftparchive to generate Packages and Sources files """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/new_security_install.py b/dak/new_security_install.py index 98951d41..b1a47dba 100755 --- a/dak/new_security_install.py +++ b/dak/new_security_install.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Wrapper for Debian Security team +""" Wrapper for Debian Security team """ # Copyright (C) 2006 Anthony Towns # This program is free software; you can redistribute it and/or modify diff --git a/dak/override.py b/dak/override.py index 0bda5e76..4b92ae11 100755 --- a/dak/override.py +++ b/dak/override.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Microscopic modification and query tool for overrides in projectb +""" Microscopic modification and query tool for overrides in projectb """ # Copyright (C) 2004, 2006 Daniel Silverstone # This program is free software; you can redistribute it and/or modify diff --git a/dak/poolize.py b/dak/poolize.py old mode 100644 new mode 100755 index cefdcae9..ef41d742 --- a/dak/poolize.py +++ b/dak/poolize.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Poolify (move packages from "legacy" type locations to pool locations) +""" Poolify (move packages from "legacy" type locations to pool locations) """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/process_accepted.py b/dak/process_accepted.py index a29c8921..683b1191 100755 --- a/dak/process_accepted.py +++ b/dak/process_accepted.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Installs Debian packages from queue/accepted into the pool +""" Installs Debian packages from queue/accepted into the pool """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/process_new.py b/dak/process_new.py index 9eea0ec5..8741d25e 100755 --- a/dak/process_new.py +++ b/dak/process_new.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # vim:set et ts=4 sw=4: -# Handles NEW and BYHAND packages +""" Handles NEW and BYHAND packages """ # Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/process_unchecked.py b/dak/process_unchecked.py index 43fc087a..6761a419 100755 --- a/dak/process_unchecked.py +++ b/dak/process_unchecked.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Checks Debian packages from Incoming +""" Checks Debian packages from Incoming """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/queue_report.py b/dak/queue_report.py index 29d07881..fe8a4a1b 100755 --- a/dak/queue_report.py +++ b/dak/queue_report.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Produces a report on NEW and BYHAND packages +""" Produces a report on NEW and BYHAND packages """ # Copyright (C) 2001, 2002, 2003, 2005, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/reject_proposed_updates.py b/dak/reject_proposed_updates.py index c3345017..7770f66e 100755 --- a/dak/reject_proposed_updates.py +++ b/dak/reject_proposed_updates.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Manually reject packages for proprosed-updates +""" Manually reject packages for proprosed-updates """ # Copyright (C) 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/rm.py b/dak/rm.py index 9c761554..005653e5 100755 --- a/dak/rm.py +++ b/dak/rm.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# General purpose package removal tool for ftpmaster +""" General purpose package removal tool for ftpmaster """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/show_deferred.py b/dak/show_deferred.py index 8c13d677..e9266bcc 100755 --- a/dak/show_deferred.py +++ b/dak/show_deferred.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# based on queue-report +""" Overview of the DEFERRED queue, based on queue-report """ # Copyright (C) 2001, 2002, 2003, 2005, 2006 James Troup # Copyright (C) 2008 Thomas Viehmann diff --git a/dak/show_new.py b/dak/show_new.py index f650f9aa..e355c37f 100755 --- a/dak/show_new.py +++ b/dak/show_new.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Output html for packages in NEW +""" Output html for packages in NEW """ # Copyright (C) 2007 Joerg Jaspert # This program is free software; you can redistribute it and/or modify diff --git a/dak/split_done.py b/dak/split_done.py index 5f8fadda..8b5b57fe 100755 --- a/dak/split_done.py +++ b/dak/split_done.py @@ -1,6 +1,8 @@ #!/usr/bin/env python +""" Split queue/done into date based subdirectories """ # Copyright (C) 2004, 2005, 2006 James Troup +# Copyright (C) 2008 Joerg Jaspert # 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 diff --git a/dak/stats.py b/dak/stats.py index 20a02b55..105bf6c9 100755 --- a/dak/stats.py +++ b/dak/stats.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Various statistical pr0nography fun and games +""" Various statistical pr0nography fun and games """ # Copyright (C) 2000, 2001, 2002, 2003, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/dak/transitions.py b/dak/transitions.py index 7c47f880..750d146b 100755 --- a/dak/transitions.py +++ b/dak/transitions.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Display, edit and check the release manager's transition file. +""" Display, edit and check the release manager's transition file. """ # Copyright (C) 2008 Joerg Jaspert # This program is free software; you can redistribute it and/or modify diff --git a/dak/update_db.py b/dak/update_db.py index d4aefe24..f9b6e478 100755 --- a/dak/update_db.py +++ b/dak/update_db.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Debian Archive Kit Database Update Script +""" Database Update Main Script """ # Copyright (C) 2008 Michael Casadevall # This program is free software; you can redistribute it and/or modify @@ -53,7 +53,7 @@ Updates dak's database schema to the lastest version. You should disable crontab ################################################################################ def update_db_to_zero(self): - # This function will attempt to update a pre-zero database schema to zero + """ This function will attempt to update a pre-zero database schema to zero """ # First, do the sure thing, and create the configuration table try: diff --git a/daklib/dak_exceptions.py b/daklib/dak_exceptions.py old mode 100644 new mode 100755 index 9404ee9e..2fe87a08 --- a/daklib/dak_exceptions.py +++ b/daklib/dak_exceptions.py @@ -1,4 +1,6 @@ -# Exception classes used in dak +#!/usr/bin/env python + +""" Exception classes used in dak """ # Copyright (C) 2008 Mark Hymers diff --git a/daklib/database.py b/daklib/database.py index e2c596a6..095b1398 100755 --- a/daklib/database.py +++ b/daklib/database.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# DB access fucntions +""" DB access fucntions """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/daklib/extensions.py b/daklib/extensions.py old mode 100644 new mode 100755 index 9befa7bf..668cc27c --- a/daklib/extensions.py +++ b/daklib/extensions.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Utility functions for extensions +""" Utility functions for extensions """ # Copyright (C) 2008 Anthony Towns ################################################################################ diff --git a/daklib/logging.py b/daklib/logging.py old mode 100644 new mode 100755 index f0dcd9c9..125aa4af --- a/daklib/logging.py +++ b/daklib/logging.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Logging functions +""" Logging functions """ # Copyright (C) 2001, 2002, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/daklib/queue.py b/daklib/queue.py index 5bebe8ef..3010c9d6 100755 --- a/daklib/queue.py +++ b/daklib/queue.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # vim:set et sw=4: -# Queue utility functions for dak +""" Queue utility functions for dak """ # Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 James Troup # This program is free software; you can redistribute it and/or modify diff --git a/daklib/utils.py b/daklib/utils.py index be4bcff7..dbc8c16c 100755 --- a/daklib/utils.py +++ b/daklib/utils.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # vim:set et ts=4 sw=4: -# Utility functions +""" Utility functions """ # Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 James Troup ################################################################################ -- 2.39.5