search

ARM-software / ebbr

Embedded Base Boot Requirements Specification
Creative Commons Attribution Share Alike 4.0 International
113 stars 36 forks source link

Minor suggestions to hopefully improve the text #59

Closed sjg20 closed 3 years ago

sjg20 commented 3 years ago

Correct some missing hyphens and reword a few things.

Signed-off-by: Simon Glass sjg@chromium.org

daniel-thompson commented 3 years ago

Note that I did not open the files further to see if other instances of missed hyphenations were present. I'd do a coin flip at this moment to guess whether there are or not. Hopefully you'll take a second look at the sources to see.

Currently there are no instances of EBBR-compliant anywhere in the specification, throughout the document this concept is spelled "EBBR compliant". Personally I'd prefer to avoid unnecessary-hyphens but it's a bike shedding topic ;-) so I'll defer to Grant if he prefers to draft it differently.

sjg20 commented 3 years ago

Note that I did not open the files further to see if other instances of missed hyphenations were present. I'd do a coin flip at this moment to guess whether there are or not. Hopefully you'll take a second look at the sources to see.

Currently there are no instances of EBBR-compliant anywhere in the specification, throughout the document this concept is spelled "EBBR compliant". Personally I'd prefer to avoid unnecessary-hyphens but it's a bike shedding topic ;-) so I'll defer to Grant if he prefers to draft it differently.

EBBR-compliant is an adjective, or intended to be, as in EBBR-compliant device.

https://owl.purdue.edu/owl/general_writing/punctuation/hyphen_use.html

daniel-thompson commented 3 years ago

Currently there are no instances of EBBR-compliant anywhere in the specification, throughout the document this concept is spelled "EBBR compliant". Personally I'd prefer to avoid unnecessary-hyphens but it's a bike shedding topic ;-) so I'll defer to Grant if he prefers to draft it differently.

EBBR-compliant is an adjective, or intended to be, as in EBBR-compliant device.

On my side it neither a strongly held conviction nor a strongly-held conviction although a search engine fight does very marginally prefer the former in this case. However that's mostly because there is no need to compound here because the adverb prevents incorrect parsing.

The UEFI specification, which has more than a passing influence over EBBR, doesn't give a strong lead either since it uses [U]EFI compliant as an adjective both hyphenated and unhyphenated. The compound form does have roughly 60:40 majority once the uses that all have agreed not to compound are removed.

glikely commented 3 years ago

Thanks Simon,

I've picked up the editorial and typo fixes, but dropped the hyphenation and text reflow changes. For the hyphenation I think there isn't a clear need for one way over the other so it lands in the personal preference category. In which case I prefer to leave the text as-is, particularly on a patch that touches a large portion of the text and will probably cause merge conflicts.

g.

glikely commented 3 years ago

Oops, forgot to comment on the text reflow. Similar to the hyphenation, without a strong need to reflow now I'd rather leave reflowing to when a block of text is actually being reworded to reduce the size of diffs for reviewers.