node/tools/icu/README.md
Marco Ippolito 109ab0a89c
doc: create maintaining folder for deps
PR-URL: https://github.com/nodejs/node/pull/47589
Refs: https://github.com/nodejs/security-wg/issues/828
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2023-05-02 17:03:23 +00:00

1.7 KiB

Notes about the tools/icu subdirectory

This directory contains tools and information about the International Components for Unicode (ICU) integration. Both V8 and Node.js use ICU 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 contains an empty function to convince gyp to use a C++ compiler.
  • shrink-icu-src.py 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