sbsv1/abld/doc/building_variants.txt
author Bob Rosenberg <bob.rosenberg@nokia.com>
Mon, 20 Sep 2010 10:55:43 +0100
changeset 658 cab9da9b71bb
parent 599 fa7a3cc6effd
permissions -rw-r--r--
Test and fail for badly invalid unit elements when joining
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
599
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     1
Product Build Variants
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     2
======================
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     3
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     4
In order to create a build variant two files are required. A "Product Variant" HRH file
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     5
containing the variant-specific macros.  And a configuration file (variant.cfg) that points
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     6
to it.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     7
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     8
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
     9
1. The Product Variant (.HRH) File
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    10
==================================
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    11
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    12
This file contains the macros to be defined for this product variant as #define statements.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    13
eg,
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    14
	#define EKA2
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    15
	#define NEW_CRYPTO
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    16
	#undef DONT_USE_ME
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    17
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    18
This file is a C++ header file, so comments are allowed.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    19
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    20
The product variant can go anywhere on the same drive as the epoc32 directory.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    21
Suggested location is somewhere under %EPOCROOT%\epoc32.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    22
e.g.:
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    23
	\epoc32\include\variant\buildvariant.hrh
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    24
	\epoc32\include\variant\cedar.hrh
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    25
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    26
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    27
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    28
2. The Configuration File (variant.cfg)
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    29
=======================
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    30
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    31
The variant.cfg file must be called
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    32
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    33
	%EPOCROOT%\epoc32\tools\variant\variant.cfg
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    34
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    35
The variant folder doesn't exist by default and has to be created manually.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    36
This file should contain the name and path of the product variant (.HRH) file.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    37
The file can be specified as
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    38
	a) a path relative to %EPOCROOT%
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    39
	b) an absolute path
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    40
A path starting with "\EPOC32" will be adjusted for EPOCROOT.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    41
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    42
Perl-type comments (#) are allowed.
fa7a3cc6effd Add sbsv1 to new structure
jjkang
parents:
diff changeset
    43