All of lore.kernel.org
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Cc: perfbook@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 0/2] advsync: Use different set of variable names (was Re: [PATCH 0/3] Patches for recent updates)
Date: Sat, 24 Dec 2016 13:21:51 +0900	[thread overview]
Message-ID: <4d1151a1-49c0-45ad-e4fb-5ee8120e352e@gmail.com> (raw)
In-Reply-To: <20161224002217.GE3742@linux.vnet.ibm.com>

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@gmail.com>
>>>> 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


  reply	other threads:[~2016-12-24  4:21 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-23  8:07 [PATCH 0/3] Patches for recent updates Akira Yokosawa
2016-12-23  8:09 ` [PATCH 1/3] advsync/memorybarriers: Use consistent quotation marks Akira Yokosawa
2016-12-23  8:10 ` [PATCH 2/3] advsync/memorybarriers: Fix typo (READ_ONCE -> WRITE_ONCE) Akira Yokosawa
2016-12-23  8:11 ` [PATCH 3/3] advsync/memorybarriers: Fix trivial typo Akira Yokosawa
2016-12-23 18:58 ` [PATCH 0/3] Patches for recent updates Paul E. McKenney
2016-12-23 23:56   ` Akira Yokosawa
2016-12-24  0:22     ` Paul E. McKenney
2016-12-24  4:21       ` Akira Yokosawa [this message]
2016-12-24  4:24         ` [PATCH 1/2] advsync/memorybarriers: Use non-confusing variable names Akira Yokosawa
2016-12-24  4:25         ` [PATCH 2/2] advsync/memorybarriers: Fix trivial typo Akira Yokosawa

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4d1151a1-49c0-45ad-e4fb-5ee8120e352e@gmail.com \
    --to=akiyks@gmail.com \
    --cc=paulmck@linux.vnet.ibm.com \
    --cc=perfbook@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.