Code

issue2550729: Fix password history display for anydbm backend, thanks to
[roundup.git] / doc / design.txt
index 4cee32eb5c1d52a67a2c84dcf3955552caf54ab3..0748fa29183de290805d49dcb868ba150f0cd292 100644 (file)
@@ -475,6 +475,8 @@ Here is the interface provided by the hyperdatabase::
             match the 'filter' spec, sorted by the group spec and then the
             sort spec.
 
+            "search_matches" is a container type
+
             "filterspec" is {propname: value(s)}
 
             "sort" and "group" are [(dir, prop), ...] where dir is '+', '-'
@@ -482,8 +484,6 @@ Here is the interface provided by the hyperdatabase::
             backward-compatibility reasons a single (dir, prop) tuple is
             also allowed.
 
-            "search_matches" is {nodeid: marker}
-
             The filter must match all properties specificed. If the property
             value to match is a list:
 
@@ -1008,7 +1008,7 @@ module.)
 Command Interface Specification
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-A single command, roundup, provides basic access to the hyperdatabase
+A single command, ``roundup-admin``, provides basic access to the hyperdatabase
 from the command line::
 
     roundup-admin help
@@ -1039,11 +1039,12 @@ the printed results:
   are both accepted; an empty string, a single item, or a list of items
   joined by commas is accepted.
 
-When multiple items are specified to the roundup get or roundup set
+When multiple items are specified to the roundup-admin get or roundup-admin set
 commands, the specified properties are retrieved or set on all the
 listed items.
 
-When multiple results are returned by the roundup get or roundup find
+When multiple results are returned by the roundup-admin get or
+roundup-admin find
 commands, they are printed one per line (default) or joined by commas
 (with the -list) option.
 
@@ -1055,8 +1056,8 @@ To find all messages regarding in-progress issues that contain the word
 "spam", for example, you could execute the following command from the
 directory where the database dumps its files::
 
-    shell% for issue in `roundup find issue status=in-progress`; do
-    > grep -l spam `roundup get $issue messages`
+    shell% for issue in `roundup-admin find issue status=in-progress`; do
+    > grep -l spam `roundup-admin get $issue messages`
     > done
     msg23
     msg49
@@ -1066,8 +1067,8 @@ directory where the database dumps its files::
 
 Or, using the -list option, this can be written as a single command::
 
-    shell% grep -l spam `roundup get \
-        \`roundup find -list issue status=in-progress\` messages`
+    shell% grep -l spam `roundup-admin get \
+        \`roundup-admin find -list issue status=in-progress\` messages`
     msg23
     msg49
     msg50
@@ -1156,7 +1157,7 @@ Setting Properties
 The e-mail interface also provides a simple way to set properties on
 issues.  At the end of the subject line, ``propname=value`` pairs can be
 specified in square brackets, using the same conventions as for the
-roundup ``set`` shell command.
+roundup-admin ``set`` shell command.
 
 
 Web User Interface
@@ -1652,10 +1653,5 @@ Changes to this document
 - Access Controls
 - Added "actor" property
 
-------------------
-
-Back to `Table of Contents`_
-
-.. _`Table of Contents`: index.html
 .. _customisation: customizing.html