From 93e7631ac20edd0dcd59f51456c605bd66f1f3d8 Mon Sep 17 00:00:00 2001
From: Marko Kreen <markokr@gmail.com>
Date: Tue, 2 Jun 2009 13:33:14 +0300
Subject: [PATCH] doc update

---
 README               | 46 +++++++++++++++++++++++++++++++++++++++
 doc/TODO.txt         | 52 ++++++++++++++++++++++++++++----------------
 doc/londiste.ref.txt |  5 +++++
 3 files changed, 84 insertions(+), 19 deletions(-)

diff --git a/README b/README
index 1332f3e4..07b13e87 100644
--- a/README
+++ b/README
@@ -53,3 +53,49 @@ This script will setup WAL archiving, does initial backup and
 runtime WAL archive and restore.
 
 
+== Source tree contents ==
+
+  doc/ 
+    Documentation in asciidoc format.  Source for both html
+    and man pages.
+
+  python/
+    Python modules and primary executables - walmgr, londiste, qadmin, pgqadm.
+
+  python/pgq/
+    Python framework for PgQ.
+
+  python/londiste/
+    Londiste replication.
+
+  python/skytools/
+    Low-level utilities for writing database scripts in Python.
+
+  sql/
+    Database modules.
+
+  sql/pgq/
+    Table definitions and functions for PgQ queueing.
+
+  sql/pgq_coop/
+    Functions for cooperative consuming.
+
+  sql/londiste/
+    Table definitions and functions for Londiste replication.
+
+  sql/ticker/
+    PgQ ticker written in C.
+ 
+  scripts/
+    Python scripts with lesser priority.
+
+  lib/
+    libusual C libary, for pgqd.
+
+  debian/
+    Debian packaging.  This is for creating private packages,
+    official Debian packages uses it's own packagin code.
+
+  misc/
+    Random scripts used for building.
+
diff --git a/doc/TODO.txt b/doc/TODO.txt
index 0386b8be..583cd2d7 100644
--- a/doc/TODO.txt
+++ b/doc/TODO.txt
@@ -7,27 +7,42 @@ who already is handling it.
 
 == Done for 3.0a2 ==
 
-* config templates in docstr
-* takeover
-* status with dead nodes
-* resync
-* missing
-* --all
-* globbing
-* pgqd: database_list
-* relaxed event processing for python modules
-
-== Good for 3.0a2 ==
-
-* compare/repair
-* fkeys
-* londiste.ref.txt update with new commands [moderate]
+* newadm: rename to qadmin
+* pgq
+  - drop failed event concept
+  - relaxed event processing for python modules
+* python/skytools:
+  - config templates in docstr
+  - show connection name with error message
+  - use config file name as default job name
+  - new querybuilder class
+  - .getdict() method for Config
+* pgqd:
+  - specifying fixed list of databases in config works
+  - periodic detection works
+* cascading
+  - fix watermark publishing
+  - several log message and level fixes
+  - Replace 'switchover'/'failover' with 'takeover'
+  - 'status' with dead nodes works
+* londiste
+  - resync
+  - missing
+  - --all
+  - globbing
+  - compare/repair
 
 == Required for 3.0-final ==
 
-* execute --wait
 * Simple Python consumer for pgq_coop, where each subconsumer
   is separate process. [easy]
+* qadmin, pgqadm: show stats about event counts based on seq values in ticks. [easy]
+* londiste, struct change needed:
+  - londiste doc update with new commands [easy]
+  - store last error [easy]
+  - support WHERE for COPY [easy]
+  - fkeys, from 2.x [easy]
+  - execute --wait [moderate]
 
 == Good to have changes ==
 
@@ -37,8 +52,6 @@ who already is handling it.
 
 * pgq_node.is_root_event() rettype [easy, but hard to decide]
 
-* pgq, pgqadm: show stats about event counts based on seq values in ticks. [3.0, easy]
-
 === python/skytools ===
 
 * Sleeping while waiting notices from db.  It seems good to speed up
@@ -81,7 +94,6 @@ who already is handling it.
   - Wait until COPY finishes.
   - Do not allow?
 
-
 === sql/londiste ===
 
 * plpgsql trigger for TRUNCATE and Londiste support for installing such trigger [moderate]
@@ -112,6 +124,8 @@ who already is handling it.
 
 === Smaller things ===
 
+* 'delay' param for consumer
+
 * londiste: londiste status cmd [moderate]
  - check what modules are installed
  - check if replay is running (lag?)
diff --git a/doc/londiste.ref.txt b/doc/londiste.ref.txt
index a7cf4a84..bb6a2e5b 100644
--- a/doc/londiste.ref.txt
+++ b/doc/londiste.ref.txt
@@ -79,6 +79,11 @@ The insert happens in same TX as the actual command are executed.
 Script is identified by name - it is used to check if it is already applied.
 This allows to override scripts in downstream nodes.
 
+== table attributes ==
+
+* skip_truncate
+* copy_where
+
 == log file ==
 
 Londiste normal log consist just of statistics log-lines, key-value
-- 
2.39.5