Repository navigation
Correct stale and removed wolfSSL macro names in the manual - #298
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block this documentation-only update to the English and Japanese wolfSSL manuals.
No open issues 🎉
What changed in this PR
This documentation-only PR aligns the English and Japanese wolfSSL manuals with current macro names and removes guidance for obsolete options.
Changes:
- Marks removed macros as ineffective and corrects verbose logging macro lists.
- Fixes Japanese macro names, hardware configuration references, and an ECC example.
- Corrects PSK configuration guidance and removes obsolete entries.
| File | Description |
|---|---|
wolfSSL/src/chapter08.md |
Removes the nonexistent verbose logging helper from the description. |
wolfSSL/src/chapter02.md |
Documents the removed inverse macro and corrects verbose logging guidance. |
wolfSSL/src-ja/chapter02.md |
Corrects macro documentation, removes obsolete entries, and fixes the ECC example. |
wolfSSL/src-ja/appendix08.md |
Corrects SP size defines and hardware accelerator configuration references. |
wolfSSL/src-ja/appendix07.md |
Corrects PSK configuration guidance and removes the obsolete static ECDH option. |
wolfSSL/src-ja/appendix06.md |
Corrects the DH private-key error constant name. |
Review effort: Balanced
philljj
approved these changes
Nov 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checks the wolfSSL manual against the macros wolfSSL master actually uses.
WOLFSSL_MP_INVMOD_CONSTANT_TIME: Keep secret values out of the variable-time inversion in ECC, ECCSI, SAKKE and BN wolfssl#12023 removed it, so its entry now says it was removed after 5.9.4 and has no effect.WOLFSSL_LEAVE_VERBOSE()is dropped from the verbose logging description (chapters 2 and 8); onlyWOLFSSL_MSG_VERBOSE()andWOLFSSL_ENTER_VERBOSE()exist.WOLFSSL_APPLE_NATIVE_CERT_VALIDATION,DH_CHECK_PRIV_E,HAVE_CAVIUM_OCTEON_SYNC,WOLFSSL_ATECC508A/WOLFSSL_ATECC608A,WOLFSSL_STM32MP13, and the SP size defines (WOLFSSL_SP_NO_2048/_NO_3072/_NO_256).--enable-pskremovesNO_PSKrather than definingHAVE_PSK, and the ECC example passes a key size of 32 instead of an undefined constant.HAVE_LIBOQSis marked removed in 5.9.4, and the entries forWOLFSSL_USE_POPEN_HOST,NO_WOLFSSL_SHA256and--enable-staticecdh, which no longer exist, are removed.