readme.txt
1# Copyright (C) 2016 and later: Unicode, Inc. and others.
2# License & terms of use: http://www.unicode.org/copyright.html
3# Copyright (C) 2009-2013 IBM and Others. All Rights Reserved
4
5API Change Report:
6
7A tool to generate a report of API status changes between two ICU4C releases.
8(ICU4J has a builtin change report generator)
9
10Requirements:
11 - Everything needed to build ICU4C from a command line (UNIX) environment
12 - Doxygen (for generating docs).
13 Doxygen 1.8.13 or newer is recommended for ICU API docs,
14 but an older Doxygen may work for the API Change Report.
15 - Java JDK 1.8+
16 - Apache Ant
17 - Maven
18
19To use the utility:
20 1. Put both old and new ICU source trees on your system
21
222. Run "configure" in both old and new (you can use any mixture of in-source and out-of-source builds). Doxygen must be found during the configure phase, but you do not need to build the standard API docs.
23
243. create a Makefile.local in this readme's directory (tools/trunk/release/java/)
25 with just these two lines, for example:
26 OLD_ICU=/xsrl/E/icu-6.7
27 NEW_ICU=/xsrl/E/icu-6.8
28
29 Set these paths to the location of parent directory of the
30 ICU4C sources in the previous version (OLD) and the
31 source of the current release (NEW)
32
33 If your ICU is an out-of-source-build, add these two lines
34 indicating the build location:
35 OLD_ICU_BUILD=/xsrl/E/icu-build-m48
36 NEW_ICU_BUILD=/xsrl/E/icu-build
37
384. from this directory, (tools/release/java/) run Make to build docs: (the tool will be built automatically)
39 make APIChangeReport.html
40 make APIChangeReport.md
41
425. This will create 'APIChangeReport.html' and 'APIChangeReport.md" files in
43this directory. Look them over, and then check them into ${NEW_ICU}/APIChangeReport.* (parent of icu4c's source).
44
45Note: the ant build and makefile do not attempt to rebuild the jar. Run 'mvn package' separately if developing on the Java tool.
46