0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-30 07:27:22 +01:00
nodejs/tools/icu/README.md
Steven R. Loomis f36331c1bf
doc,deps: document how to maintain ICU in Node.js
- update v8 guide to mention ICU
- move content from the tools/icu/README.md but leave a pointer

Fixes: https://github.com/nodejs/node/issues/26108
Co-Authored-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/30607

Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2019-11-27 01:54:52 -05:00

1.8 KiB

Notes about the tools/icu subdirectory

This directory contains tools, data, and information about the International Components for Unicode integration. ICU is used both by V8 and also by Node.js itself to provide internationalization functionality.

  • patches/ are one-off patches, actually entire source file replacements, organized by ICU version number.
  • icu_small.json controls the "small" (English only) ICU. It is input to icutrim.py
  • icu-generic.gyp is the build file used for most ICU builds within ICU.
  • icu-system.gyp is an alternate build file used when --with-intl=system-icu is invoked. It builds against the pkg-config located ICU.
  • iculslocs.cc is source for the iculslocs utility, invoked by icutrim.py as part of repackaging. Not used separately. See source for more details.
  • no-op.cc — empty function to convince gyp to use a C++ compiler.
  • README.md — you are here
  • shrink-icu-src.py — this is used during upgrade (see guide below)

Note:

The files in this directory were written for the Node.js v0.12 effort. The original intent was to merge the tools such as icutrim.py and iculslocs.cc back into ICU. ICU has gained its own “data slicer” tool. There is an issue open, https://github.com/nodejs/node/issues/25136 for replacing icutrim.py with the ICU data slicer.

See Also