Skip to content
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

Merged
merged 3 commits into from
Jul 1, 2019

Conversation

plapczyn
Copy link
Contributor

This pull request fixes a few minor spelling and grammar issues.

@trishankatdatadog trishankatdatadog added this to the Uptane 1.0 milestone Jun 19, 2019
Copy link
Member

@trishankatdatadog trishankatdatadog left a 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!

@jhdalek55
Copy link
Contributor

jhdalek55 commented Jun 19, 2019 via email

@iramcdonald
Copy link

iramcdonald commented Jun 19, 2019 via email

Copy link
Collaborator

@pattivacek pattivacek left a 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).
Copy link
Collaborator

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.

Copy link
Contributor

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.
Copy link
Collaborator

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.

Copy link
Contributor

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.
Copy link
Collaborator

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed.

@iramcdonald
Copy link

iramcdonald commented Jun 20, 2019 via email

@jhdalek55
Copy link
Contributor

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.

@iramcdonald
Copy link

iramcdonald commented Jun 24, 2019 via email

@jhdalek55
Copy link
Contributor

Thanks, Ira. I do my my best!

@iramcdonald
Copy link

iramcdonald commented Jun 24, 2019 via email

@jhdalek55
Copy link
Contributor

Thanks!

@jhdalek55
Copy link
Contributor

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.

@jhdalek55
Copy link
Contributor

Barring any further objections, can someone with the privilege to do so merge this PR. Thanks.

Lois

Copy link
Member

@trishankatdatadog trishankatdatadog left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants