[Collab-qa-commits] r1214 - udd/doc
lucas at alioth.debian.org
lucas at alioth.debian.org
Sun Sep 7 16:57:33 UTC 2008
Author: lucas
Date: 2008-09-07 16:57:32 +0000 (Sun, 07 Sep 2008)
New Revision: 1214
Removed:
udd/doc/HOWTO-TEST
udd/doc/NOTES
udd/doc/bugs.debian.org.doc
udd/doc/nnnnnn.css
udd/doc/udd-from-scratch
Modified:
udd/doc/README
Log:
removed obsolete docs, merged them into README
Deleted: udd/doc/HOWTO-TEST
===================================================================
--- udd/doc/HOWTO-TEST 2008-09-07 16:56:01 UTC (rev 1213)
+++ udd/doc/HOWTO-TEST 2008-09-07 16:57:32 UTC (rev 1214)
@@ -1,23 +0,0 @@
-Howto test UDD on your site:
-
-You need a postgres-db, and access to the sources you want to import into your DB.
-
-The next step is to put the scripts and configuration somewhere. It doesn't
-really matter where.
-
-There is one file you have to edit/create new: a configuration file. This file
-has to be in YAML format. See config.README for information about this file,
-and have a look at test.yaml in the src directory.
-
-For all things you do, you run udd-dispatch.py <config-path> source1 [source2
-source3 ...]. config-path has to be the path of the configuration file you
-want to use. source1 through sourceN have to be sources specified in the
-configuration file.
-
-Before doing anything else, you have to run "udd-dispatch.py <config> setup",
-which will create the necessary tables in your database.
-
-From here, you can start importing source into your database. For each SOURCE,
-you run udd-dispatch.py <config> SOURCE.
-
-Now your sources should be included in your db.
Deleted: udd/doc/NOTES
===================================================================
--- udd/doc/NOTES 2008-09-07 16:56:01 UTC (rev 1213)
+++ udd/doc/NOTES 2008-09-07 16:57:32 UTC (rev 1214)
@@ -1,5 +0,0 @@
-Various notes regarding the Ultimate Debian Database:
-
-bugs-gatherer.pl:
- if log_modified or date of a bug cannot be determined,
- NULL is written into the those columns
Modified: udd/doc/README
===================================================================
--- udd/doc/README 2008-09-07 16:56:01 UTC (rev 1213)
+++ udd/doc/README 2008-09-07 16:57:32 UTC (rev 1214)
@@ -1,38 +1,34 @@
-The Ultimate Debian Database (UDD)
+Ultimate Debian Database (UDD)
+==============================
-GOAL:
-The UDD project is an effort to collect a part of the data of the Debian
-Project to support Quality Assurance (QA).
+The UDD project is an effort to collect data about the Debian in an SQL
+to support Quality Assurance (QA) work.
-CONTEXT AND PEOPLE:
-It started as a Google Summer of Code (GSoC) 2008 project, the student being
+It started in 2008 as a Google Summer of Code project, the student being
Christian von Essen, who wrote most of the code, mentor being Lucas Nussbaum,
-and Co-Mentors being Stefano Zacchiroli and Marc Brockschmidt.
+and co-mentors being Stefano Zacchiroli and Marc Brockschmidt.
-DESCRIPTION:
+Installation
+------------
+- Download the code (from SVN)
+- install postgresql-8.3 python-syck python-psycopg2
+- setup postgresql-8.3 (see /usr/share/doc/postgresql-common/README.Debian.gz)
+ and create a database (naming it 'udd' will make things easier later)
+- edit config.yaml (see README.config for details)
+- run ./udd.py <configuration> setup FIXME doesn't work
+
+Usage
+-----
+- run ./udd.py <configuration> update [ fetches the external data ]
+- run ./udd.py <configuration> run [ import the data into the DB ]
+FIXME document all commands.
+
+Detailed information
+--------------------
The data we import comes from different sources. Each source has a specific
type (e.g. popcon). For each such type, there is a program to import this data
into the database. These programs are called gatherers. Furthermore, there is
an optional way to update the data (i.e. get it from the source) for each
source.
-The gatherers can be started via src/udd-dispatcher.py, which we call
-dispatcher. The updates can be initiated via src/udd-update.py. Both are
-controlled via a configuration file. See doc/README.config for further
-information.
-
Each source has its own documentation. See doc/sources/.
-
-The sources are imported into a PostgreSQL database. For the schema,
-see src/setup-db.sql
-
-udd-dispatch.py:
- udd-dispatch.py <configuration> <source1> [source2 [source3 ...]]
- This program invokes the gatherers. As first parameter, it accepts
- a configuration file (see doc/README.config), while the
- rest of its arguments specify the sources to be gathered.
-
-udd-update.py:
- udd-update.py: <configuration> <source1> [source2 [source3 ...]]
- This programs is meant to update the sources. See (doc/README.config)
- fur further information.
Deleted: udd/doc/bugs.debian.org.doc
===================================================================
--- udd/doc/bugs.debian.org.doc 2008-09-07 16:56:01 UTC (rev 1213)
+++ udd/doc/bugs.debian.org.doc 2008-09-07 16:57:32 UTC (rev 1214)
@@ -1,246 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN" "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd">
-
-<article class="whitepaper">
- <section>
- <title>Overview of information contained in bugs.debian.org</title>
- <para />
- </section>
- <section>
- <title>Structure</title>
- <para />
- </section>
- <section>
- <title>; The database consists of a number of bugs</title>
- <para />
- </section>
- <section>
- <title>; Each bug belongs to exactly one package and version</title>
- <para />
- </section>
- <section>
- <title>; Each bug is identified by a number - its ID</title>
- <para />
- </section>
- <section>
- <title>; Each bug has a time when in arrived</title>
- <para />
- </section>
- <section>
- <title>; Each bug has a status</title>
- <para />
- </section>
- <section>
- <title>; Each bug has a severity</title>
- <para />
- </section>
- <section>
- <title>; Each bug has zero or more tags attached to him</title>
- <para />
- </section>
- <section>
- <title>; Each bug has been submitted by a person (Identified per email and name</title>
- <para />
- </section>
- <section>
- <title>; Each bug has an owner</title>
- <para />
- </section>
- <section>
- <title>; Each bug has a title</title>
- <para />
- </section>
- <section>
- <title>; Each bug has a initial report, and possibly further conversation</title>
- <para />
- </section>
- <section>
- <title>; For each bug and user, there are zero or more usertags</title>
- <para />
- </section>
- <section>
- <title>; There is some hidden additional information</title>
- <para />
- </section>
- <section>
- <title>Status</title>
- <para>A bug's status is one of:</para>
- </section>
- <section>
- <title>| open | The bug is still open and has to be processed |</title>
- <para />
- </section>
- <section>
- <title>| forwarded | The bug has been forwarded |</title>
- <para />
- </section>
- <section>
- <title>| pending |</title>
- <para />
- </section>
- <section>
- <title>| fixed |</title>
- <para />
- </section>
- <section>
- <title>| done |</title>
- <para />
- </section>
- <section>
- <title>Severity</title>
- <para>Each bug's severity is one of:</para>
- </section>
- <section>
- <title>| critical |</title>
- <para />
- </section>
- <section>
- <title>| grave |</title>
- <para />
- </section>
- <section>
- <title>| serious |</title>
- <para />
- </section>
- <section>
- <title>| important |</title>
- <para />
- </section>
- <section>
- <title>| normal |</title>
- <para />
- </section>
- <section>
- <title>| minor |</title>
- <para />
- </section>
- <section>
- <title>| wishlist |</title>
- <para />
- </section>
- <section>
- <title>| fixed |</title>
- <para />
- </section>
- <section>
- <title>Tags</title>
- <para>Each bug has a zero or more tags attached to him</para>
- </section>
- <section>
- <title>| potato |</title>
- <para />
- </section>
- <section>
- <title>| woody |</title>
- <para />
- </section>
- <section>
- <title>| sarge |</title>
- <para />
- </section>
- <section>
- <title>| sarge-ignore |</title>
- <para />
- </section>
- <section>
- <title>| etch |</title>
- <para />
- </section>
- <section>
- <title>| etch-ignore |</title>
- <para />
- </section>
- <section>
- <title>| lenny |</title>
- <para />
- </section>
- <section>
- <title>| lenny-ignore |</title>
- <para />
- </section>
- <section>
- <title>| sid |</title>
- <para />
- </section>
- <section>
- <title>| experimental |</title>
- <para />
- </section>
- <section>
- <title>| confirmed |</title>
- <para />
- </section>
- <section>
- <title>| d-i |</title>
- <para />
- </section>
- <section>
- <title>| fixed |</title>
- <para />
- </section>
- <section>
- <title>| fixed-in-experimental |</title>
- <para />
- </section>
- <section>
- <title>| fixed-upstream |</title>
- <para />
- </section>
- <section>
- <title>| help |</title>
- <para />
- </section>
- <section>
- <title>| l10n |</title>
- <para />
- </section>
- <section>
- <title>| moreinfo |</title>
- <para />
- </section>
- <section>
- <title>| patch |</title>
- <para />
- </section>
- <section>
- <title>| pending |</title>
- <para />
- </section>
- <section>
- <title>| security |</title>
- <para />
- </section>
- <section>
- <title>| unreproducible |</title>
- <para />
- </section>
- <section>
- <title>| upstream |</title>
- <para />
- </section>
- <section>
- <title>| wontfix |</title>
- <para />
- </section>
- <section>
- <title>| ipv6 |</title>
- <para />
- </section>
- <section>
- <title>| lfs |</title>
- <para />
- </section>
- <section>
- <title>Usertags</title>
- <para>Each user can define their own usertags. These usertags then can be
-applied to packages of their own choosing. It is very convenient to
-get the usertags of a specific user, but expensive to get the usertags
-of a specific package</para>
- </section>
- <section>
- <title>Hidden information</title>
- <para>Each bug has been found for a specific version, and is possibly fixed
-for some other version. Bugs can be fixed in more the one version of a
-package. So for each package, debian release and bug, the bug can affect
-the package in the given release.</para>
- </section>
\ No newline at end of file
Deleted: udd/doc/nnnnnn.css
===================================================================
--- udd/doc/nnnnnn.css 2008-09-07 16:56:01 UTC (rev 1213)
+++ udd/doc/nnnnnn.css 2008-09-07 16:57:32 UTC (rev 1214)
@@ -1,244 +0,0 @@
- /* copyright notice and filename */
-body {
- font-family: helvetica,arial,sans-serif;
- font-size: 10pt;
-}
- /* title at the top of the page */
-H1 {
- font-family: helvetica,arial,sans-serif;
- font-size: 14pt;
- font-weight: bold;
- text-align: center;
- color: black;
- background-color: #ddddee;
- padding-top: 20px;
- padding-bottom: 20px;
-}
-H2 {
- font-family: helvetica,arial,sans-serif;
- font-size: 12pt;
- font-weight: bold;
- text-align: left;
- color: black;
-}
-H3 {
- font-family: helvetica,arial,sans-serif;
- font-size: 12pt;
- text-align: left;
- color: black;
-}
-H4 {
- font-family: helvetica,arial,sans-serif;
- font-size: 12pt;
- text-align: left;
- color: black;
-}
-H5 {
- font-family: helvetica,arial,sans-serif;
- font-size: 10pt;
- text-align: left;
- color: black;
-}
- /* outline level spacing */
-OL {
- padding-bottom: 8pt;
-}
- /* global heading settings */
-LI {
- font-family: helvetica,arial,sans-serif;
- color: black;
- font-weight: normal;
- list-style: lower-alpha;
- padding-top: 4px;
-}
- /* level 1 heading overrides */
-LI.L1 {
- font-size: 12pt;
- font-weight: bold;
- list-style: none;
-}
- /* level 2 heading overrides */
-LI.L2 {
- font-size: 10pt;
- font-weight: bold;
- list-style: none;
-}
- /* level 3 heading overrides */
-LI.L3 {
- font-size: 10pt;
- list-style: none;
-}
- /* level 4 heading overrides */
-LI.L4 {
- font-size: 10pt;
- list-style: none;
-}
- /* level 5 heading overrides */
-LI.L5 {
- font-size: 10pt;
- list-style: none;
-}
- /* level 6 heading overrides */
-LI.L6 {
- font-size: 10pt;
- list-style: none;
-}
- /* level 7 heading overrides */
-LI.L7 {
- font-size: 10pt;
- list-style: none;
-}
- /* level 1 bullet heading overrides */
-LI.LB1 {
- font-size: 12pt;
- font-weight: bold;
- list-style: disc;
-}
- /* level 2 bullet heading overrides */
-LI.LB2 {
- font-size: 10pt;
- font-weight: bold;
- list-style: disc;
-}
- /* level 3 bullet heading overrides */
-LI.LB3 {
- font-size: 10pt;
- list-style: disc;
-}
- /* level 4 bullet heading overrides */
-LI.LB4 {
- font-size: 10pt;
- list-style: disc;
-}
- /* level 5 bullet heading overrides */
-LI.LB5 {
- font-size: 10pt;
- list-style: disc;
-}
- /* level 6 bullet heading overrides */
-LI.LB6 {
- font-size: 10pt;
- list-style: disc;
-}
- /* level 7 bullet heading overrides */
-LI.LB7 {
- font-size: 10pt;
- list-style: disc;
-}
- /* level 1 numeric heading overrides */
-LI.LN1 {
- font-size: 12pt;
- font-weight: bold;
- list-style: decimal;
-}
- /* level 2 numeric heading overrides */
-LI.LN2 {
- font-size: 10pt;
- font-weight: bold;
- list-style: decimal;
-}
- /* level 3 numeric heading overrides */
-LI.LN3 {
- font-size: 10pt;
- list-style: decimal;
-}
- /* level 4 numeric heading overrides */
-LI.LN4 {
- font-size: 10pt;
- list-style: decimal;
-}
- /* level 5 numeric heading overrides */
-LI.LN5 {
- font-size: 10pt;
- list-style: decimal;
-}
- /* level 6 numeric heading overrides */
-LI.LN6 {
- font-size: 10pt;
- list-style: decimal;
-}
- /* level 7 numeric heading overrides */
-LI.LN7 {
- font-size: 10pt;
- list-style: decimal;
-}
- /* body text */
-P {
- font-family: helvetica,arial,sans-serif;
- font-size: 9pt;
- font-weight: normal;
- color: darkgreen;
-}
- /* preformatted text */
-PRE {
- font-family: fixed;
- font-size: 9pt;
- font-weight: normal;
- color: darkblue;
-}
-
-TABLE {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 12pt;
- font-weight: normal;
- border-collapse: collapse;
-}
-
-TH {
- border: 1px solid black;
- padding: 0.5em;
- background-color: #eeddee;
-}
-
-TD {
- border: 1px solid black;
- padding: 0.5em;
- background-color: #ddeeee;
-}
-
-CODE {
- background-color: yellow;
-}
-
-TABLE.TAB1 {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 12pt;
- font-weight: normal;
- border-collapse: collapse;
-}
-TABLE.TAB2 {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 11pt;
- font-weight: normal;
- border-collapse: collapse;
-}
-TABLE.TAB3 {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 10pt;
- font-weight: normal;
- border-collapse: collapse;
-}
-TABLE.TAB4 {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 10pt;
- font-weight: normal;
- border-collapse: collapse;
-}
-TABLE.TAB5 {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 10pt;
- font-weight: normal;
- border-collapse: collapse;
-}
-TABLE.TAB6 {
- margin-top: 1em;
- font-family: helvetica,arial,sans-serif;
- font-size: 10pt;
- font-weight: normal;
- border-collapse: collapse;
Deleted: udd/doc/udd-from-scratch
===================================================================
--- udd/doc/udd-from-scratch 2008-09-07 16:56:01 UTC (rev 1213)
+++ udd/doc/udd-from-scratch 2008-09-07 16:57:32 UTC (rev 1214)
@@ -1,23 +0,0 @@
-This guide tells you how to start UDD from scratch.
-
-I assume that you've downloaded the code and setup and sql database.
-
-After making changes to the configuration (see config.README),
-you have to call udd-dispatch.py <configuration> setup (assuming that you didn't
-change the name of the setup source) (NOTE: This procedure is likely
-to change, as we are planning to have each source setup its own tables).
-After that, you can start importing sources. Keep in mind, though, that some
-sources depend on the existence of other sources. Currently, this means that
-packages/sources have to imported prior to popcon. To import sources, you first
-call
-udd-dispatch.py <configuration> <source name 1> [source name 2 [source name 3
-...]].
-If you want to update your data before you start importing it, you call
-udd-update.py <configuration> <source name 1> [source name 2 [source name 3
-...]].
-
-If you want to drop start cleanly and drop all tables/views from the database,
-you have to call
-udd-dispatch <configuration> delete (again, assuming that you did not change
-the name of the delete source). An alternateive to this is to just drop
-the complete database via dropdb)
More information about the Collab-qa-commits
mailing list