rust-openssl / rust-openssl/rust-openssl
Nid::create is not possible to use correctly without process-global knowledge
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 841
- Avg merge
- 6h 51m
- Merged PRs (30d)
- 4
Description
The documentation for Nid::create fails to mention that it modifies process-global state. See https://github.com/sfackler/rust-openssl/issues/1878 and https://commondatastorage.googleapis.com/chromium-boringssl-docs/obj.h.html#Adding-objects-at-runtime
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the documentation for Nid::create and read the linked rust-openssl issue and BoringSSL object reference first. Update the documentation to explain that the call modifies process-global state and why that matters; it is done when users are warned about this behavior before using the API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100