1 # variant.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name variant

    14 

    15 ==short-description

    16 

    17 Determines the hardware variant and whether or not that matches the variant specified via the command line.

    18 

    19 ==long-description

    20 

    21 If the device matches the given command line options, KErrNone is returned. If not, KErrNotSupported is returned. Note that the command will not print any error message in the case of the variant not being supported, so that it doesn't make script output untidy. If an error message is required, use the C<--verbose> option.

    22 

    23 In addition there are two special variants understood by all implementations of this command: C<wins> and C<target> for WINS[CW] emulator and non-emulator platforms respectively.

    24 

    25 Example usage:

    26 

    27     variant h4 && do-something-h4-specific

    28     variant wins && do-something-emulator-specific

    29     variant h4 h6 && do-something-for-h4-and-h6

    30 

    31 ==option uint u uid multiple

    32 

    33 Test whether the device matches any of the specified machine UIDs.

    34 

    35 ==option bool v verbose

    36 

    37 Display verbose output.

    38 

    39 ==argument string variantname optional multiple

    40 

    41 A symbolic name for the hardware variant may be specified instead of having to know the machine uid. This maximises compatibility with platforms that provide a custom variant.exe and/or that need more than just the machine UID to determine the variant. Check the platform-specific documentation for what variant string is used to identify that platform's hardware. If multiple variant names are specified KErrNone is returned if any one of them matches.

    42 

    43 ==copyright

    44 

    45 Copyright (c) 2008-2010 Accenture. All rights reserved.

    46