Skip to content

Fix wolfSSL_send_hrr_cookie documentation - #12030

Open
SparkiDev wants to merge 1 commit into
wolfSSL:masterfrom
SparkiDev:send_hrr_cookie_doc_fixes
Open

SparkiDev wants to merge 1 commit into
wolfSSL:masterfrom
SparkiDev:send_hrr_cookie_doc_fixes

Conversation

@SparkiDev

Copy link
Copy Markdown
Contributor

Description

Function name in example code had extra underscore. 'secret' needs to be unsigned.
WOLFSSL_TLS13_SHA512 needs to be defined for SHA-512 to be used.

Function name in example code had extra underscore.
'secret' needs to be unsigned.
WOLFSSL_TLS13_SHA512 needs to be defined for SHA-512 to be used.
Copilot AI balanced review requested due to automatic review settings November 6, 2026 00:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are recorded for the documentation-only updates to the English and Japanese API examples and digest-selection guidance.

No open issues 🎉

What changed in this PR

Corrects the English and Japanese documentation for wolfSSL_send_hrr_cookie, aligning examples and hash-selection guidance with the API. No runtime code changes are included.

Changes:

  • Fixes the function name and uses unsigned char for the example secret buffer.
  • Clarifies default digest-size selection, including the WOLFSSL_TLS13_SHA512 requirement for SHA-512.
File Description
doc/​dox_comments/​header_files/​ssl.h Corrects the English example and clarifies SHA-512 availability.
doc/​dox_comments/​header_files-ja/​ssl.h Corrects the Japanese example and updates digest fallback guidance.

Review effort: Balanced

@SparkiDev SparkiDev removed their assignment Nov 6, 2026
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