devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Frank Rowand <frowand.list@gmail.com>
To: Pavel Machek <pavel@ucw.cz>
Cc: Rob Herring <robh@kernel.org>,
	devicetree@vger.kernel.org,
	kernel list <linux-kernel@vger.kernel.org>,
	corbet@lwn.net, linux-doc@vger.kernel.org
Subject: Re: Consistent capitalization of "device tree"?
Date: Mon, 7 Jan 2019 20:49:32 -0800	[thread overview]
Message-ID: <64534368-1ee5-3a6b-18a6-d1d527aa4bdd@gmail.com> (raw)
In-Reply-To: <20190107192458.GG933@amd>

On 1/7/19 11:24 AM, Pavel Machek wrote:
> On Mon 2019-01-07 11:06:27, Frank Rowand wrote:
>>
>> + Frank
>>
>> On 1/7/19 10:37 AM, Pavel Machek wrote:
>>> Is it "Device Tree" or "device tree"?
>>>     
>>>  pavel@duo:/data/l/k/Documentation$ grep -r "Device Tree"  | wc -l
>>>  235
>>>  pavel@duo:/data/l/k/Documentation$ grep -r "device tree"  | wc -l
>>>  595
>>>     
>>> I guess it would be nice to make it consistent. I guess "device tree"
>>> is preffered?
>>>
>>> Should we do something like this?
>>> 								Pavel
>>>
>>> Signed-off-by: Pavel Machek <pavel@ucw.cz>
>>>     
>>> diff --git a/Documentation/devicetree/overlay-notes.txt b/Documentation/devicetree/overlay-notes.txt
>>> index 725fb8d..cc5f507 100644
>>> --- a/Documentation/devicetree/overlay-notes.txt
>>> +++ b/Documentation/devicetree/overlay-notes.txt
>>> @@ -8,7 +8,7 @@ companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1]
>>>  How overlays work
>>>  -----------------
>>>  
>>> -A Device Tree's overlay purpose is to modify the kernel's live tree, and
>>> +A device tree's overlay purpose is to modify the kernel's live tree, and
>>>  have the modification affecting the state of the kernel in a way that
>>>  is reflecting the changes.
>>>  Since the kernel mainly deals with devices, any new device node that result
>>>
>>
>> Not a strong opinion, but I would prefer a third option of devicetree.  That
>> makes it much easier to search for.
> 
> That one is much less popular at the moment -- according to my
> searches... so it would be a bigger change.
> 
> (Which I'll gladly support if I won't have to do the work... as long
> as it is consistent. But I believe that "device tree" is most common
> here, makes sense, and is easiest change, so...)
> 
> 								Pavel

After finding the rest of the thread, and thinking further, I don't think
the easiest change is the correct change.  Ease of search is much more
than just grep of the kernel source, it is also web search engines.  I
think that the extra effort of "devicetree" is worth while in the long
run.  But I don't see a need to do an immediate global change - it can
happen either slowly over time or quickly as people choose to submit
patches.

-Frank

      reply	other threads:[~2019-01-08  4:49 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-07 18:37 Consistent capitalization of "device tree"? Pavel Machek
2019-01-07 18:44 ` Matthew Wilcox
2019-01-07 18:45 ` Rob Herring
2019-01-08  1:09   ` Frank Rowand
2019-01-07 19:06 ` Frank Rowand
2019-01-07 19:24   ` Pavel Machek
2019-01-08  4:49     ` Frank Rowand [this message]

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=64534368-1ee5-3a6b-18a6-d1d527aa4bdd@gmail.com \
    --to=frowand.list@gmail.com \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pavel@ucw.cz \
    --cc=robh@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).