From: Richard Jones Date: Mon, 10 Aug 2009 16:28:32 +0000 (+0100) Subject: Swap >>> and <<< in protocol description. X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=093d4be606a60459dea1c9a62616429596957385;p=virt-hostinfo.git Swap >>> and <<< in protocol description. --- diff --git a/hostinfod/hostinfo-protocol.pod b/hostinfod/hostinfo-protocol.pod index eb9f40c..f322bca 100644 --- a/hostinfod/hostinfo-protocol.pod +++ b/hostinfod/hostinfo-protocol.pod @@ -6,8 +6,8 @@ hostinfo-protocol - hostinfo client commands and protocol =head1 SYNOPSIS - >>> PING "hello" - <<< 1.0 200 hello + <<< PING "hello" + >>> 1.0 200 hello =head1 DESCRIPTION @@ -60,15 +60,15 @@ request), and then reading the reply. A typical request/reply cycle looks like: - >>> PING "hello" - <<< 1.0 200 hello + <<< PING "hello" + >>> 1.0 200 hello In this case the request was the literal string C<"PING \"hello\"\r\n"> (note: followed by carriage return [CR] and line feed [LF]). The reply was C<"1.0 200 hello\r\n">. -The EEE and EEE symbols are not part of +The EEE and EEE symbols are not part of the protocol. They indicate messages sent to the host and received from the host respectively. @@ -101,15 +101,15 @@ Some commands (but not PING) can return a multi-line response. A few commands return a multi-line response: - >>> CAPABILITIES - <<< 1.0 200 - <<< Content-Type: text/xml - <<< Content-Length: 123 - <<< - <<< - <<< - <<< - <<< i686 + <<< CAPABILITIES + >>> 1.0 200 + >>> Content-Type: text/xml + >>> Content-Length: 123 + >>> + >>> + >>> + >>> + >>> i686 (etc.) The multi-line response consists of headers and blank line and a body, @@ -128,8 +128,8 @@ followed by the CR LF immediately. For example C<"1.0 200\r\n">. When a command returns an error, the request / response looks like this: - >>> NOSUCHCOMMAND - <<< 1.0 404 Command not found + <<< NOSUCHCOMMAND + >>> 1.0 404 Command not found As in HTTP, C<4xx> and C<5xx> status codes indicate classes of error. Following the error code is an explanatory string. @@ -187,8 +187,8 @@ Number of available physical cores in the host. =head3 Example - >>> AVAILCPUS - <<< 1.0 200 4 + <<< AVAILCPUS + >>> 1.0 200 4 =head3 Description @@ -206,8 +206,8 @@ Number of cores per socket in the physical host. =head3 Example - >>> CORESPERSOCKET - <<< 1.0 200 2 + <<< CORESPERSOCKET + >>> 1.0 200 2 =head3 Description @@ -223,8 +223,8 @@ Amount of memory in host, in kilobytes. =head3 Example - >>> MEMORY - <<< 1.0 200 2097022 + <<< MEMORY + >>> 1.0 200 2097022 =head3 Description @@ -240,8 +240,8 @@ Speed of host cores in MHz. =head3 Example - >>> MHZ - <<< 1.0 200 2047 + <<< MHZ + >>> 1.0 200 2047 =head3 Description @@ -257,8 +257,8 @@ The host CPU model, a string such as C or C. =head3 Example - >>> MODEL - <<< 1.0 200 x86_64 + <<< MODEL + >>> 1.0 200 x86_64 =head3 Description @@ -274,8 +274,8 @@ The number of NUMA nodes in the host. =head3 Example - >>> NODES - <<< 1.0 200 1 + <<< NODES + >>> 1.0 200 1 =head3 Description @@ -292,8 +292,8 @@ The number of physical cores. =head3 Example - >>> PHYSCPUS - <<< 1.0 200 4 + <<< PHYSCPUS + >>> 1.0 200 4 =head3 Description @@ -322,8 +322,8 @@ Returns C back to the caller. =head3 Example - >>> PING "hello" - <<< 1.0 200 hello + <<< PING "hello" + >>> 1.0 200 hello =head3 Description @@ -369,8 +369,8 @@ The number of sockets on each node. =head3 Example - >>> SOCKETSPERNODE - <<< 1.0 200 2 + <<< SOCKETSPERNODE + >>> 1.0 200 2 =head3 Description @@ -386,8 +386,8 @@ The number of hyperthreads per core. =head3 Example - >>> THREADSPERCORE - <<< 1.0 200 1 + <<< THREADSPERCORE + >>> 1.0 200 1 =head3 Description