• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Notes about the `tools/icu` subdirectory
2
3This directory contains tools and information about the
4[International Components for Unicode][ICU] (ICU) integration.
5Both V8 and Node.js use ICU to provide internationalization functionality.
6
7* `patches/` are one-off patches, actually entire source file replacements,
8  organized by ICU version number.
9* `icu_small.json` controls the "small" (English only) ICU. It is input to
10  `icutrim.py`
11* `icu-generic.gyp` is the build file used for most ICU builds within ICU.
12  <!-- have fun -->
13* `icu-system.gyp` is an alternate build file used when `--with-intl=system-icu`
14   is invoked. It builds against the `pkg-config` located ICU.
15* `iculslocs.cc` is source for the `iculslocs` utility, invoked by `icutrim.py`
16   as part of repackaging. Not used separately. See source for more details.
17* `no-op.cc` contains an empty function to convince gyp to use a C++ compiler.
18* `shrink-icu-src.py` is used during upgrade (see guide below).
19
20Note:
21> The files in this directory were written for the Node.js v0.12 effort.
22> The original intent was to merge the tools such as `icutrim.py` and `iculslocs.cc`
23> back into ICU. ICU has gained its own “data slicer” tool.
24> There is an issue open, <https://github.com/nodejs/node/issues/25136>
25> for replacing `icutrim.py` with the [ICU data slicer][].
26
27## See Also
28
29* [docs/guides/maintaining-icu.md](../../doc/guides/maintaining-icu.md) for
30information on maintaining ICU in Node.js
31
32* [docs/api/intl.md](../../doc/api/intl.md) for information on the
33internationalization-related APIs in Node.js
34* [The ICU Homepage][ICU]
35
36[ICU]: http://icu-project.org
37[ICU data slicer]: https://github.com/unicode-org/icu/blob/master/docs/userguide/icu_data/buildtool.md
38