summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoel Andres Granados <jgranado@redhat.com>2008-05-27 17:27:16 +0200
committerJoel Andres Granados <jgranado@redhat.com>2008-05-27 17:27:16 +0200
commit66a081a3c9d155e0cbd22180f4beebc62e052ae1 (patch)
tree520bf0322efdfa26a5291bc4dc786852a1c9858f /doc
parent5e89a201e82ac26d44bb9f9777be577d514ddda7 (diff)
downloadfirstaidkit-66a081a3c9d155e0cbd22180f4beebc62e052ae1.tar.gz
firstaidkit-66a081a3c9d155e0cbd22180f4beebc62e052ae1.tar.xz
firstaidkit-66a081a3c9d155e0cbd22180f4beebc62e052ae1.zip
Be consistent with the use of ".IP" in the man pages
Diffstat (limited to 'doc')
-rw-r--r--doc/firstaidkit-reporting.122
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/firstaidkit-reporting.1 b/doc/firstaidkit-reporting.1
index 1cf1b58..685a8b3 100644
--- a/doc/firstaidkit-reporting.1
+++ b/doc/firstaidkit-reporting.1
@@ -39,28 +39,28 @@ Importance specified by loggin levels. For more information see the python modul
Most of the types have their own shortcut method in the self._reporting object.
FirstAidKit recognises following message types (semantics):
-.IP START
+.IP "START"
Message field is not used. This message reports start event of something. (specified by level and origin)
-.IP STOP
+.IP "STOP"
Counterpart for the START message
-.IP PROGRESS
+.IP "PROGRESS"
This message reports change in some progress. The message field holds tuple in the form of (step,numberofsteps).
-.IP INFO
+.IP "INFO"
Simple text message.
-.IP ALERT
+.IP "ALERT"
Text message to be shown VERY visible. The importance field is almost ignored.
-.IP EXCEPTION
+.IP "EXCEPTION"
Report some coding/process error during operations. The message field holds the exception instance.
-.IP TABLE
+.IP "TABLE"
The message field hold arbitrary table-like organized iterable (eg. same number of columns in all rows)
-.IP TREE
+.IP "TREE"
This message type denoted arbitrary nested iterable organized as tree
-.IP ISSUE
+.IP "ISSUE"
If any Issue-like object changed state and the plugin want to present user with update on it's state, use this
message. It's message field holds the reference to the Issue object in question.
-.IP QUESTION
+.IP "QUESTION"
We do not support the interactive mode at the moment, but this message will allow you to ask the user some questions.
-.IP END
+.IP "END"
End of operations, final message which shuts down all subsystems. It is send by the Tasker and you must not use it manually.
.PP