c-api: README.md #974
Merged
c-api: README.md #974
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
r12f
reviewed
Feb 19, 2025
common/c-api/README.md
Outdated
| @@ -0,0 +1,72 @@ | |||
| # C API | |||
|
|
|||
| This directory contains the swss-common C API. The C API is an incomplete, | |||
There was a problem hiding this comment.
maybe better to change incomplete to in progress :D
There was a problem hiding this comment.
Ok, although my understanding is the intention is never for it to be complete.
common/c-api/README.md
Outdated
| This directory contains the swss-common C API. The C API is an incomplete, | ||
| hand-written C wrapper around functions in swss-common. Functionality is | ||
| added as needed. It is designed to be understandable without incurring major | ||
| performance penalties. It was primarily written to support Rust code using |
There was a problem hiding this comment.
It was initially (not primarily)
There was a problem hiding this comment.
These mean the same thing in context but I will make this change
| returned value in this case. | ||
|
|
||
| Example: | ||
| ```c |
There was a problem hiding this comment.
nit: line break before code block
There was a problem hiding this comment.
usually markdown-lint vs extension can help identify all the small format issues.
There was a problem hiding this comment.
I can change this but I'm not sure why. It's not required by markdown.
common/c-api/README.md
Outdated
| @@ -0,0 +1,72 @@ | |||
| # C API | |||
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
r12f
approved these changes
Feb 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a README for the C API at Riff's request, explaining its purpose, exception handling, and memory management practices.