# HG changeset patch
# User Waqas Hussain <waqas20@gmail.com>
# Date 1223815097 -18000
# Node ID ca7bad346cdee58713828aa7c5dfb6c10d565505
# Parent  c3f12fd0c8232b11adca1eaa21b5178eff7c4578
Documented the roster object's structure

diff -r c3f12fd0c823 -r ca7bad346cde doc/roster_format.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/roster_format.txt	Sun Oct 12 17:38:17 2008 +0500
@@ -0,0 +1,18 @@
+
+This file documents the structure of the roster object.
+
+table roster {
+  [string bare_jid] = roster_item
+}
+
+table roster_item {
+  string subscription = "none" | "to" | "from" | "both"
+  string name = Opaque string set by client. (optional)
+  set groups = a set of opaque strings set by the client
+}
+
+The roster is available as
+ hosts[host].sessions[username].roster
+and a copy is made to session.roster for all sessions.
+
+All modifications to a roster should be done through the rostermanager.