summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristophe Fergeau <cfergeau@redhat.com>2014-10-22 17:54:13 +0200
committerChristophe Fergeau <cfergeau@redhat.com>2014-10-23 13:47:11 +0200
commit7bc8ceea385d97203ab486983bf8d01294a87edf (patch)
tree0c4d171354894faf3a55775c795c5782b36cb65d
parent862dd223627a62593bdffb035d69c0cbfe4055a2 (diff)
man: Improve documentation for 'version' field in vv files
-rw-r--r--man/remote-viewer.pod8
1 files changed, 6 insertions, 2 deletions
diff --git a/man/remote-viewer.pod b/man/remote-viewer.pod
index 7e8718b..dc8b2e5 100644
--- a/man/remote-viewer.pod
+++ b/man/remote-viewer.pod
@@ -138,11 +138,15 @@ protocol:
=item C<version> (string)
-If remote-viewer version isn't at superior or equal to the required
-version, an error is raised with the version expected.
+If remote-viewer version number isn't greater or equal to the required
+version, an error is raised with the expected version.
The version format accepted is a list of integers separated by '.'.
+Version comparison is done by comparing each integer from the list one by
+one. If any of the component is not a number, the version comparison will fail
+and consider that the 2 versions are considered to be the same.
+
=item C<type> (string, mandatory)
The session type, either "spice", "vnc" or "ovirt".