Skip to content

Build the Japanese manuals in Docker and CI - #300

Open
LinuxJedi wants to merge 1 commit into
wolfSSL:masterfrom
LinuxJedi:ja-docker-ci-build
Open

LinuxJedi wants to merge 1 commit into
wolfSSL:masterfrom
LinuxJedi:ja-docker-ci-build

Conversation

@LinuxJedi

Copy link
Copy Markdown
Member

Summary

The Japanese PDFs (make pdf DOC_LANG=JA) could not be built with this repo's tooling: neither the Docker builder image nor the build-check.yml workflow installed the xeCJK LaTeX package, so the build failed with LaTeX 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

  • Dockerfile: install xecjk (fonts-noto-cjk was already there), and pass a DOC_LANG build-arg through to make pdf / make html. The HTML output directory is now an HTMLDIR build-arg (default ${MANPATH}-html, so existing targets are unchanged) so a Japanese manual does not overwrite the English one in build/.
  • Makefile: add a <manual>-ja target for each of the above (for example make wolfssl-ja), producing the manual's -jp.pdf and <MANPATH>-ja-html. They are collected in JA_MANUALS, which all builds, so the Docker build check covers them. wolftpm-ja shares the existing 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 manual. It runs in parallel with the existing build job (which is unchanged) and starts from a clean checkout, so leftovers from an English build cannot hide a Japanese failure.

Not included

  • wolfSentry: its Japanese HTML builds, but make pdf DOC_LANG=JA fails because ChangeLog.md is only copied into src-ja by the pre-build step that plain make runs. That needs a small wolfSentry/Makefile fix, 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.
  • Replayed the build-ja job's commands (taken from the workflow file) in the builder image: all 34 steps passed.
  • Checked that the Japanese wolfSSL PDF renders Japanese text with Noto Sans CJK JP.

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.
Copilot AI balanced review requested due to automatic review settings November 18, 2026 06:02

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 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 xecjk in 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

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.

4 participants