ICU-531.30.tar.gz

[apple/icu.git] / icuSources / data / cldr-icu-readme.txt

diff --git a/icuSources/data/cldr-icu-readme.txt b/icuSources/data/cldr-icu-readme.txt
index 1793cd8cadfedc026c228e44b253038ae65059dc..9e433497cdffd330945ec4d7f31747bea05a0bdd 100644 (file)
--- a/icuSources/data/cldr-icu-readme.txt
+++ b/icuSources/data/cldr-icu-readme.txt
@@ -1,11 +1,11 @@
-# Copyright (C) 2010,2012, International Business Machines Corporation and others.
+# Copyright (C) 2010-2013, 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)
 # 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 by the conversion 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
 #    - 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


@@ -48,30 +48,26 @@
 #                etc.); on many systems this can be set using
 #                `/usr/libexec/java_home`.
 #
 #                etc.); on many systems this can be set using
 #                `/usr/libexec/java_home`.
 #

-# XML_APIS_JAR:  Complete path to xml-apis.jar (at the end of the path)
-#
-# ANT_OPTS:      Two important options you may want to set:
+# ANT_OPTS:      You may want to set:

 #
 #                -Xmx1024m, to give Java more memory; otherwise it may run out
 #                 of heap.
 #
 #
 #                -Xmx1024m, to give Java more memory; otherwise it may run out
 #                 of heap.
 #

-#                -DCLDR_DTD_CACHE=/tmp/cldrdtd, to set up a temp directory for
-#                 caching the CLDR xml dtd, to speed up data generation.
-#

 # b) CLDR-related variables
 #
 # CLDR_DIR:      Path to root of CLDR sources, below which are the common and
 # b) CLDR-related variables
 #
 # CLDR_DIR:      Path to root of CLDR sources, below which are the common and

-#                tools directories. Two other variables will be defined based
-#                on this:
-# CLDR_MAIN, CLDR_JAR are defined relative to CLDR_DIR.
+#                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:
+# 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.
 #
 # 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.

-#                Two other variables will be defined based on this:
-# ICU4J_JAR, UTILITIES_JAR are defined relative to ICU4J_ROOT.

 #
 #----
 #
 #
 #----
 #


@@ -96,9 +92,9 @@
 #                <target name="clean" ...> to clean the correct set of files.
 #
 #    icu/trunk/source/data/xml/      - If you are adding a new locale, break
 #                <target name="clean" ...> to clean the correct set of files.
 #
 #    icu/trunk/source/data/xml/      - If you are adding a new locale, break

-#                iterator, collattion tailoring, or rule-based number formatter,
-#                you need to add a corresponding xml file in (respectively) the
-#                main/, brkitr/, collation/, or rbnf/ subdirectory here.
+#                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.

 #
 #----
 #
 #
 #----
 #


@@ -124,40 +120,28 @@
 ################################################################################
 
 # 1a. Java and ant variables, adjust for your system
 ################################################################################
 
 # 1a. Java and ant variables, adjust for your system

-# (here XML_APIS_JAR is set as on Mac OSX).

 
 export JAVA_HOME=`/usr/libexec/java_home`
 
 export JAVA_HOME=`/usr/libexec/java_home`

-export XML_APIS_JAR=/Library/Java/Extensions/xml-apis.jar
-mkdir /tmp/cldrdtd
-export ANT_OPTS="-Xmx1024m -DCLDR_DTD_CACHE=/tmp/cldrdtd"
+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
 
 # 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_MAIN=$CLDR_DIR/common/main
-export CLDR_JAR=$CLDR_DIR/tools/java/cldr.jar

 #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
 #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

-export ICU4J_JAR=$ICU4J_ROOT/icu4j.jar
-export UTILITIES_JAR=$ICU4J_ROOT/out/cldr_util/lib/utilities.jar
-#export ICU4J_CLASSES=$ICU4J_ROOT/out/cldr_util/bin
-
-# 2. Build ICU4J, including the cldr utilities.

 
 

-cd $ICU4J_ROOT
-ant clean all jar cldrUtil
-
-# 3. Build the CLDR Java tools
+# 2. Build the CLDR Java tools

 
 cd $CLDR_DIR/tools/java
 
 cd $CLDR_DIR/tools/java

+#cd $CLDR_DIR/cldr-tools

 ant jar
 
 ant jar
 

-# 4. Configure ICU4C, build and test without new data first, to verify that
+# 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).
 
 # there are no pre-existing errors (configure shown here for MacOSX, adjust
 # for your platform).
 


