The Tor Browser / file comparison
comparison: intl/icu/source/data/cldr-icu-readme.txt
intl/icu/source/data/cldr-icu-readme.txt
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
equal
deleted
inserted
replaced
| -1:000000000000 | 0:3674c51c6a82 |
|---|---|
| 1 # Copyright (C) 2010-2013, International Business Machines Corporation and others. | |
| 2 # All Rights Reserved. | |
| 3 # | |
| 4 # Commands for regenerating ICU4C locale data (.txt files) from CLDR. | |
| 5 # | |
| 6 # The process requires local copies of | |
| 7 # - CLDR (the source of most of the data, and some Java tools) | |
| 8 # - ICU4J (used only for checking the converted data) | |
| 9 # - ICU4C (the destination for the new data, and the source for some of it) | |
| 10 # (Either check out ICU4C from Subversion, or download the additional | |
| 11 # icu4c-*-data.zip file so that the icu/source/data/ directory is fully | |
| 12 # populated.) | |
| 13 # | |
| 14 # For an official CLDR data integration into ICU, these should be clean, freshly | |
| 15 # checked-out. For released CLDR sources, an alternative to checking out sources | |
| 16 # for a given version is downloading the zipped sources for the common (core.zip) | |
| 17 # and tools (tools.zip) directory subtrees from the Data column in | |
| 18 # [http://cldr.unicode.org/index/downloads]. | |
| 19 # | |
| 20 # The versions of each of these must match. Included with the release notes for | |
| 21 # ICU is the version number and/or a CLDR svn tag name for the revision of CLDR | |
| 22 # that was the source of the data for that release of ICU. | |
| 23 # | |
| 24 # Note: Some versions of the OpenJDK will not build the CLDR java utilities. | |
| 25 # If you see compilation errors complaining about type incompatibilities with | |
| 26 # functions on generic classes, try switching to the Sun JDK. | |
| 27 # | |
| 28 # Besides a standard JDK, the process also requires ant | |
| 29 # (http://ant.apache.org/), | |
| 30 # plus the xml-apis.jar from the Apache xalan package | |
| 31 # (http://xml.apache.org/xalan-j/downloads.html). | |
| 32 # | |
| 33 # Note: Enough things can (and will) fail in this process that it is best to | |
| 34 # run the commands separately from an interactive shell. They should all | |
| 35 # copy and paste without problems. | |
| 36 # | |
| 37 # It is often useful to save logs of the output of many of the steps in this | |
| 38 # process. The commands below put log files in /tmp; you may want to put them | |
| 39 # somewhere else. | |
| 40 # | |
| 41 #---- | |
| 42 # | |
| 43 # There are several environment variables that need to be defined. | |
| 44 # | |
| 45 # a) Java- and ant-related variables | |
| 46 # | |
| 47 # JAVA_HOME: Path to JDK (a directory, containing e.g. bin/java, bin/javac, | |
| 48 # etc.); on many systems this can be set using | |
| 49 # `/usr/libexec/java_home`. | |
| 50 # | |
| 51 # ANT_OPTS: You may want to set: | |
| 52 # | |
| 53 # -Xmx1024m, to give Java more memory; otherwise it may run out | |
| 54 # of heap. | |
| 55 # | |
| 56 # b) CLDR-related variables | |
| 57 # | |
| 58 # CLDR_DIR: Path to root of CLDR sources, below which are the common and | |
| 59 # tools directories. | |
| 60 # CLDR_CLASSES: Defined relative to CLDR_DIR. It only needs to be set if you | |
| 61 # are not running ant jar for CLDR and have a non-default output | |
| 62 # folder for cldr-tools classes. | |
| 63 # | |
| 64 # c) ICU-related variables | |
| 65 # These variables only need to be set if you're directly reusing the | |
| 66 # commands below. | |
| 67 # | |
| 68 # ICU4C_DIR: Path to root of ICU4C sources, below which is the source dir. | |
| 69 # | |
| 70 # ICU4J_ROOT: Path to root of ICU4J sources, below which is the main dir. | |
| 71 # | |
| 72 #---- | |
| 73 # | |
| 74 # If you are adding or removing locales, or specific kinds of locale data, | |
| 75 # there are some xml files in the ICU sources that need to be updated (these xml | |
| 76 # files are used in addition to the CLDR files as inputs to the CLDR data build | |
| 77 # process for ICU): | |
| 78 # | |
| 79 # icu/trunk/source/data/icu-config.xml - Update <locales> to add or remove | |
| 80 # CLDR locales for inclusion in ICU. Update <paths> to prefer | |
| 81 # alt forms for certain paths, or to exclude certain paths; note | |
| 82 # that <paths> items can only have draft or alt attributes. | |
| 83 # | |
| 84 # Note that if a language-only locale (e.g. "de") is included in | |
| 85 # <locales>, then all region sublocales for that language that | |
| 86 # are present in CLDR data (e.g. "de_AT", "de_BE", "de_CH", etc.) | |
| 87 # should also be included in <locales>, per PMC policy decision | |
| 88 # 2012-05-02 (see http://bugs.icu-project.org/trac/ticket/9298). | |
| 89 # | |
| 90 # icu/trunk/source/data/build.xml - If you are adding or removing break | |
| 91 # iterators, you need to update <fileset id="brkitr" ...> under | |
| 92 # <target name="clean" ...> to clean the correct set of files. | |
| 93 # | |
| 94 # icu/trunk/source/data/xml/ - If you are adding a new locale, break | |
| 95 # iterator, collation tailoring, or rule-based number formatter, | |
| 96 # you may need to add a corresponding xml file in (respectively) | |
| 97 # the main/, brkitr/, collation/, or rbnf/ subdirectory here. | |
| 98 # | |
| 99 #---- | |
| 100 # | |
| 101 # For an official CLDR data integration into ICU, there are some additional | |
| 102 # considerations: | |
| 103 # | |
| 104 # a) Don't commit anything in ICU sources (and possibly any changes in CLDR | |
| 105 # sources, depending on their nature) until you have finished testing and | |
| 106 # resolving build issues and test failures for both ICU4C and ICU4J. | |
| 107 # | |
| 108 # b) There are version numbers that may need manual updating in CLDR (other | |
| 109 # version numbers get updated automatically, based on these): | |
| 110 # | |
| 111 # common/dtd/ldml.dtd - update cldrVersion | |
| 112 # common/dtd/ldmlBCP47.dtd - update cldrVersion | |
| 113 # common/dtd/ldmlSupplemental.dtd - update cldrVersion | |
| 114 # tools/java/org/unicode/cldr/util/CLDRFile.java - update GEN_VERSION | |
| 115 # | |
| 116 # c) After everything is committed, you will need to tag the CLDR, ICU4J, and | |
| 117 # ICU4C sources that ended up being used for the integration; see step 17 | |
| 118 # below. | |
| 119 # | |
| 120 ################################################################################ | |
| 121 | |
| 122 # 1a. Java and ant variables, adjust for your system | |
| 123 | |
| 124 export JAVA_HOME=`/usr/libexec/java_home` | |
| 125 export ANT_OPTS="-Xmx1024m | |
| 126 | |
| 127 # 1b. CLDR variables, adjust for your setup; with cygwin it might be e.g. | |
| 128 # CLDR_DIR=`cygpath -wp /build/cldr` | |
| 129 | |
| 130 export CLDR_DIR=$HOME/cldr/trunk | |
| 131 #export CLDR_CLASSES=$CLDR_DIR/tools/java/classes | |
| 132 | |
| 133 # 1c. ICU variables | |
| 134 | |
| 135 export ICU4C_DIR=$HOME/icu/icu/trunk | |
| 136 export ICU4J_ROOT=$HOME/icu/icu4j/trunk | |
| 137 | |
| 138 # 2. Build the CLDR Java tools | |
| 139 | |
| 140 cd $CLDR_DIR/tools/java | |
| 141 #cd $CLDR_DIR/cldr-tools | |
| 142 ant jar | |
| 143 | |
| 144 # 3. Configure ICU4C, build and test without new data first, to verify that | |
| 145 # there are no pre-existing errors (configure shown here for MacOSX, adjust | |
| 146 # for your platform). | |
| 147 | |
| 148 cd $ICU4C_DIR/source | |
| 149 ./runConfigureICU MacOSX | |
| 150 make all 2>&1 | tee /tmp/icu4c-oldData-makeAll.txt | |
| 151 make check 2>&1 | tee /tmp/icu4c-oldData-makeCheck.txt | |
| 152 | |
| 153 # 4. Build the new ICU4C data files; these include .txt files and .mk files. | |
| 154 # These new files will replace whatever was already present in the ICU4C sources. | |
| 155 # This process uses ant with ICU's data/build.xml and data/icu-config.xml to | |
| 156 # operate (via CLDR's ant/CLDRConverterTool.java and ant/CLDRBuild.java) the | |
| 157 # necessary CLDR tools including LDML2ICUConverter, ConvertTransforms, etc. | |
| 158 # This process will take several minutes. | |
| 159 # Keep a log so you can investigate anything that looks suspicious. | |
| 160 | |
| 161 cd $ICU4C_DIR/source/data | |
| 162 ant clean | |
| 163 ant all 2>&1 | tee /tmp/cldrNN-buildLog.txt | |
| 164 | |
| 165 # 5. Check which data files have modifications, which have been added or removed | |
| 166 # (if there are no changes, you may not need to proceed further). Make sure the | |
| 167 # list seems reasonable. | |
| 168 | |
| 169 svn status | |
| 170 | |
| 171 # 6. Fix any errors, investigate any warnings. Some warnings are expected, | |
| 172 # including warnings for missing versions in locale names which specify some | |
| 173 # collationvariants, e.g. | |
| 174 # [cldr-build] WARNING (ja_JP_TRADITIONAL): No version #?? | |
| 175 # [cldr-build] WARNING (zh_TW_STROKE): No version #?? | |
| 176 # and warnings for some empty collation bundles, e.g. | |
| 177 # [cldr-build] WARNING (en): warning: No collations found. Bundle will ... | |
| 178 # [cldr-build] WARNING (to): warning: No collations found. Bundle will ... | |
| 179 # | |
| 180 # Fixing may entail modifying CLDR source data or tools - for example, | |
| 181 # updating the validSubLocales for collation data (file a bug if appropriate). | |
| 182 # Repeat steps 4-5 until there are no build errors and no unexpected | |
| 183 # warnings. | |
| 184 | |
| 185 # 7. Now rebuild ICU4C with the new data and run make check tests. | |
| 186 # Again, keep a log so you can investigate the errors. | |
| 187 | |
| 188 cd $ICU4C_DIR/source | |
| 189 make check 2>&1 | tee /tmp/icu4c-newData-makeCheck.txt | |
| 190 | |
| 191 # 8. Investigate each test case failure. The first run processing new CLDR data | |
| 192 # from the Survey Tool can result in thousands of failures (in many cases, one | |
| 193 # CLDR data fix can resolve hundreds of test failures). If the error is caused | |
| 194 # by bad CLDR data, then file a CLDR bug, fix the data, and regenerate from | |
| 195 # step 4. If the data is OK but the testcase needs to be updated because the | |
| 196 # data has legitimately changed, then update the testcase. You will check in | |
| 197 # the updated testcases along with the new ICU data at the end of this process. | |
| 198 # Note that if the new data has any differences in structure, you will have to | |
| 199 # update test/testdata/structLocale.txt or /tsutil/cldrtest/TestLocaleStructure | |
| 200 # may fail. | |
| 201 # Repeat steps 4-7 until there are no errors. | |
| 202 | |
| 203 # 9. Now run the make check tests in exhaustive mode: | |
| 204 | |
| 205 cd $ICU4C_DIR/source | |
| 206 export INTLTEST_OPTS="-e" | |
| 207 export CINTLTST_OPTS="-e" | |
| 208 make check 2>&1 | tee /tmp/icu4c-newData-makeCheckEx.txt | |
| 209 | |
| 210 # 10. Again, investigate each failure, fixing CLDR data or ICU test cases as | |
| 211 # appropriate, and repeating steps 4-7 and 9 until there are no errors. | |
| 212 | |
| 213 # 11. Now with ICU4J, build and test without new data first, to verify that | |
| 214 # there are no pre-existing errors (or at least to have the pre-existing errors | |
| 215 # as a base for comparison): | |
| 216 | |
| 217 cd $ICU4J_ROOT | |
| 218 ant all 2>&1 | tee /tmp/icu4j-oldData-antAll.txt | |
| 219 ant check 2>&1 | tee /tmp/icu4j-oldData-antCheck.txt | |
| 220 | |
| 221 # 12. Now build the new data for ICU4J | |
| 222 | |
| 223 cd $ICU4C_DIR/source/data | |
| 224 make icu4j-data-install | |
| 225 | |
| 226 # 13. Now rebuild ICU4J with the new data and run tests: | |
| 227 # Keep a log so you can investigate the errors. | |
| 228 | |
| 229 cd $ICU4J_ROOT | |
| 230 ant check 2>&1 | tee /tmp/icu4j-newData-antCheck.txt | |
| 231 | |
| 232 # 14. Investigate test case failures; fix test cases and repeat from step 12, | |
| 233 # or fix CLDR data and repeat from step 4, as appropriate, until; there are no | |
| 234 # more failures in ICU4C or ICU4J (except failures that were present before you | |
| 235 # began testing the new CLDR data). | |
| 236 | |
| 237 # 15. Check the file changes; then svn add or svn remove as necessary, and | |
| 238 # commit the changes. | |
| 239 | |
| 240 cd $ICU4C_DIR/source | |
| 241 svn status | |
| 242 # add or remove as necessary, then commit | |
| 243 | |
| 244 cd $ICU4J_ROOT | |
| 245 svn status | |
| 246 # add or remove as necessary, then commit | |
| 247 | |
| 248 # 16. For an official CLDR data integration into ICU, now tag the CLDR, ICU4J, | |
| 249 # and ICU4C sources with an appropriate CLDR milestone (you can check previous | |
| 250 # tags for format), e.g.: | |
| 251 | |
| 252 svn copy svn+ssh://unicode.org/repos/cldr/trunk \ | |
| 253 svn+ssh://unicode.org/repos/cldr/tags/release-NNN \ | |
| 254 --parents -m "cldrbug nnnn: tag cldr sources for NNN" | |
| 255 | |
| 256 svn copy svn+ssh://source.icu-project.org/repos/icu/icu4j/trunk \ | |
| 257 svn+ssh://source.icu-project.org/repos/icu/icu4j/tags/cldr-NNN \ | |
| 258 --parents -m 'ticket:mmmm: tag the version used for integrating CLDR NNN' | |
| 259 | |
| 260 svn copy svn+ssh://source.icu-project.org/repos/icu/icu/trunk \ | |
| 261 svn+ssh://source.icu-project.org/repos/icu/icu/tags/cldr-NNN \ | |
| 262 --parents -m 'ticket:mmmm: tag the version used for integrating CLDR NNN' | |
| 263 |
