Repository navigation
Conversation
- chapter02: give the full WOLFSSL_CRYPT_HW_MUTEX lock/unlock function names. - chapter02: --enable-aeskeywrap: only the RFC 5649 padding variant is new in 5.9.4, not the whole option. - chapter02: the wolfssl-examples CSR and PKCS7 examples are in the certgen and pkcs7 directories, not cmake. - chapter02, 04, 11: wolfSSL_CTX_set_ephemeral_key() and the DTLS 1.2 method functions are documented on the CertsKeys and Setup group pages. The ssl.h page has no anchor for them in the HTML build. - chapter03: add the missing separator after `break` in the echoserver command list. - chapter04: the SSL/TLS/DTLS comparison is in Appendix D, not Appendix A, and the cipher suites are lists, not a table. - chapter07: "i.e." -> "e.g." for the trust peer certificate type, and name wc_DerToPem() correctly. - chapter11: fix "so that the when".
The English manual was revised heavily for wolfSSL 5.9.4, and the Japanese translation had fallen behind, in places by several releases. Bring every Japanese chapter and appendix back in line with the current English: the same headings, code blocks, tables and lists, in the same order. - Keep the existing Japanese wording where it still matches the English, translate new and changed text, and drop text the English removed. - Macro and configure option headings stay in English so their anchors work in both languages. Links to sections with Japanese headings use the existing file link plus section name form. - Links to API functions that the Japanese API reference does not cover yet are plain inline code. - Code blocks match the English. Blocks whose comments were translated before keep Japanese comments on the current code. - Keep Japan-specific content: info@wolfssl.jp, wolfssl.jp pages, the Japanese RFC translation links and the Japanese porting guide link. - Fix mistranslations, broken anchors, full-width ASCII symbols and wolfSSL/wolfssl path casing in the existing text.
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
Japan-team confirmation is needed before publishing the restored Competitive Upgrade Program, which promises onsite consulting and a royalty-free license despite its applicability in Japan remaining unresolved.
No open issues 🎉
What changed in this PR
This documentation-only PR brings the Japanese wolfSSL manual into alignment with the English 5.9.4 update, while preserving Japan-specific contacts and resources. It also corrects several English references and explanations.
Changes:
- Updates Japanese feature, configuration, integration, and troubleshooting guidance for wolfSSL 5.9.4.
- Refreshes examples, API descriptions, error tables, hardware support, and standards references.
- Corrects English API links, example locations, and wording.
| File | Description |
|---|---|
wolfSSL/src/chapter11.md |
Fixes a DTLS API link and tutorial wording. |
wolfSSL/src/chapter07.md |
Corrects certificate-format wording and the wc_DerToPem() reference. |
wolfSSL/src/chapter04.md |
Corrects API links and feature cross-references. |
wolfSSL/src/chapter03.md |
Fixes command-list punctuation. |
wolfSSL/src/chapter02.md |
Clarifies function names, padding support, and example locations. |
wolfSSL/src-ja/chapter16.md |
Updates release-information sources. |
wolfSSL/src-ja/chapter15.md |
Adds vulnerability-reporting guidance and refreshes support services. |
wolfSSL/src-ja/chapter14.md |
Updates licensing and FIPS information. |
wolfSSL/src-ja/chapter13.md |
Refreshes OpenSSL compatibility guidance and examples. |
wolfSSL/src-ja/chapter12.md |
Expands signing guidance to modern and post-quantum algorithms. |
wolfSSL/src-ja/chapter11.md |
Updates TLS tutorial examples, defaults, and cleanup instructions. |
wolfSSL/src-ja/chapter09.md |
Clarifies configuration headers, initialization, threading, and buffers. |
wolfSSL/src-ja/chapter08.md |
Expands logging controls and error-handling guidance. |
wolfSSL/src-ja/chapter06.md |
Updates callback interfaces and documents additional callback capabilities. |
wolfSSL/src-ja/chapter05.md |
Refreshes portability interfaces, platform support, and C# examples. |
wolfSSL/src-ja/chapter01.md |
Updates the introductory feature and protocol overview. |
wolfSSL/src-ja/appendix11.md |
Clarifies wolfSM setup and adds RISC-V optimization support. |
wolfSSL/src-ja/appendix10.md |
Modernizes platform-porting instructions and references. |
wolfSSL/src-ja/appendix08.md |
Expands hardware-acceleration tables and corrects activation options. |
wolfSSL/src-ja/appendix06.md |
Updates error-code tables and retry guidance. |
wolfSSL/src-ja/appendix05.md |
Refreshes cryptographic standards and protocol references. |
wolfSSL/src-ja/appendix04.md |
Adds TLS 1.3 handshake and DTLS explanations. |
Review effort: Balanced
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.
Summary
The English wolfSSL manual was heavily revised for wolfSSL 5.9.4: corrected defaults, regrouped macros, many new macros and configure options, new sections, fixed examples and internal links. The Japanese translation in
wolfSSL/src-jahad fallen well behind. Before this change, chapter02 alone had about 640 fewer headings than the English.This PR brings every Japanese chapter and appendix back in line with the current English. Appendices A-C are API placeholders and are unchanged. Each file now has the same headings, code blocks, tables and lists as the English, in the same order. Existing Japanese wording is kept where it still matches the English. New and changed text is translated, and text the English removed is dropped.
There are two commits:
wolfSSL/srcfound while doing the sync (listed below).wolfSSL/src-jaonly.The Japanese text needs a careful review by a native speaker, especially the new entries in chapter02 (about 650 macros and options are new or rewritten), chapter04, chapter10, and appendices F, G and I.
Conventions used
[第N章 ...](chapterNN.md)の「...」節. The English anchor does not exist in the Japanese HTML or PDF.header_files-ja). Links to them are plain inline code, so they don't point nowhere.@wolfSSL_JapanX account.Decisions for the Japan team to check
wolfSSL_StaticBufferSzsemantics, the DTLS method list and thewolfSSL_is_static_memoryargument type.wolfssl/wolfcrypt/settings.hin the IDE project steps (63b243b).-188explanation.src-ja: ブラインディング, 定数時間, 位数, 前方秘匿性, トラストアンカー, 証明書パス, 鍵のロールオーバー証明書, 鍵マテリアルエクスポーター, 電源投入時セルフテスト(POST), 鍵暗号化鍵(KEK), 低消費電力AESモジュール, 物理複製困難関数 (PUF), ペアワイズ整合性テスト, カプセル化解除鍵, メモリハード, and 最小構成 / 追加項目 (the floor and adders in the--enable-tinytls13section).Errors in the previous Japanese that are fixed
Besides catching up with the English, some existing translations said something different from the English:
WOLFSSL_ALT_CERT_CHAINSsaid the errors are not ignored, the opposite of the English.WOLFSSL_RSA_VERIFY_ONLYhad lost "verify only".WOLFSSL_AESNIhad the .asm/.S syntax reversed.*_file/*_buffersentence was reversed.CRYPTGEN_Ewas translated as encryption rather than generation. The SRP and SKID/AKID rows (-217 to -222) were off by one.#debug_wolfSSL,#wolfSSL_rsa_*and others) now use the English lowercase targets.English fixes (first commit)
WOLFSSL_CRYPT_HW_MUTEXnow gives the full function names.--enable-aeskeywrapnow says only the padding variant is new in 5.9.4.wolfSSL_CTX_set_ephemeral_key()and the DTLS 1.2 method links pointed atssl_8h.md. In the English HTML build those anchors are ongroup__CertsKeysandgroup__Setup, so the links were broken in HTML (the PDF hid it)._DerToPem()_is nowwc_DerToPem().Testing
codespellwith the CI word list passes onwolfSSL/srcandwolfSSL/src-ja.Note: the Docker builder image has no
xeCJK, so the Japanese PDF does not build in it as-is. I addedtlmgr install xecjklocally to test. CI only builds the English PDF, so this PR doesn't change that.