@@ -166,25 +150,25 @@ cd $ICU4C_DIR/source
 make all 2>&1 | tee /tmp/icu4c-oldData-makeAll.txt
 make check 2>&1 | tee /tmp/icu4c-oldData-makeCheck.txt
 
 make all 2>&1 | tee /tmp/icu4c-oldData-makeAll.txt
 make check 2>&1 | tee /tmp/icu4c-oldData-makeCheck.txt
 

-# 5. Build the new ICU4C data files; these include .txt files and .mk files.
+# 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.
 # 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 (CLDR_DTD_CACHE helps reduce this).
+# 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
 
 # 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
 

-# 6. Check which data files have modifications, which have been added or removed
+# 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
 
 # (if there are no changes, you may not need to proceed further). Make sure the
 # list seems reasonable.
 
 svn status
 

-# 7. Fix any errors, investigate any warnings. Some warnings are expected,
+# 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 #??
 # including  warnings for missing versions in locale names which specify some
 # collationvariants, e.g.
 #   [cldr-build] WARNING (ja_JP_TRADITIONAL): No version #??


@@ -194,39 +178,39 @@ svn status
 #   [cldr-build] WARNING (to):  warning: No collations found. Bundle will ...
 #
 # Fixing may entail modifying CLDR source data or tools - for example,
 #   [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 f appropriate).
-# Repeat steps 5-7 until there are no build errors and no unexpected
+# 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.
 
 # warnings.
 

-# 8. Now rebuild ICU4C with the new data and run make check tests.
+# 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
 
 # Again, keep a log so you can investigate the errors.
 
 cd $ICU4C_DIR/source
 make check 2>&1 | tee /tmp/icu4c-newData-makeCheck.txt
 

-# 9. Investigate each test case failure. The first run processing new CLDR data
+# 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
 # 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 5a. If the data is OK but the testcase needs to be updated because the
+# 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.
 # 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 5-8 until there are no errors.
+# Repeat steps 4-7 until there are no errors.

 
 

-# 10. Now run the make check tests in exhaustive mode:
+# 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
 
 
 cd $ICU4C_DIR/source
 export INTLTEST_OPTS="-e"
 export CINTLTST_OPTS="-e"
 make check 2>&1 | tee /tmp/icu4c-newData-makeCheckEx.txt
 

-# 11. Again, investigate each failure, fixing CLDR data or ICU test cases as
-# appropriate, and repeating steps 5-7 and 10 until there are no errors.
+# 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.

 
 

-# 12. Now with ICU4J, build and test without new data first, to verify that
+# 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):
 
 # there are no pre-existing errors (or at least to have the pre-existing errors
 # as a base for comparison):
 


@@ -234,26 +218,26 @@ cd $ICU4J_ROOT
 ant all 2>&1 | tee /tmp/icu4j-oldData-antAll.txt
 ant check 2>&1 | tee /tmp/icu4j-oldData-antCheck.txt
 
 ant all 2>&1 | tee /tmp/icu4j-oldData-antAll.txt
 ant check 2>&1 | tee /tmp/icu4j-oldData-antCheck.txt
 

-# 13. Now build the new data for ICU4J
+# 12. Now build the new data for ICU4J

 
 cd $ICU4C_DIR/source/data
 make icu4j-data-install
 
 
 cd $ICU4C_DIR/source/data
 make icu4j-data-install
 

-# 14. Now rebuild ICU4J with the new data and run tests:
+# 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
 
 # Keep a log so you can investigate the errors.
 
 cd $ICU4J_ROOT
 ant check 2>&1 | tee /tmp/icu4j-newData-antCheck.txt
 

-# 15. Investigate test case failures; fix test cases and repeat from step 14,
-# or fix CLDR data and repeat from step 5, as appropriate, unitl; there are no
+# 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).
 
 # more failures in ICU4C or ICU4J (except failures that were present before you
 # began testing the new CLDR data).
 

-# 16. Check the file changes; then svn add or svn remove as necessary, and
+# 15. Check the file changes; then svn add or svn remove as necessary, and

 # commit the changes.
 
 # commit the changes.
 

-cd $ICU4C_DIR/source/
+cd $ICU4C_DIR/source

 svn status
 # add or remove as necessary, then commit
 
 svn status
 # add or remove as necessary, then commit
 


@@ -261,7 +245,7 @@ cd $ICU4J_ROOT
 svn status
 # add or remove as necessary, then commit
 
 svn status
 # add or remove as necessary, then commit
 

-# 17. For an official CLDR data integration into ICU, now tag the CLDR, ICU4J,
+# 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.:
 
 # and ICU4C sources with an appropriate CLDR milestone (you can check previous
 # tags for format), e.g.: