| Message ID | 1366798350-27068-4-git-send-email-lilei@linux.vnet.ibm.com |
|---|---|
| State | New |
| Headers | show |
On 04/24/2013 04:12 AM, Lei Li wrote: > Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> > --- > docs/vnc-ledstate-Pseudo-encoding.txt | 40 +++++++++++++++++++++++++++++++++ > 1 files changed, 40 insertions(+), 0 deletions(-) > create mode 100644 docs/vnc-ledstate-Pseudo-encoding.txt > > + > +The Pseudo-encoding number for LED state defined as: > + > +======= =============================================================== > +Number Name > +======= =============================================================== > +-261 'LED state Pseudo-encoding'_ Is the trailing _ intentional? > +======= =============================================================== > + > +LED state Pseudo-enconding s/enconding/encoding/ > +-------------------------- > + > +The LED state Pseudo-encoding describes the encoding of LED state which > +consists of 3 bits, each bit represents the Caps, Num, and Scroll lock > +key respectively. '1' indicates that the LED should be on and '0' should > +be off. Which bit is which? Is bit 0 the Caps lock LED?
On 04/24/2013 10:57 PM, Eric Blake wrote: > On 04/24/2013 04:12 AM, Lei Li wrote: >> Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> >> --- >> docs/vnc-ledstate-Pseudo-encoding.txt | 40 +++++++++++++++++++++++++++++++++ >> 1 files changed, 40 insertions(+), 0 deletions(-) >> create mode 100644 docs/vnc-ledstate-Pseudo-encoding.txt >> >> + >> +The Pseudo-encoding number for LED state defined as: >> + >> +======= =============================================================== >> +Number Name >> +======= =============================================================== >> +-261 'LED state Pseudo-encoding'_ > Is the trailing _ intentional? Yes, add this trailing '_' to indicate that this is a quoted context and you can locate its section somewhere. I saw this style used in RFB protocol, but it's not necessary. I'd get rid of it if you don't like it. :) > >> +======= =============================================================== >> + >> +LED state Pseudo-enconding > s/enconding/encoding/ Sure. >> +-------------------------- >> + >> +The LED state Pseudo-encoding describes the encoding of LED state which >> +consists of 3 bits, each bit represents the Caps, Num, and Scroll lock >> +key respectively. '1' indicates that the LED should be on and '0' should >> +be off. > Which bit is which? Is bit 0 the Caps lock LED? Caps lock key is represented as '100', and Scroll lock key is represented as '001'. Sorry, I should describe it more clearly. Or maybe I should include the example of the encodings defined? >
On 04/24/2013 08:25 PM, Lei Li wrote: > On 04/24/2013 10:57 PM, Eric Blake wrote: >> On 04/24/2013 04:12 AM, Lei Li wrote: >>> Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> >>> --- >>> docs/vnc-ledstate-Pseudo-encoding.txt | 40 >>> +++++++++++++++++++++++++++++++++ >>> 1 files changed, 40 insertions(+), 0 deletions(-) >>> create mode 100644 docs/vnc-ledstate-Pseudo-encoding.txt >>> >>> + >>> +The Pseudo-encoding number for LED state defined as: >>> + >>> +======= =============================================================== >>> +Number Name >>> +======= =============================================================== >>> +-261 'LED state Pseudo-encoding'_ >> Is the trailing _ intentional? > > Yes, add this trailing '_' to indicate that this is a quoted context and > you can > locate its section somewhere. > I saw this style used in RFB protocol, but it's not necessary. I'd get > rid of it > if you don't like it. :) I didn't read the RFB protocol; if you are being consistent with a parent document that you are extending, then by all means use the same conventions. >> Which bit is which? Is bit 0 the Caps lock LED? > > Caps lock key is represented as '100', and Scroll lock key is > represented as '001'. > Sorry, I should describe it more clearly. Yep, especially since your choice of encoding was opposite to mine. A good protocol should be easy to implement. I don't care which order the bits go in, as long as everyone treats the same bit as caps lock based on good docs. > Or maybe I should include the example of the encodings defined? In my opinion, adding an example will never hurt :)
diff --git a/docs/vnc-ledstate-Pseudo-encoding.txt b/docs/vnc-ledstate-Pseudo-encoding.txt new file mode 100644 index 0000000..0c312cf --- /dev/null +++ b/docs/vnc-ledstate-Pseudo-encoding.txt @@ -0,0 +1,40 @@ +VNC LED state Pseudo-encoding +============================= + +Introduction +------------ + +This document describes the Pseudo-encoding of LED state for RFB which +is the protocol used in VNC as reference link below: + +http://tigervnc.svn.sourceforge.net/viewvc/tigervnc/rfbproto/rfbproto.rst?content-type=text/plain + +When accessing a guest by console through VNC, there might be mismatch +between the lock keys notification LED on the computer running the VNC +client session and the current status of the lock keys on the guest +machine. + +To solve this problem it attempts to add LED state Pseudo-encoding +extension to VNC protocol to deal with setting LED state. + +Pseudo-encoding +--------------- + +This Pseudo-encoding requested by client declares to server that it supports +LED state extensions to the protocol. + +The Pseudo-encoding number for LED state defined as: + +======= =============================================================== +Number Name +======= =============================================================== +-261 'LED state Pseudo-encoding'_ +======= =============================================================== + +LED state Pseudo-enconding +-------------------------- + +The LED state Pseudo-encoding describes the encoding of LED state which +consists of 3 bits, each bit represents the Caps, Num, and Scroll lock +key respectively. '1' indicates that the LED should be on and '0' should +be off.
Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com> --- docs/vnc-ledstate-Pseudo-encoding.txt | 40 +++++++++++++++++++++++++++++++++ 1 files changed, 40 insertions(+), 0 deletions(-) create mode 100644 docs/vnc-ledstate-Pseudo-encoding.txt