Repository navigation
Conversation
The Japanese PDFs (make pdf DOC_LANG=JA) need the xeCJK LaTeX package,
which neither the Docker builder image nor the build-check workflow
installed, so they failed with "File `xeCJK.sty' not found". Nothing
built the Japanese manuals, so this was never caught.
Every manual whose Japanese version builds is now checked: wolfSSL,
wolfSSH, wolfTPM, wolfMQTT, wolfBoot, wolfCLU, wolfSSL-JNI,
wolfCrypt-JNI, wolfHSM, wolfEngine, wolfProvider, wolfSSL-FIPS-Ready,
wolfSSL-Tuning, wolfSSL-Porting, wolfSSL-FAQ, wolfSSL-FIPS-FAQ and
MbedTLS-Migration.
- Dockerfile: install xecjk, and pass a DOC_LANG build-arg through to
make pdf/html. The HTML output directory is now an HTMLDIR build-arg
(default ${MANPATH}-html) so a Japanese manual does not overwrite the
English one.
- Makefile: add a <manual>-ja target for each, producing the manual's
-jp.pdf and <MANPATH>-ja-html, and collect them in JA_MANUALS, which
"all" builds. wolftpm-ja shares the wolfTPM ref pinning.
- build-check.yml: add a build-ja job that installs fonts-noto-cjk and
xecjk and builds the Japanese HTML and PDF of each, in parallel with
the English build job and from a clean checkout.
wolfSentry is left out for now: "make pdf DOC_LANG=JA" fails because
ChangeLog.md is only copied into src-ja by the pre-build step that
plain "make" runs.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the Japanese PDF and HTML build changes.
No open issues 🎉
What changed in this PR
Enables Japanese PDF and HTML builds in Docker and CI, addressing the tooling gap identified during the wolfSSL translation update in #299.
Changes:
- Installs
xecjkin Docker and adds language selection and configurable HTML output directories. - Adds 17 Japanese manual targets to
make all, keeping their outputs separate from English builds. - Adds a separate CI job to build Japanese manuals from a clean checkout. wolfSentry remains excluded pending its Makefile fix.
| File | Description |
|---|---|
| Makefile | Adds Japanese targets, distinct output paths, and shared wolfTPM source pinning. |
| Dockerfile | Installs xecjk and passes language and HTML output settings through the build. |
| .github/workflows/build-check.yml | Adds Japanese build dependencies and HTML/PDF checks for all 17 supported manuals. |
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 Japanese PDFs (
make pdf DOC_LANG=JA) could not be built with this repo's tooling: neither the Docker builder image nor thebuild-check.ymlworkflow installed the xeCJK LaTeX package, so the build failed withLaTeX Error: File `xeCJK.sty' not found. Nothing in CI built the Japanese manuals either, so this was never noticed. This came up while verifying #299.This PR installs what the Japanese builds need and checks every Japanese manual that builds today:
wolfSSL, wolfSSH, wolfTPM, wolfMQTT, wolfBoot, wolfCLU, wolfSSL-JNI, wolfCrypt-JNI, wolfHSM, wolfEngine, wolfProvider, wolfSSL-FIPS-Ready, wolfSSL-Tuning, wolfSSL-Porting, wolfSSL-FAQ, wolfSSL-FIPS-FAQ and MbedTLS-Migration.
Changes
xecjk(fonts-noto-cjkwas already there), and pass aDOC_LANGbuild-arg through tomake pdf/make html. The HTML output directory is now anHTMLDIRbuild-arg (default${MANPATH}-html, so existing targets are unchanged) so a Japanese manual does not overwrite the English one inbuild/.<manual>-jatarget for each of the above (for examplemake wolfssl-ja), producing the manual's-jp.pdfand<MANPATH>-ja-html. They are collected inJA_MANUALS, whichallbuilds, so the Docker build check covers them.wolftpm-jashares the existing wolfTPM ref pinning.build-jajob that installsfonts-noto-cjkandxecjkand builds the Japanese HTML and PDF of each manual. It runs in parallel with the existingbuildjob (which is unchanged) and starts from a clean checkout, so leftovers from an English build cannot hide a Japanese failure.Not included
make pdf DOC_LANG=JAfails becauseChangeLog.mdis only copied intosrc-jaby thepre-buildstep that plainmakeruns. That needs a smallwolfSentry/Makefilefix, separate from this PR.Testing
Done locally in Docker (arm64) on a clean clone:
make wolfssl wolfssl-ja: English and Japanese wolfSSL PDF and HTML built.make -k -j4 $(JA_MANUALS): all 17 Japanese PDFs and HTML trees built.build-jajob's commands (taken from the workflow file) in the builder image: all 34 steps passed.