design-autorepair.rst: separate list of jobs with plus sign
authorDato Simó <dato@google.com>
Mon, 14 Jan 2013 20:41:46 +0000 (20:41 +0000)
committerDato Simó <dato@google.com>
Tue, 15 Jan 2013 13:16:51 +0000 (13:16 +0000)
Commas are not valid characters in tags, hence they can't be use to
separate the different job IDs; plus signs (+) are available, and not too
bad.

Signed-off-by: Dato Simó <dato@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>

doc/design-autorepair.rst

index cf2b866..5ab446b 100644 (file)
@@ -134,8 +134,8 @@ to this instance for this ``id`` (we will "update" the tag by adding a
 the timestamp will never change for the same repair)
 
 ``jobs`` is the list of jobs already run or being run to repair the
-instance. If the instance has just been put in pending state but no job
-has run yet, this list is empty.
+instance (separated by a plus sign, *+*). If the instance has just
+been put in pending state but no job has run yet, this list is empty.
 
 This tag will be set by ganeti if an equivalent autorepair tag is
 present and a a repair is needed, or can be set by an external tool to
@@ -150,8 +150,8 @@ ganeti:watcher:autorepair:result:<type>:<id>:<timestamp>:<result>:<jobs>
 (instance)
 If this tag is present a repair of type ``type`` has been performed on
 the instance and has been completed by ``timestamp``. The result is
-either ``success``, ``failure`` or ``enoperm``, and jobs is a comma
-separated list of jobs that were executed for this repair.
+either ``success``, ``failure`` or ``enoperm``, and jobs is a
+*+*-separated list of jobs that were executed for this repair.
 
 An ``enoperm`` result is returned when the repair was brought on until
 possible, but the repair type doesn't consent to proceed further.