-
Notifications
You must be signed in to change notification settings - Fork 118
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
Add updated porting guide for AWS-LC #1463
Conversation
1a28d2e
to
57955d7
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1463 +/- ##
==========================================
+ Coverage 76.99% 77.02% +0.03%
==========================================
Files 425 425
Lines 71587 71627 +40
==========================================
+ Hits 55115 55169 +54
+ Misses 16472 16458 -14 ☔ View full report in Codecov by Sentry. |
57955d7
to
03f4084
Compare
401c9f6
to
030714c
Compare
<p><span>Not Supported</span></p> | ||
</td> | ||
<td> | ||
<p><span>NO-OP</span></p> |
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.
Should the "Not Supported" Flags have "N/A" instead of NO-OP in Configurability?
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.
No strong opinions here, but I wanted to make the used wording consistent with what was in the text.
<p> | ||
<span> | ||
<a href="https://github.com/aws/aws-lc/blob/5c358103c5df836b9343bf995717b5bc13d5e82f/API-CONVENTIONS.md#thread-safety"> | ||
Thread Safety |
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.
Is there no header file to be mentioned here where the following values are defined?
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.
Sure, I thought this page had more details, but the introduction at the top of this section explains things well too. Changed.
f31f709
to
98f6223
Compare
98f6223
to
c5eef97
Compare
This finalizes the changes for the previous two documentation PRS: #1463 and #1473. Now that these two PRs are in, we have a commit to link the header documentation from the table. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.
Description of changes:
Update porting guide for AWS-LC. This is the first phase, which just includes the text and tables. Second phase will include links to the corresponding functions/sections for the tables along with updated function documentation.
Call-outs:
There were some issues auto-generating the Markdown files with the internal docs. Apparently Markdown doesn't support merged row/columns, so I had to use html instead.
The markdown html has been greatly simplified, so updating it with new functions we find shouldn't be too painful.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.