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

Document consuming the format better #74

Closed
Shnatsel opened this issue Sep 9, 2022 · 2 comments
Closed

Document consuming the format better #74

Shnatsel opened this issue Sep 9, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@Shnatsel
Copy link
Member

Shnatsel commented Sep 9, 2022

The feedback from Tom Fay was that implementing support for the format was trivial in Go, but I'm sure we can simplify it further. The docs on parsing are kind of a mess.

It should lay out all the sections (including Mach-O segment, which isn't explicitly documented), link to the JSON schema (#72), and describe the parsing in detail, including the mention of the possibility of cyclic dependencies.

It should also mention rust-audit-info as an alternative - just call it as a subprocess and get the JSON.

@Shnatsel Shnatsel mentioned this issue Sep 9, 2022
10 tasks
@Shnatsel Shnatsel added the enhancement New feature or request label Sep 9, 2022
@Shnatsel
Copy link
Member Author

Initial docs added: https://github.com/rust-secure-code/cargo-auditable/blob/master/PARSING.md

It would be great to add a sample in some very common language, e.g. Python.

Also, the README needs to be updated to link to it.

@Shnatsel
Copy link
Member Author

Done as of ba813c8

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

No branches or pull requests

1 participant