[libvirt PATCH] tools: explain that '^' means 'Ctrl' for console escape sequence

[Michal Prívozník]

On 27. 3. 2020 16:42, Daniel P. Berrangé wrote:
> On Fri, Mar 27, 2020 at 04:34:48PM +0100, Michal Prívozník wrote:
>> On 27. 3. 2020 16:11, Daniel P. Berrangé wrote:
>>> Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
>>> ---
>>>  tools/virsh-domain.c | 6 +++++-
>>>  1 file changed, 5 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
>>> index 8591e483a5..ada0189685 100644
>>> --- a/tools/virsh-domain.c
>>> +++ b/tools/virsh-domain.c
>>> @@ -3002,7 +3002,11 @@ cmdRunConsole(vshControl *ctl, virDomainPtr dom,
>>>      }
>>>  
>>>      vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
>>> -    vshPrintExtra(ctl, _("Escape character is %s\n"), priv->escapeChar);
>>> +    vshPrintExtra(ctl, _("Escape character is %s"), priv->escapeChar);
>>> +    if (priv->escapeChar[0] == '^') {
>>> +        vshPrintExtra(ctl, " (Ctrl + %c)", priv->escapeChar[1]);
>>> +    }
> 
> I'll remove the {} to keep syntax-check happy about single line "if"


Speaking of which. That exception, while it might have served the
purpose in the past, now that the code base has grown in size I think
the less exceptions to formatting style we have the better. So maybe we
can start thinking about requiring braces for every if() ? Just a friday
evening thought.

Michal