[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Where is GLOBAL_COMMAND?
From: |
Eric Blake |
Subject: |
Re: Where is GLOBAL_COMMAND? |
Date: |
Tue, 22 Jan 2019 13:45:45 -0600 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.4.0 |
On 1/22/19 7:47 AM, Peng Yu wrote:
>> grep global_command *.?
>
> GLOBAL_COMMAND is uppercase. But the actual variable name
> global_command is in lowercase.
That's a documentation convention - the all-caps in the docstring calls
your attention to the need to search case-insensitively for the actual
variable, while spelling it case-sensitively would make it blend into
the sentence and make it harder to realize that the sentence is indeed
pointing you to an external variable.
>
> I think that GLOBAL_COMMAND should be changed to global_command in the
> comment.
If you think the existing convention is confusing, then submit a patch
to change it instead of asking someone else to take on the grunt work.
Otherwise, learn to live with the existing convention (which doesn't
bother me, so I won't be submitting a patch).
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
signature.asc
Description: OpenPGP digital signature