node/tools/icu
Michael Dawson a199387f04 doc: make contributing info more discoverable
There are been several discussions in recent PRs about
the docs related to contributing not being very discoverable.
Move these docs from doc/guides/ to doc/contributing.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/41408
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
2022-01-18 14:24:30 -05:00
..
README.md doc: make contributing info more discoverable 2022-01-18 14:24:30 -05:00
current_ver.dep deps: update ICU to 70.1 2021-11-09 17:26:53 +01:00
icu-generic.gyp build: make scripts in gyp run with right python 2021-10-09 22:16:05 +00:00
icu-system.gyp
icu_small.json deps: enable unit data in small-icu 2019-09-30 06:48:33 -07:00
icu_versions.json deps: bump minimum ICU version to 69 2021-07-20 15:27:41 +02:00
iculslocs.cc tools: fix undeclared identifier FALSE 2020-11-28 05:48:30 -08:00
icutrim.py tools: fixup icutrim.py use of string and bytes objects 2020-03-18 16:18:27 -07:00
no-op.cc
shrink-icu-src.py deps: minor ICU fixes: maint docs/tool, downloader 2020-03-20 17:21:50 -07:00

README.md

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