Skip to content

doc: clarify ICU source layout for --with-icu-source#62011

Open
skdas20 wants to merge 1 commit intonodejs:mainfrom
skdas20:docs/clarify-icu-source-layout-60947
Open

doc: clarify ICU source layout for --with-icu-source#62011
skdas20 wants to merge 1 commit intonodejs:mainfrom
skdas20:docs/clarify-icu-source-layout-60947

Conversation

@skdas20
Copy link

@skdas20 skdas20 commented Feb 26, 2026

Fixes #60947

Summary

Clarifies --with-icu-source build docs to match current ICU release packaging and expected directory layout:

  • Updated example archive name from icu4c-##.#-src.tgz to icu4c-##.#-sources.tgz.
  • Clarified that --with-icu-source must point to an extracted ICU source archive layout.
  • Added note that a plain ICU Git checkout is not sufficient unless prepared into that layout.

Validation

Ran markdown lint on the changed file:

node tools/lint-md/lint-md.mjs BUILDING.md

Result: exit code 0.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/build
  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Feb 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs for building with an ICU source directory don't work

2 participants