-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Spelling and Grammar edits #117
Spelling and Grammar edits #117
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see a major problem here, except that in my experience in academic writing, Oxford commas tend to remove ambiguity, so perhaps we should bring them back. Thanks for the PR, Phil!
Hi,
Besides my personal support for ubiquitous use of Oxford comma
(i.e., explicit series comma), ITU-T, SAE, and TCG all rigorously
enforce the use of the Oxford comma. It's presence is never
ambiguous. It's absence is often ambiguous, including in some
humorous examples, such as this one from 2018:
*A lack of an Oxford comma cost dairy $5 million*
CNN
A group of Maine dairy delivery drivers will receive $5 million in a
proposed settlement for unpaid overtime, according to court records filed
on Thursday. Read the full story
<https://apple.news/ASXhSsMHHSmKriVHBZY8c-A>
My wife Nancy (a professional editor and writer for over 40 years) sent
this comment
about that news story:
"Splendid! It's nice to have a real-world example of the dangers of sloppy
writing.
There is never a downside to using the Oxford (or series) comma; it
provides clarity
and hurts nothing. Leaving it out is merely a senseless fashion."
Cheers,
- Ira
Ira McDonald (Musician / Software Architect)
Co-Chair - TCG Trusted Mobility Solutions WG
Co-Chair - TCG Metadata Access Protocol SG
Chair - Linux Foundation Open Printing WG
Secretary - IEEE-ISTO Printer Working Group
Co-Chair - IEEE-ISTO PWG Internet Printing Protocol WG
IETF Designated Expert - IPP & Printer MIB
Blue Roof Music / High North Inc
http://sites.google.com/site/blueroofmusic
http://sites.google.com/site/highnorthinc
mailto: blueroofmusic@gmail.com
PO Box 221 Grand Marais, MI 49839 906-494-2434
On Wed, Jun 19, 2019 at 2:08 PM Lois Anne DeLong <notifications@github.com>
wrote:
… I'm a big fan of the Oxford commas as well, as I think they add clarity.
But I will leave this to the group.
Lois
On Wed, Jun 19, 2019 at 2:01 PM Trishank K Kuppusamy <
***@***.***> wrote:
> ***@***.**** commented on this pull request.
>
> I don't see a major problem here, except that in my experience in
academic
> writing, Oxford commas tend to remove ambiguity, so perhaps we should
bring
> them back. Thanks for the PR, Phil!
>
> —
> You are receiving this because you are subscribed to this thread.
> Reply to this email directly, view it on GitHub
> <
https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_uptane_uptane-2Dstandard_pull_117-3Femail-5Fsource-3Dnotifications-26email-5Ftoken-3DADPGUX2TDCMLS32TD3LJ5I3P3JX5VA5CNFSM4HZLRPGKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB4BUDFI-23pullrequestreview-2D251871637&d=DwMCaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=hgBKIqNYIOwzXeBjPUaKRw&m=p7DnIZmvC7DGp8GK9cz-vQ1mSu2ehNVqGgRPpik7Rgg&s=5jZ8LH-cUTY6e7O-9p7_yqVxfCoPBJM5i8cbtUhANek&e=
>,
> or mute the thread
> <
https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_ADPGUX4E46HKJDAF37TK3LTP3JX5VANCNFSM4HZLRPGA&d=DwMCaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=hgBKIqNYIOwzXeBjPUaKRw&m=p7DnIZmvC7DGp8GK9cz-vQ1mSu2ehNVqGgRPpik7Rgg&s=Jvq3Z2uEZIvOdCD4K6XNO5VKJegZz8KgPcBocLxd84U&e=
>
> .
>
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#117?email_source=notifications&email_token=AE33UOZQMNFVEYRHRG5TRPTP3JY3NA5CNFSM4HZLRPGKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODYCWI4A#issuecomment-503669872>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE33UOZMUOM27DW3ZFJTZLDP3JY3NANCNFSM4HZLRPGA>
.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with all of your choices except the ones I've called out below. I don't see any cases where the Oxford/serial comma is relevant. Did I overlook something? I'm also a fan of it FWIW.
@@ -282,7 +282,7 @@ The OEM wants to use delta updates to save over-the-air bytes. The delta images | |||
|
|||
There are a number of factors that could impede the completion of the above scenarios: | |||
|
|||
* ECUs may be lacking the necessary resources to function as designated. These resources could include weaknesses, in terms of CPU or RAM, that prevent performance of public key cryptography; a lack of sufficient storage to undo installation of bad software; or an ECU simply may reside on a low-speed network (e.g., LIN). | |||
* ECUs may be lacking the necessary resources to function as designated. These resources could include weaknesses, in terms of CPU or RAM, that make performance of public key cryptography infeasible; a lack of sufficient storage to undo installation of bad software; or an ECU simply may reside on a low-speed network (e.g., LIN). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"render" is an even better word than "make" in this context.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree. Render is a better word.
@@ -419,7 +419,7 @@ A repository's Timestamp role SHALL produce and sign metadata indicating whether | |||
|
|||
## Metadata structures {#meta_structures} | |||
|
|||
Uptane's security guarantees all rely on properly created metadata that follow a designated structure. The Uptane standard **does not** mandate any particular format or encoding for the metadata as a whole. ASN.1 (with any encoding scheme like BER, DER, XER, etc.), JSON, XML, or any other encoding format that is capable of providing the required structure MAY be used. | |||
Uptane's security guarantees all rely on properly created metadata that follows a designated structure. The Uptane standard **does not** mandate any particular format or encoding for the metadata as a whole. ASN.1 (with any encoding scheme like BER, DER, XER, etc.), JSON, XML, or any other encoding format that is capable of providing the required structure MAY be used. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"data" is plural so "follow" is correct. I go back and forth on how I really feel about that (I also often treat it as singular), but I think "follow" sounds better here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I go back and forth on this. You are right that, by grammatical rules, "data" is plural. However, its become common usage, I believe, to treat it in the singular form as well. In this case, I agree that "follow" sounds better.
|
||
A list of delegations MUST provide the following information: | ||
|
||
* A list of public keys of all delegatees. Each key should have a unique public key identifier, and a key type. | ||
* A list of public keys of all delegates. Each key should have a unique public key identifier and a key type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "delegatee" is more accurate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed.
Hi,
I agree with all of Patrick's wording suggestions.
Cheers,
- Ira
Ira McDonald (Musician / Software Architect)
Co-Chair - TCG Trusted Mobility Solutions WG
Co-Chair - TCG Metadata Access Protocol SG
Chair - Linux Foundation Open Printing WG
Secretary - IEEE-ISTO Printer Working Group
Co-Chair - IEEE-ISTO PWG Internet Printing Protocol WG
IETF Designated Expert - IPP & Printer MIB
Blue Roof Music / High North Inc
http://sites.google.com/site/blueroofmusic
http://sites.google.com/site/highnorthinc
mailto: blueroofmusic@gmail.com
PO Box 221 Grand Marais, MI 49839 906-494-2434
…On Thu, Jun 20, 2019 at 7:33 AM Patrick Vacek ***@***.***> wrote:
***@***.**** commented on this pull request.
I agree with all of your choices except the ones I've called out below. I
don't see any cases where the Oxford/serial comma is relevant. Did I
overlook something? I'm also a fan of it FWIW.
------------------------------
In uptane-standard.md
<#117 (comment)>
:
> @@ -282,7 +282,7 @@ The OEM wants to use delta updates to save over-the-air bytes. The delta images
There are a number of factors that could impede the completion of the above scenarios:
-* ECUs may be lacking the necessary resources to function as designated. These resources could include weaknesses, in terms of CPU or RAM, that prevent performance of public key cryptography; a lack of sufficient storage to undo installation of bad software; or an ECU simply may reside on a low-speed network (e.g., LIN).
+* ECUs may be lacking the necessary resources to function as designated. These resources could include weaknesses, in terms of CPU or RAM, that make performance of public key cryptography infeasible; a lack of sufficient storage to undo installation of bad software; or an ECU simply may reside on a low-speed network (e.g., LIN).
"render" is an even better word than "make" in this context.
------------------------------
In uptane-standard.md
<#117 (comment)>
:
> @@ -419,7 +419,7 @@ A repository's Timestamp role SHALL produce and sign metadata indicating whether
## Metadata structures {#meta_structures}
-Uptane's security guarantees all rely on properly created metadata that follow a designated structure. The Uptane standard **does not** mandate any particular format or encoding for the metadata as a whole. ASN.1 (with any encoding scheme like BER, DER, XER, etc.), JSON, XML, or any other encoding format that is capable of providing the required structure MAY be used.
+Uptane's security guarantees all rely on properly created metadata that follows a designated structure. The Uptane standard **does not** mandate any particular format or encoding for the metadata as a whole. ASN.1 (with any encoding scheme like BER, DER, XER, etc.), JSON, XML, or any other encoding format that is capable of providing the required structure MAY be used.
"data" is plural so "follow" is correct. I go back and forth on how I
really feel about that (I also often treat it as singular), but I think
"follow" sounds better here.
------------------------------
In uptane-standard.md
<#117 (comment)>
:
>
A list of delegations MUST provide the following information:
-* A list of public keys of all delegatees. Each key should have a unique public key identifier, and a key type.
+* A list of public keys of all delegates. Each key should have a unique public key identifier and a key type.
I think "delegatee" is more accurate.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#117?email_source=notifications&email_token=AE33UO7YCCDLDRQQWDF5AULP3NTIZA5CNFSM4HZLRPGKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB4EMRPY#pullrequestreview-252233919>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE33UOYPOCP4EKWYNGMWTHTP3NTIZANCNFSM4HZLRPGA>
.
|
I don't know if my review counts, but since these were largely wording issues, I think its counts for this PR. I agree with Ira. This can be merged. |
Hi,
I agree that "follow" sounds better.
Cheers,
- Ira
PS - Lois - your "vote" counts in reviews and edits - you're the
professional
technical writer - the rest of us are just the peanut gallery...
Ira McDonald (Musician / Software Architect)
Co-Chair - TCG Trusted Mobility Solutions WG
Co-Chair - TCG Metadata Access Protocol SG
Chair - Linux Foundation Open Printing WG
Secretary - IEEE-ISTO Printer Working Group
Co-Chair - IEEE-ISTO PWG Internet Printing Protocol WG
IETF Designated Expert - IPP & Printer MIB
Blue Roof Music / High North Inc
http://sites.google.com/site/blueroofmusic
http://sites.google.com/site/highnorthinc
mailto: blueroofmusic@gmail.com
PO Box 221 Grand Marais, MI 49839 906-494-2434
…On Mon, Jun 24, 2019 at 11:50 AM Lois Anne DeLong ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In uptane-standard.md
<#117 (comment)>
:
> @@ -419,7 +419,7 @@ A repository's Timestamp role SHALL produce and sign metadata indicating whether
## Metadata structures {#meta_structures}
-Uptane's security guarantees all rely on properly created metadata that follow a designated structure. The Uptane standard **does not** mandate any particular format or encoding for the metadata as a whole. ASN.1 (with any encoding scheme like BER, DER, XER, etc.), JSON, XML, or any other encoding format that is capable of providing the required structure MAY be used.
+Uptane's security guarantees all rely on properly created metadata that follows a designated structure. The Uptane standard **does not** mandate any particular format or encoding for the metadata as a whole. ASN.1 (with any encoding scheme like BER, DER, XER, etc.), JSON, XML, or any other encoding format that is capable of providing the required structure MAY be used.
I go back and forth on this. You are right that, by grammatical rules,
"data" is plural. However, its become common usage, I believe, to treat it
in the singular form as well. In this case, I agree that "follow" sounds
better.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#117?email_source=notifications&email_token=AE33UOYPCYTLM4OYJ5G2KJDP4DULVA5CNFSM4HZLRPGKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB4OCERI#discussion_r296792327>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE33UO4LHQXP5VPIBDTUETLP4DULVANCNFSM4HZLRPGA>
.
|
Thanks, Ira. I do my my best! |
Hi Lois,
My wife Nancy (a professional editor and writer for the past 40+ years)
sends you a gold star for your patient attention to consistency and usage
of the "right" words. I send you a gold star for your ability to run
efficient
meetings of the diverse Uptane contributors.
Cheers,
- Ira
Ira McDonald (Musician / Software Architect)
Co-Chair - TCG Trusted Mobility Solutions WG
Co-Chair - TCG Metadata Access Protocol SG
Chair - Linux Foundation Open Printing WG
Secretary - IEEE-ISTO Printer Working Group
Co-Chair - IEEE-ISTO PWG Internet Printing Protocol WG
IETF Designated Expert - IPP & Printer MIB
Blue Roof Music / High North Inc
http://sites.google.com/site/blueroofmusic
http://sites.google.com/site/highnorthinc
mailto: blueroofmusic@gmail.com
PO Box 221 Grand Marais, MI 49839 906-494-2434
…On Mon, Jun 24, 2019 at 2:19 PM Lois Anne DeLong ***@***.***> wrote:
Thanks, Ira. I do my my best!
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#117?email_source=notifications&email_token=AE33UO4J6EOIL3TVZAWSEHLP4EF2TA5CNFSM4HZLRPGKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODYNY7PA#issuecomment-505122748>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE33UO5DEJIILANJRZPC3XTP4EF2TANCNFSM4HZLRPGA>
.
|
Thanks! |
I reviewed everything here again, including those pesky commas. It's true that the deleted commas here were not the Oxford comma separating lists. They were commas at the end of clauses. I think that type of comma usage is useful, but not as significant as the old Oxfords. I think this can be merged. Several people have looked at it and I don't think I see any outstanding corrections. I would still argue that, in line 525, that the phrase should be "backwards compatible" with the 's', because it appears to be more commonly used. But I would not hold up a merge to argue about it. |
Barring any further objections, can someone with the privilege to do so merge this PR. Thanks. Lois |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Merging with the knowledge that Lois and others have gone through it
This pull request fixes a few minor spelling and grammar issues.