commands/variant/variant.cif
changeset 58 b33ec37addee
parent 49 4a2ffd3562a3
child 75 3c3961c1ae26
equal deleted inserted replaced
57:a45c6889feae 58:b33ec37addee
    18 
    18 
    19 ==long-description
    19 ==long-description
    20 
    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.
    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 
    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.
    23 In addition there are some other special variant names supported, that are derived at compile time from the platform.mmh macros and similar: run the tool with no arguments to see the full list.
    24 
    24 
    25 Example usage:
    25 Example usage:
    26 
    26 
    27     variant h4 && do-something-h4-specific
    27     variant h4 && do-something-h4-specific
    28     variant wins && do-something-emulator-specific
    28     variant wins && do-something-emulator-specific
    29     variant h4 h6 && do-something-for-h4-and-h6
    29     variant h4 h6 && do-something-for-h4-and-h6
       
    30 
       
    31 If no arguments are specified, all the supported and understood variants are listed.
    30 
    32 
    31 ==option uint u uid multiple
    33 ==option uint u uid multiple
    32 
    34 
    33 Test whether the device matches any of the specified machine UIDs.
    35 Test whether the device matches any of the specified machine UIDs.
    34 
    36 
    36 
    38 
    37 Display verbose output.
    39 Display verbose output.
    38 
    40 
    39 ==option bool l list
    41 ==option bool l list
    40 
    42 
    41 List the variant names that this command understands. Note this is all of them, not just the ones that match the current platform.
    43 Has no effect, kept for compatability.
    42 
    44 
    43 ==argument string variantname optional multiple
    45 ==argument string variantname optional multiple
    44 
    46 
    45 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.
    47 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.
    46 
    48