On 2016/12/23 16:22:17 -0800, Paul E. McKenney wrote:
> On Sat, Dec 24, 2016 at 08:56:27AM +0900, Akira Yokosawa wrote:
>> On 2016/12/23 10:58:42 -0800, Paul E. McKenney wrote:
>>> On Fri, Dec 23, 2016 at 05:07:17PM +0900, Akira Yokosawa wrote:
>>>> >From cbb7797d6b307850a280248589bc09b8852e8a68 Mon Sep 17 00:00:00 2001
>>>> From: Akira Yokosawa <akiyks@xxxxxxxxx>
>>>> Date: Fri, 23 Dec 2016 16:46:06 +0900
>>>> Subject: [PATCH 0/3] Patches for recent updates
>>>>
>>>> Hi Paul,
>>>>
>>>> This short patch set consists of fixes to recent updates in
>>>> advsync/memorybarriers.
>>>>
>>>> I'm not sure what is your preference of quotation of short variable
>>>> names and keywords. In the 1st patch, I chose the form of ~~\co{a}''.
>>>> If you prefer other one, please let me know.
>>>>
>>>> Ya, I know a variety of styles are mixed-used in perfbook,
>>>> reflecting various original publications...
>>>
>>> My current rule is that an identifier can be mistaken for an English
>>> word or letter of the alphabet, then it should be in double quotation
>>> marks and under \co{}, consistent with your changes. However, something
>>> like "rcu_node" cannot reasonably be mistaken for English, so it only
>>> needs \co{}.
>>>
>>> Thoughts?
>>
>> So, the cause of potential confusion here is the use of variable name "a",
>> isn't it? If "a" were not there, other variable names b, c, q, x, and y would
>> not need quotation marks, I suppose.
>> "if", "then", and "else" still need quotation.
>>
>> Hmm?
>
> Indeed, "a" is the main cause of confusion that leads me to believe that
> single-letter variable names need quotes. Unless the variable names
> are capitalized, in which case "I" is the bad boy. ;-)
Well, "A" at the begging of a line is also confusing.
So in this case, we have another option to use a different set of variable
names and get rid of quotation marks.
For example, the following patch uses x, y, and z instead of "a", "b",
and "c". x and y are used in the explanation of transitivity, but
they are not confusing to be used in the first half of this section.
Thoughts?
Thanks, Akira
P.S.
There was another trivial typo. 2nd patch fixes it within this context.
--
Akira Yokosawa (2):
advsync/memorybarriers: Use non-confusing variable names
advsync/memorybarriers: Fix trivial typo
advsync/memorybarriers.tex | 98 +++++++++++++++++++++++-----------------------
1 file changed, 49 insertions(+), 49 deletions(-)
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe perfbook" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
