Skip to contentSkip to conversation

Consistent capitalization of "device tree"?

PATCH Pavel Machek 4 participants 7 messages Jan 7, 2019 – Jan 8, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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

Documentation/devicetree/overlay-notes.txt +1 -1
index 725fb8d..cc5f507 100644
@@ -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
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#1 lore raw
Quoted 6 lines · Pavel Machek

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

maintainer
#2 lore raw
In reply to Pavel Machek
Quoted 10 lines · Pavel Machek

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.

Quoted 1 line

Should we do something like this?

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

Rob

#3 lore raw
Quoted 9 lines · Rob Herring
Quoted 8 lines · Pavel Machek

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
Quoted 6 lines
Quoted 2 lines

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/

Quoted 7 lines
Quoted 2 lines

Should we do something like this?

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

Rob

#4 lore raw
In reply to Pavel Machek

+ Frank

Quoted 21 lines · Pavel Machek

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

Documentation/devicetree/overlay-notes.txt +0 -0
index 725fb8d..cc5f507 100644

Documentation/devicetree/overlay-notes.txt companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1] · line 14

Quoted 8 lines
Documentation/devicetree/overlay-notes.txt +1 -1
@@ -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

#5 lore raw
Quoted 27 lines · Frank Rowand

+ Frank

Quoted 23 lines · Pavel Machek

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

Documentation/devicetree/overlay-notes.txt +0 -0
index 725fb8d..cc5f507 100644
@@ -8,7 +8,7 @@ companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1]
 How overlays work
 -----------------
 
Quoted 9 lines

Documentation/devicetree/overlay-notes.txt companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1] · line 14

Quoted 6 lines
Documentation/devicetree/overlay-notes.txt +1 -1
-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

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#6 lore raw
Quoted 38 lines · Pavel Machek
Quoted 27 lines · Frank Rowand

+ Frank

Quoted 23 lines · Pavel Machek

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

Documentation/devicetree/overlay-notes.txt +0 -0
index 725fb8d..cc5f507 100644
@@ -8,7 +8,7 @@ companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1]
 How overlays work
 -----------------
 
Quoted 9 lines

Documentation/devicetree/overlay-notes.txt companion document to Documentation/devicetree/dynamic-resolution-notes.txt[1] · line 14

Quoted 6 lines
Documentation/devicetree/overlay-notes.txt +1 -1
-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.

Quoted 8 lines

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