-# ***************************************************************************
-# *
-# * Copyright (C) 2005, International Business Machines
-# * Corporation and others. All Rights Reserved.
-# *
-# ***************************************************************************
-
-Steps for building ICU data from CLDR:
-
-Users of CLDR:
-1. Download cldrtools.zip from the CLDR website (http://www.unicode.org/cldr/repository_access.html) and unzip in a directory
-2. Download cldr.zip from the CLDR website (same as above) and unzip in cldr directory
-3. Check out ICU from ICU CVS repository http://www.ibm.com/software/globalization/icu/repository.jsp
-4. Set the required environment variables
- export JAVA_HOME=<path>/java
- export ANT_OPTS="-DCLDR_DTD_CACHE=<path>/temp/cldrdtd"
- export CLDR_DIR=<path>/cldr
- export CLDR_JAR=<path>/cldr.jar
- export ICU4C_DIR=<path>/icu
- export ICU4J_JAR=<path>/icu4j.jar
- export UTILITIES_JAR=<path>/utilities.jar
-5. Change directory to <path>/icu/source/data/
-6. Enter command
- <path>/ant/bin/ant clean all
-
-Developers of CLDR:
-1. Check out CLDR from the CVS repository http://www.unicode.org/cldr/repository_access.html and build the tools.
-2. Check out ICU from ICU CVS repository http://www.ibm.com/software/globalization/icu/repository.jsp and build it.
-3. Check out ICU4J from ICU CVS repository http://www.ibm.com/software/globalization/icu/repository.jsp and build it.
-4. Set the required environment variables
- export JAVA_HOME=<path>/java
- export ANT_OPTS="-DCLDR_DTD_CACHE=<path>/temp/cldrdtd"
- export CLDR_DIR=<path>/cldr
- export CLDR_CLASSES=<path>/cldr/tools/java/classes
- export ICU4C_DIR=<path>/icu
- export ICU4J_CLASSES=<path>/icu4j/classes
-5. Change directory to <path>/icu/source/data/
-6. Enter command
- <path>/ant/bin/ant clean all
-
-Debugging in Eclipse:
-1. From Eclipse select Run > Run from toolbar
-2. Click New button
-3. Go to Main tab and enter
- Name: Ant_Launcher
- Project: cldr
- Main class: org.apache.tools.ant.launch.Launcher
-4. Go to Arguments tab and enter
- Program Arguments: -buildfile c:\work\cldr\tools\java\build.xml icu4c
- VM Arguments: -classpath C:\work\apache-ant-1.6.1\lib\ant-launcher.jar
- -Dant.home=C:\work\apache-ant-1.6.1
- -DCLDR_DTD_CACHE=/work/temp/cldrdtd/
-5. Go to Environment tag and create new variables
- CLDR_DIR=<path>/cldr
- CLDR_CLASSES=<path>/cldr/tools/java/classes
- ICU4C_DIR=/work/icu
- ICU4J_CLASSES=<path>/icu4j/classes
-6. Set a break point in CLDRBuild or the tool class that needs to be debugged.
+# Copyright (C) 2010-2014, International Business Machines Corporation and others.
+# All Rights Reserved.
+#
+# Commands for regenerating ICU4C locale data (.txt files) from CLDR.
+#
+# The process requires local copies of
+# - CLDR (the source of most of the data, and some Java tools)
+# - ICU4J (used only for checking the converted data)
+# - ICU4C (the destination for the new data, and the source for some of it)
+# (Either check out ICU4C from Subversion, or download the additional
+# icu4c-*-data.zip file so that the icu/source/data/ directory is fully
+# populated.)
+#
+# For an official CLDR data integration into ICU, these should be clean, freshly
+# checked-out. For released CLDR sources, an alternative to checking out sources
+# for a given version is downloading the zipped sources for the common (core.zip)
+# and tools (tools.zip) directory subtrees from the Data column in
+# [http://cldr.unicode.org/index/downloads].
+#
+# The versions of each of these must match. Included with the release notes for
+# ICU is the version number and/or a CLDR svn tag name for the revision of CLDR
+# that was the source of the data for that release of ICU.
+#
+# Note: Some versions of the OpenJDK will not build the CLDR java utilities.
+# If you see compilation errors complaining about type incompatibilities with
+# functions on generic classes, try switching to the Sun JDK.
+#
+# Besides a standard JDK, the process also requires ant
+# (http://ant.apache.org/),
+# plus the xml-apis.jar from the Apache xalan package
+# (http://xml.apache.org/xalan-j/downloads.html).
+#
+# Note: Enough things can (and will) fail in this process that it is best to
+# run the commands separately from an interactive shell. They should all
+# copy and paste without problems.
+#
+# It is often useful to save logs of the output of many of the steps in this
+# process. The commands below put log files in /tmp; you may want to put them
+# somewhere else.
+#
+#----
+#
+# There are several environment variables that need to be defined.
+#
+# a) Java- and ant-related variables
+#
+# JAVA_HOME: Path to JDK (a directory, containing e.g. bin/java, bin/javac,
+# etc.); on many systems this can be set using
+# `/usr/libexec/java_home`.
+#
+# ANT_OPTS: You may want to set:
+#
+# -Xmx1024m, to give Java more memory; otherwise it may run out
+# of heap.
+#
+# b) CLDR-related variables
+#
+# CLDR_DIR: Path to root of CLDR sources, below which are the common and
+# tools directories.
+# CLDR_CLASSES: Defined relative to CLDR_DIR. It only needs to be set if you
+# are not running ant jar for CLDR and have a non-default output
+# folder for cldr-tools classes.
+#
+# c) ICU-related variables
+# These variables only need to be set if you're directly reusing the
+# commands below.
+#
+# ICU4C_DIR: Path to root of ICU4C sources, below which is the source dir.
+#
+# ICU4J_ROOT: Path to root of ICU4J sources, below which is the main dir.
+#
+#----
+#
+# If you are adding or removing locales, or specific kinds of locale data,
+# there are some xml files in the ICU sources that need to be updated (these xml
+# files are used in addition to the CLDR files as inputs to the CLDR data build
+# process for ICU):
+#
+# icu/trunk/source/data/icu-config.xml - Update <locales> to add or remove
+# CLDR locales for inclusion in ICU. Update <paths> to prefer
+# alt forms for certain paths, or to exclude certain paths; note
+# that <paths> items can only have draft or alt attributes.
+#
+# Note that if a language-only locale (e.g. "de") is included in
+# <locales>, then all region sublocales for that language that
+# are present in CLDR data (e.g. "de_AT", "de_BE", "de_CH", etc.)
+# should also be included in <locales>, per PMC policy decision
+# 2012-05-02 (see http://bugs.icu-project.org/trac/ticket/9298).
+#
+# icu/trunk/source/data/build.xml - If you are adding or removing break
+# iterators, you need to update <fileset id="brkitr" ...> under
+# <target name="clean" ...> to clean the correct set of files.
+#
+# icu/trunk/source/data/xml/ - If you are adding a new locale, break
+# iterator, collation tailoring, or rule-based number formatter,
+# you may need to add a corresponding xml file in (respectively)
+# the main/, brkitr/, collation/, or rbnf/ subdirectory here.
+#
+#----
+#
+# For an official CLDR data integration into ICU, there are some additional
+# considerations:
+#
+# a) Don't commit anything in ICU sources (and possibly any changes in CLDR
+# sources, depending on their nature) until you have finished testing and
+# resolving build issues and test failures for both ICU4C and ICU4J.
+#
+# b) There are version numbers that may need manual updating in CLDR (other
+# version numbers get updated automatically, based on these):
+#
+# common/dtd/ldml.dtd - update cldrVersion
+# common/dtd/ldmlBCP47.dtd - update cldrVersion
+# common/dtd/ldmlSupplemental.dtd - update cldrVersion
+# tools/java/org/unicode/cldr/util/CLDRFile.java - update GEN_VERSION
+#
+# c) After everything is committed, you will need to tag the CLDR, ICU4J, and
+# ICU4C sources that ended up being used for the integration; see step 17
+# below.
+#
+################################################################################
+
+# 1a. Java and ant variables, adjust for your system
+
+export JAVA_HOME=`/usr/libexec/java_home`
+export ANT_OPTS="-Xmx1024m"
+
+# 1b. CLDR variables, adjust for your setup; with cygwin it might be e.g.
+# CLDR_DIR=`cygpath -wp /build/cldr`
+
+export CLDR_DIR=$HOME/cldr/trunk
+#export CLDR_CLASSES=$CLDR_DIR/tools/java/classes
+
+# 1c. ICU variables
+
+export ICU4C_DIR=$HOME/icu/icu/trunk
+export ICU4J_ROOT=$HOME/icu/icu4j/trunk
+
+# 2. Build the CLDR Java tools
+
+cd $CLDR_DIR/tools/java
+#cd $CLDR_DIR/cldr-tools
+ant jar
+
+# 3. Configure ICU4C, build and test without new data first, to verify that
+# there are no pre-existing errors (configure shown here for MacOSX, adjust
+# for your platform).
+
+cd $ICU4C_DIR/source
+./runConfigureICU MacOSX
+make all 2>&1 | tee /tmp/icu4c-oldData-makeAll.txt
+make check 2>&1 | tee /tmp/icu4c-oldData-makeCheck.txt
+
+# 4. Build the new ICU4C data files; these include .txt files and .mk files.
+# These new files will replace whatever was already present in the ICU4C sources.
+# This process uses ant with ICU's data/build.xml and data/icu-config.xml to
+# operate (via CLDR's ant/CLDRConverterTool.java and ant/CLDRBuild.java) the
+# necessary CLDR tools including LDML2ICUConverter, ConvertTransforms, etc.
+# This process will take several minutes.
+# Keep a log so you can investigate anything that looks suspicious.
+
+cd $ICU4C_DIR/source/data
+ant clean
+ant all 2>&1 | tee /tmp/cldrNN-buildLog.txt
+
+# 5. Check which data files have modifications, which have been added or removed
+# (if there are no changes, you may not need to proceed further). Make sure the
+# list seems reasonable.
+
+svn status
+
+# 6. Fix any errors, investigate any warnings. Some warnings are expected,
+# including warnings for missing versions in locale names which specify some
+# collationvariants, e.g.
+# [cldr-build] WARNING (ja_JP_TRADITIONAL): No version #??
+# [cldr-build] WARNING (zh_TW_STROKE): No version #??
+# and warnings for some empty collation bundles, e.g.
+# [cldr-build] WARNING (en): warning: No collations found. Bundle will ...
+# [cldr-build] WARNING (to): warning: No collations found. Bundle will ...
+#
+# Fixing may entail modifying CLDR source data or tools - for example,
+# updating the validSubLocales for collation data (file a bug if appropriate).
+# Repeat steps 4-5 until there are no build errors and no unexpected
+# warnings.
+
+# 7. Now rebuild ICU4C with the new data and run make check tests.
+# Again, keep a log so you can investigate the errors.
+
+cd $ICU4C_DIR/source
+make check 2>&1 | tee /tmp/icu4c-newData-makeCheck.txt
+
+# 8. Investigate each test case failure. The first run processing new CLDR data
+# from the Survey Tool can result in thousands of failures (in many cases, one
+# CLDR data fix can resolve hundreds of test failures). If the error is caused
+# by bad CLDR data, then file a CLDR bug, fix the data, and regenerate from
+# step 4. If the data is OK but the testcase needs to be updated because the
+# data has legitimately changed, then update the testcase. You will check in
+# the updated testcases along with the new ICU data at the end of this process.
+# Note that if the new data has any differences in structure, you will have to
+# update test/testdata/structLocale.txt or /tsutil/cldrtest/TestLocaleStructure
+# may fail.
+# Repeat steps 4-7 until there are no errors.
+
+# 9. Now run the make check tests in exhaustive mode:
+
+cd $ICU4C_DIR/source
+export INTLTEST_OPTS="-e"
+export CINTLTST_OPTS="-e"
+make check 2>&1 | tee /tmp/icu4c-newData-makeCheckEx.txt
+
+# 10. Again, investigate each failure, fixing CLDR data or ICU test cases as
+# appropriate, and repeating steps 4-7 and 9 until there are no errors.
+
+# 11. Now with ICU4J, build and test without new data first, to verify that
+# there are no pre-existing errors (or at least to have the pre-existing errors
+# as a base for comparison):
+
+cd $ICU4J_ROOT
+ant all 2>&1 | tee /tmp/icu4j-oldData-antAll.txt
+ant check 2>&1 | tee /tmp/icu4j-oldData-antCheck.txt
+
+# 12. Now build the new data for ICU4J
+
+cd $ICU4C_DIR/source/data
+make icu4j-data-install
+
+# 13. Now rebuild ICU4J with the new data and run tests:
+# Keep a log so you can investigate the errors.
+
+cd $ICU4J_ROOT
+ant check 2>&1 | tee /tmp/icu4j-newData-antCheck.txt
+
+# 14. Investigate test case failures; fix test cases and repeat from step 12,
+# or fix CLDR data and repeat from step 4, as appropriate, until; there are no
+# more failures in ICU4C or ICU4J (except failures that were present before you
+# began testing the new CLDR data).
+
+# 15. Check the file changes; then svn add or svn remove as necessary, and
+# commit the changes.
+
+cd $ICU4C_DIR/source
+svn status
+# add or remove as necessary, then commit
+
+cd $ICU4J_ROOT
+svn status
+# add or remove as necessary, then commit
+
+# 16. For an official CLDR data integration into ICU, now tag the CLDR, ICU4J,
+# and ICU4C sources with an appropriate CLDR milestone (you can check previous
+# tags for format), e.g.:
+
+svn copy svn+ssh://unicode.org/repos/cldr/trunk \
+svn+ssh://unicode.org/repos/cldr/tags/release-NNN \
+--parents -m "cldrbug nnnn: tag cldr sources for NNN"
+
+svn copy svn+ssh://source.icu-project.org/repos/icu/icu4j/trunk \
+svn+ssh://source.icu-project.org/repos/icu/icu4j/tags/cldr-NNN \
+--parents -m 'ticket:mmmm: tag the version used for integrating CLDR NNN'
+
+svn copy svn+ssh://source.icu-project.org/repos/icu/icu/trunk \
+svn+ssh://source.icu-project.org/repos/icu/icu/tags/cldr-NNN \
+--parents -m 'ticket:mmmm: tag the version used for integrating CLDR NNN'
+
projects / apple / icu.git / blobdiff