organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-07 06:25:30 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 1

ICU-9001 update docs for APIChangeReport

Browse source 
X-SVN-Rev: 31104
This commit is contained in:
Steven R. Loomis 2011-12-12 23:45:14 +00:00
parent 2a751ff4e3
commit d768d1b23c
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
tools/release/java/readme.txt
View file

@ -1,4 +1,4 @@
# Copyright (C) 2009-2010 IBM and Others. All Rights Reserved
# Copyright (C) 2009-2011 IBM and Others. All Rights Reserved
API Change Report:
@ -7,20 +7,24 @@ A tool to generate a report of API status changes between two ICU4C releases.
Requirements:
- Everything needed to build ICU4C from a command line (UNIX) environment
- Doxygen (for generating docs)
- Doxygen (for generating docs).
Doxygen 1.7.5.1 is recommended for ICU API docs,
but an older Doxygen may work for the API Change Report.
- Java JDK 1.5+
- Apache Ant
- Xalan/Xerces ( put the jars in the lib/ directory ) - the built in version to Java doesn't seem to work properly.
To use the utility:
1. setup ICU
(put the two ICU releases on your machine ^_^ )
run 'configure' in both releases (or runConfigureICU)
Doxygen must be found during configure.
2. create a Makefile.local with just these two lines:
1. Put both old and new ICU source trees on your system
2. 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.
3. create a Makefile.local in this readme's directory (tools/release/java/)
with just these two lines:
OLD_ICU=/xsrl/E/icu-1.0
NEW_ICU=/xsrl/E/icu-6.8
( where these are the paths to the parent of 'source', etc)
3. Build the API docs
If your ICU is an out-of-source-build, add these two lines
indicating the build location:
OLD_ICU_BUILD=/xsrl/E/icu-build-m48
NEW_ICU_BUILD=/xsrl/E/icu-build
4. from this directory, (tools/release/java/) run Make to build docs:
make
4. This will create an 'APIChangeReport.html' in this directory. Check it over, then check it in.
5. This will create an 'APIChangeReport.html' file in this directory. Look it over, and then check it in to ${NEW_ICU}/APIChangeReport.html (parent of icu/source).