All manual pages of functions affecting the error queue should say that explicitly
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 30.8k
- Forks
- 11.5k
- Avg merge
- 10m
- Merged PRs (30d)
- 1
Description
Many do have this sort of information, but not all. For example, it has been pointed out that doc/man3/d2i_X509.pod had no such information.
A proposal is to add this paragraph (or parts of it, as applicable) in the RETURN VALUES section of manuals that don't already have this information:
On error, these functions may record the error in the OpenSSL error queue.
That error queue can be inspected with the B<ERR> family of functions, such as
L<ERR_print_errors(3)> and L<ERR_peek_last_error_all(3)>.
... and also place appropriate links in the SEE ALSO section (adding that section if it doesn't already exist):
=head1 SEE ALSO
L<ERR_print_errors(3)>, L<ERR_peek_last_error_all(3)>
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 doc/man3/d2i_X509.pod and inspect its RETURN VALUES and SEE ALSO sections, then identify other manuals for functions that affect the error queue. Compare existing wording with the proposed ERR_print_errors(3) and ERR_peek_last_error_all(3) links. Done means all applicable manuals explicitly document the error queue and link to the ERR functions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100