changeset 4299:e16a1131ba67

include info on what a designator is in all commands that use them
author Richard Jones <richard@users.sourceforge.net>
date Mon, 07 Dec 2009 00:33:39 +0000
parents f6468c5e1493
children 608919e3bbbf
files doc/upgrading.txt roundup/admin.py
diffstat 2 files changed, 19 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/upgrading.txt	Mon Dec 07 00:26:12 2009 +0000
+++ b/doc/upgrading.txt	Mon Dec 07 00:33:39 2009 +0000
@@ -13,7 +13,7 @@
 
 .. contents::
 
-Migrating from 1.4.x to 1.4.10
+Migrating from 1.4.x to 1.4.11
 ==============================
 
 Grant the "Register" permission to the Anonymous role
--- a/roundup/admin.py	Mon Dec 07 00:26:12 2009 +0000
+++ b/roundup/admin.py	Mon Dec 07 00:33:39 2009 +0000
@@ -523,6 +523,9 @@
         ''"""Usage: get property designator[,designator]*
         Get the given property of one or more designator(s).
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         Retrieves the property value of the nodes specified
         by the designators.
         """
@@ -600,6 +603,9 @@
         The items are specified as a class or as a comma-separated
         list of item designators (ie "designator[,designator,...]").
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         This command sets the properties to the values for all designators
         given. If the value is missing (ie. "property=") then the property
         is un-set. If the property is a multilink, you specify the linked
@@ -732,6 +738,9 @@
         ''"""Usage: display designator[,designator]*
         Show the property values for the given node(s).
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         This lists the properties and their associated values for the given
         node.
         """
@@ -971,6 +980,9 @@
         ''"""Usage: history designator
         Show the history entries of a designator.
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         Lists the journal entries for the node identified by the designator.
         """
         if len(args) < 1:
@@ -1020,6 +1032,9 @@
         ''"""Usage: retire designator[,designator]*
         Retire the node specified by designator.
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         This action indicates that a particular node is not to be retrieved
         by the list or find commands, and its key value may be re-used.
         """
@@ -1044,6 +1059,9 @@
         ''"""Usage: restore designator[,designator]*
         Restore the retired node specified by designator.
 
+        A designator is a classname and a nodeid concatenated,
+        eg. bug1, user10, ...
+
         The given nodes will become available for users again.
         """
         if len(args) < 1:

Roundup Issue Tracker: http://roundup-tracker.org/