horrible X509_NAME_hash synopsis
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 30.8k
- Forks
- 11.5k
- Avg merge
- 10m
- Merged PRs (30d)
- 1
Description
Manual pages X509_NAME_hash_ex describes new synopsis.
-
Synopsis section mention "Deprecated since OpenSSL 3.0:".
This does not follow convention used on other pages - separate section.
As is written deprecation is ambiguous - look like all until end is deprecated. -
Using macro to deprecate ...
What funny invention!
In such context macro could be used for compatibility but not for deprecation.
The defect is use of macro instead of function annotated as deprecated. -
Synopsis of X509_NAME_hash_ex
Unwritten "C" rule indicate error is function return value.
The design defect is that newly added function does not use such syntax and returns error in argument.
Request is to redesign function to match "C" practice.
Contributor guide
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
Start with the X509_NAME_hash_ex manual page and its synopsis, then inspect the named function declaration and implementation. Resolve the deprecation presentation and redesign the error-return convention to match the requested C practice, updating the synopsis to reflect the resulting API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- cryptography, documentation
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100