sbsv1_os/e32toolp/docs/building_variants.txt
author Ross Qin <ross.qin@nokia.com>
Thu, 30 Sep 2010 14:38:30 +0800
branchRCL_3
changeset 73 22bdd8a90cc4
permissions -rw-r--r--
synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
73
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     1
Product Build Variants
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     2
======================
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     3
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     4
In order to create a build variant two files are required. A "Product Variant" HRH file
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     5
containing the variant-specific macros.  And a configuration file (variant.cfg) that points
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     6
to it.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     7
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     8
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
     9
1. The Product Variant (.HRH) File
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    10
==================================
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    11
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    12
This file contains the macros to be defined for this product variant as #define statements.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    13
eg,
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    14
	#define EKA2
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    15
	#define NEW_CRYPTO
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    16
	#undef DONT_USE_ME
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    17
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    18
This file is a C++ header file, so comments are allowed.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    19
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    20
The product variant can go anywhere on the same drive as the epoc32 directory.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    21
Suggested location is somewhere under %EPOCROOT%\epoc32.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    22
e.g.:
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    23
	\epoc32\include\variant\buildvariant.hrh
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    24
	\epoc32\include\variant\cedar.hrh
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    25
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    26
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    27
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    28
2. The Configuration File (variant.cfg)
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    29
=======================
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    30
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    31
The variant.cfg file must be called
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    32
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    33
	%EPOCROOT%\epoc32\tools\variant\variant.cfg
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    34
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    35
The variant folder doesn't exist by default and has to be created manually.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    36
This file should contain the name and path of the product variant (.HRH) file.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    37
The file can be specified as
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    38
	a) a path relative to %EPOCROOT%
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    39
	b) an absolute path
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    40
A path starting with "\EPOC32" will be adjusted for EPOCROOT.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    41
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    42
Perl-type comments (#) are allowed.
22bdd8a90cc4 synchronize from nokia internal Synergy depository buildtools/92, including fix to bugs 151,468,2049,1371,325,2539, etc.
Ross Qin <ross.qin@nokia.com>
parents:
diff changeset
    43