Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify use of deps/icu-small #43287

Closed
wants to merge 4 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion doc/contributing/maintaining-icu.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ functionality. To quote from icu-project.org:
> widely portable and gives applications the same results on all platforms
> and between C/C++ and Java software.
If Node.js is configured to use its built-in ICU,
it uses a strict subset of ICU which is in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM unless it's worth noting that the subset is not by locale (and type), but by type.

It's further confusing that 'small-icu' is an option still, but is !== the small-icu directory.

[deps/icu-small](https://github.com/nodejs/node/tree/HEAD/deps/icu-small).
A good description of the different ways Node.js can be built with ICU
support is in [api/intl.html](https://nodejs.org/api/intl.html).

## Data dependencies

ICU consumes and includes:
Expand Down Expand Up @@ -51,7 +57,7 @@ files.

#### Example: updating the ICU `.dat` file

* Decompress `deps/icu/source/data/in/icudt##l.dat.bz2`, where `##` is
* Decompress `deps/icu-small/source/data/in/icudt##l.dat.bz2`, where `##` is
the ICU major version number.
* Clone the icu/icu-data repository and copy the latest `tzdata` release `le`
files into the `source/data/in` directory.
Expand Down