sbsv1/abld/doc/building_variants.txt
changeset 599 fa7a3cc6effd
equal deleted inserted replaced
596:9f25be3da657 599:fa7a3cc6effd
       
     1 Product Build Variants
       
     2 ======================
       
     3 
       
     4 In order to create a build variant two files are required. A "Product Variant" HRH file
       
     5 containing the variant-specific macros.  And a configuration file (variant.cfg) that points
       
     6 to it.
       
     7 
       
     8 
       
     9 1. The Product Variant (.HRH) File
       
    10 ==================================
       
    11 
       
    12 This file contains the macros to be defined for this product variant as #define statements.
       
    13 eg,
       
    14 	#define EKA2
       
    15 	#define NEW_CRYPTO
       
    16 	#undef DONT_USE_ME
       
    17 
       
    18 This file is a C++ header file, so comments are allowed.
       
    19 
       
    20 The product variant can go anywhere on the same drive as the epoc32 directory.
       
    21 Suggested location is somewhere under %EPOCROOT%\epoc32.
       
    22 e.g.:
       
    23 	\epoc32\include\variant\buildvariant.hrh
       
    24 	\epoc32\include\variant\cedar.hrh
       
    25 
       
    26 
       
    27 
       
    28 2. The Configuration File (variant.cfg)
       
    29 =======================
       
    30 
       
    31 The variant.cfg file must be called
       
    32 
       
    33 	%EPOCROOT%\epoc32\tools\variant\variant.cfg
       
    34 
       
    35 The variant folder doesn't exist by default and has to be created manually.
       
    36 This file should contain the name and path of the product variant (.HRH) file.
       
    37 The file can be specified as
       
    38 	a) a path relative to %EPOCROOT%
       
    39 	b) an absolute path
       
    40 A path starting with "\EPOC32" will be adjusted for EPOCROOT.
       
    41 
       
    42 Perl-type comments (#) are allowed.
       
    43