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

docs: Update versions and feature flags #922

Merged
merged 3 commits into from
Feb 14, 2025
Merged

docs: Update versions and feature flags #922

merged 3 commits into from
Feb 14, 2025

Conversation

crandmck
Copy link
Collaborator

@crandmck crandmck commented Feb 12, 2025

Changes in this pull request

Update crate version in docs. Update feature flag docs.

Per @mauricefisher64:

  • Removed doc for these feature flags: openssl and openssl_sign
  • Added description of pdf

Checklist

  • This PR represents a single feature, fix, or change.
  • All applicable changes have been documented.
  • Any TO DO items (or similar) have been entered as GitHub issues and the link to that issue has been included in a comment.

Copy link

codecov bot commented Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.91%. Comparing base (1cda7bd) to head (36ea663).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #922   +/-   ##
=======================================
  Coverage   78.91%   78.91%           
=======================================
  Files         147      147           
  Lines       34805    34805           
=======================================
  Hits        27466    27466           
  Misses       7339     7339           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mauricefisher64
Copy link
Collaborator

With the refactoring of our crypto code, openssll, and openssl_sign don't make much sense. The default behavior is always to use OpenSSL unless we do some wasm/wasi. These feature flags could be removed if someone goes through and cleans up the code. I think they are on in unit tests and samples at the moment. No real functionality is using these flags at the moment.
"pdf" feature enable PDF read support

@crandmck
Copy link
Collaborator Author

crandmck commented Feb 13, 2025

I removed the openssl and openssl_sign feature flags from the doc, since it sounds like they don't actually do anything even though they are technically supported.

Added short desc of pdf feature flag.

The default behavior is always to use OpenSSL unless we do some wasm/wasi.

This sounds like something that needs to be added to the docs. By default, is OpenSSL a prerequisite for using the Rust library? Then at a minimum, we need to say that, and ideally provide some instructions on what you need to do (download/install OpenSSL, and ... ?)

We do mention OpenSSL in Signing manifests, but if Rust lib now strictly required by default we should at least mention that.

What does "we do some wasm/wasi" mean? Should we explain what to do?

@mauricefisher64
Copy link
Collaborator

Why do we have to tell them the what crypto is used. If you build c2pa-rs it will use OpenSSL. If you build c2pa-rs for wasm/wasi it will use RustCrypto. There is currently nothing for users to do.

@crandmck crandmck merged commit 34e75a0 into main Feb 14, 2025
34 checks passed
@crandmck crandmck deleted the doc-vers-and-flags branch February 14, 2025 22:11
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.

3 participants