[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[virt-tools-list] [PATCH] python-virtinst: fix documentation about default serial mode



Contrary to what's documented, the default mode is 'bind'. I would
prefer to have default to 'connect', but that would break current
cli users who may rely on 'bind' by default.
---
 man/en/virt-install.1         |   12 ++++++------
 man/en/virt-install.pod.in    |   10 +++++-----
 virtinst/VirtualCharDevice.py |    4 ++--
 3 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/man/en/virt-install.1 b/man/en/virt-install.1
index 21a5ac1..c72af5e 100644
--- a/man/en/virt-install.1
+++ b/man/en/virt-install.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "VIRT-INSTALL 1"
-.TH VIRT-INSTALL 1 "2011-08-29" "" "Virtual Machine Install Tools"
+.TH VIRT-INSTALL 1 "2011-08-30" "" "Virtual Machine Install Tools"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -988,18 +988,18 @@ Named pipe (see \fIpipe\fR\|(7))
 .IP "\fB\-\-serial tcp,host=HOST:PORT,mode=MODE,protocol=PROTOCOL\fR" 4
 .IX Item "--serial tcp,host=HOST:PORT,mode=MODE,protocol=PROTOCOL"
 \&\s-1TCP\s0 net console. \s-1MODE\s0 is either 'bind' (wait for connections on \s-1HOST:PORT\s0)
-or 'connect' (send output to \s-1HOST:PORT\s0), default is 'connect'. \s-1HOST\s0 defaults
+or 'connect' (send output to \s-1HOST:PORT\s0), default is 'bind'. \s-1HOST\s0 defaults
 to '127.0.0.1', but \s-1PORT\s0 is required. \s-1PROTOCOL\s0 can be either 'raw' or 'telnet'
 (default 'raw'). If 'telnet', the port acts like a telnet server or client.
 Some examples:
 .Sp
-Connect to localhost, port 1234:
+Wait for connections on any address, port 4567:
 .Sp
-\&\-\-serial tcp,host=:1234
+\&\-\-serial tcp,host=0.0.0.0:4567
 .Sp
-Wait for connections on any address, port 4567:
+Connect to localhost, port 1234:
 .Sp
-\&\-\-serial tcp,host=0.0.0.0:4567,mode=bind
+\&\-\-serial tcp,host=:1234,mode=connect
 .Sp
 Wait for telnet connection on localhost, port 2222. The user could then
 connect interactively to this console via 'telnet localhost 2222':
diff --git a/man/en/virt-install.pod.in b/man/en/virt-install.pod.in
index f174250..b368e2a 100644
--- a/man/en/virt-install.pod.in
+++ b/man/en/virt-install.pod.in
@@ -972,18 +972,18 @@ Named pipe (see pipe(7))
 =item B<--serial tcp,host=HOST:PORT,mode=MODE,protocol=PROTOCOL>
 
 TCP net console. MODE is either 'bind' (wait for connections on HOST:PORT)
-or 'connect' (send output to HOST:PORT), default is 'connect'. HOST defaults
+or 'connect' (send output to HOST:PORT), default is 'bind'. HOST defaults
 to '127.0.0.1', but PORT is required. PROTOCOL can be either 'raw' or 'telnet'
 (default 'raw'). If 'telnet', the port acts like a telnet server or client.
 Some examples:
 
-Connect to localhost, port 1234:
+Wait for connections on any address, port 4567:
 
---serial tcp,host=:1234
+--serial tcp,host=0.0.0.0:4567
 
-Wait for connections on any address, port 4567:
+Connect to localhost, port 1234:
 
---serial tcp,host=0.0.0.0:4567,mode=bind
+--serial tcp,host=:1234,mode=connect
 
 Wait for telnet connection on localhost, port 2222. The user could then
 connect interactively to this console via 'telnet localhost 2222':
diff --git a/virtinst/VirtualCharDevice.py b/virtinst/VirtualCharDevice.py
index 6d72beb..5844e5d 100644
--- a/virtinst/VirtualCharDevice.py
+++ b/virtinst/VirtualCharDevice.py
@@ -122,9 +122,9 @@ class VirtualCharDevice(VirtualDevice.VirtualDevice):
         desc = ""
 
         if char_mode == VirtualCharDevice.CHAR_MODE_CONNECT:
-            desc = _("Client mode.")
+            desc = _("Client mode")
         elif char_mode == VirtualCharDevice.CHAR_MODE_BIND:
-            desc = _("Server mode.")
+            desc = _("Server mode")
 
         return desc
     get_char_mode_desc = staticmethod(get_char_mode_desc)
-- 
1.7.6


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]