How to use MigrationCheck

The MigrationCheck tool allows you to determine which APIs need to be migrated when upgrading your program to a later Symbian OS version.

When running MigrationCheck you need to define the following:

• The program binaries to be migrated.

• The GenerateLibDB output, or a Symbian OS platform, or a Symbian OS release directory.

  NOTE: The Symbian OS release directory should correspond to the version you are migrating from (i.e. the version your program binaries are built against).

• The Migration Guide Index. This lists the affected APIs when migrating from one particular Symbian OS version to another. The Migration Guide Indices are available in the following locations:

  • 6.1 to 7.0s migration -

    <EPOCOOT>\documentation\developerlibrary\doc_source\migration\61_70s\migindex7.0s.mig

  • 7.0s to 8.0a migration -

    excluding version 8 features that were backported to 7.0s:

    <EPOCOOT>\documentation\developerlibrary\doc_source\migration\70s_80a\migindex8.0a.mig

    including version 8 features that were backported to 7.0s:

    <EPOCOOT>\documentation\developerlibrary\doc_source\migration\70s_80a\migindex8.0a-7.0slatest.mig

  • 8.1a to 9.1 migration

    <EPOCOOT>\documentation\developerlibrary\doc_source\migration\81a_91\migindex81a-91.mig

  • 8.1b to 9.2 migration

    <EPOCOOT>\documentation\developerlibrary\doc_source\migration\81b_92\migindex81b-92.mig

• The Symbian OS Library, supplied with the Symbian OS release that you are migrating to.

The MigrationCheck tool checks your specified binaries against the Migration Guide Index and a report is produced in HTML format, displaying all the modified APIs that need to be migrated. For each API listed a hyperlink to the relevant section in the Migration Guide section of the Symbian OS Library is also displayed.

NOTE:You can open the HTML report in Excel for easier data manipulation.

The command line syntax used for MigrationCheck is shown below:

>MigrationCheck.pl -i <XML file> -d <CHM file> -b <binary file> B <text file> [-libdb <test file> | -p <platform> | -r <directory>] -R <HTMLreport>

The following arguments are used with the MigrationCheck tool.

-i <XML file> Defines the name and location of the Migration Guide Index. For example, <EPOCOOT>\documentation\developerlibrary\doc_source\migration\81a_91\migindex81a-91.mig. -d <CHM file> Defines the name and location of the Symbian OS Library .chm file (HTML Help format). -b <binary file> Defines the name and location of the Symbian OS binary files to be checked (one or more binary files can be entered). -B <text file> Defines the name and location of a text file containing a list of all the Symbian OS binary files to be checked (one binary file per line). -libdb <test file> The name and location of the output file generated by GenerateLibDB, used for extracting library symbols. This argument is optional. if it is not used, library data is generated by MigrationCheck, and the -p or -r option must be specified. -p <platform> Specifies the Symbian OS platform to be used, for example ARM4, ARMv5, ARMi, Thumb, and so on. The default is ARM4. This is optional, and only needs to be used when the -libdb option is not specified. -r <directory> Specifies the full path of the release directory where the libraries are stored. For example, epoc32/release/arm4/urel. This is optional, and only needs to be used when the -libdb or -p option is not specified. -R <HTMLreport> Defines the name and location of the HTML report displaying the results. The default is MigrationCheckReport.html, located in the current working directory. The report shows the APIs in need of migration and provides a link to the migration information available in the Migration Guide within the Symbian OS Library. -h Displays help information (optional).

A full example of using MigrationCheck is shown below:

>MigrationCheck.pl -i migration_guide_index_70s80.xml -d 80_devlib.chm -b myBinary.exe -libdb SymLibDB.dat -R myReport.html

• Introduction to MigrationCheck

• How to use GenerateLibDB