Consistent capitalization of "device tree"?

Consistent capitalization of "device tree"?

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1231 bytes --]

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

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: Consistent capitalization of "device tree"?

[Matthew Wilcox]

On Mon, Jan 07, 2019 at 07:37:11PM +0100, 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

You missed ...

$ git grep -r "Device tree" Documentation/ | wc -l
84

although at least some of those are "Capitalise device because it's the
start of a sentence".

Re: Consistent capitalization of "device tree"?

[Rob Herring]

On Mon, Jan 7, 2019 at 12:37 PM Pavel Machek <pavel@ucw.cz> 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?

Well, the spec uses "devicetree" with capital 'D' as needed (titles
and start of sentences). I didn't check if we're 100% consistent
there.

> Should we do something like this?

I'll take patches, but it wouldn't be at the top of my list.

Rob

Re: Consistent capitalization of "device tree"?

[Frank Rowand]

On 1/7/19 10:45 AM, Rob Herring wrote:
> On Mon, Jan 7, 2019 at 12:37 PM Pavel Machek <pavel@ucw.cz> 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?
> 
> Well, the spec uses "devicetree" with capital 'D' as needed (titles
> and start of sentences). I didn't check if we're 100% consistent
> there.

For reference, the specification is at:

https://www.devicetree.org/specifications/


> 
>> Should we do something like this?
> 
> I'll take patches, but it wouldn't be at the top of my list.
> 
> Rob
> 

Re: Consistent capitalization of "device tree"?

[Frank Rowand]

+ 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.

-Frank

Re: Consistent capitalization of "device tree"?

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1903 bytes --]

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

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: Consistent capitalization of "device tree"?

[Frank Rowand]

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