mksysimage.py

Create an image of the platform and generate supporting files, such as .ifs and .tar

Syntax:

 mksysimage.py  [-o output] [options]... [board_name.external]

Runs on:

Windows, Linux. Must be run using Python 2.7.5.

Options:

-c, --mksysimage-config-file
Specify the configuration file used for the mksysimage.py utility.
-f, --force
Force the overwriting of existing .tar files.
-g, --osversion-content
Specify any additional content for the os.version file.
-G, --no-gen, --no-generation
Run only mktar.py and the imaging components.
--gen-ifs-options
Specify the options for gen-ifs.py (see gen-ifs.py --help).
-h, --help
Show the help that describes how to use this command.
--image-config-path=IMAGE_CONFIG_PATH
Specify the path of the configuration files for mkimage.py.
-k MKIMAGE_OPTIONS, --mkimage-options=MKIMAGE_OPTIONS
Specify the options for mkimage.py (see mkimage.py --help).
-m MKTAR_OPTIONS, --mktar-options=MKTAR_OPTIONS
Specify the options for mktar.py (see mktar.py --help).
--no-gen-ifs
Don't generate .ifs files.
--no-mkimage
Don't run the mkimage.py part of the process.
--no-mktar
Don't run the mktar.py part of the process.
--no-gen-osversion
Don't generate an os.version file.
-o OUTPUT_PATH, --output-path=OUTPUT_PATH
Write .image and .tar files to the specified path. If the -t option is specified, the .tar files are written to that path instead.
-p, --keep-partition-images
Keep the partition images.
-P PRODUCT, --product=PRODUCT
Specify the name of the product. You can set the QNX_PRODUCT environment variable to specify the default product to use when this option isn't specified.
-q, --quiet
Prevent any output.
-Q QT_PATH, --qt=QT_PATH
Specify the location where Qt is installed on the host computer. You can set the QNX_QT environment variable to specify the default location to use when this option isn't specified.
-t, --tar-file-path
Read and write .tar files to and from the specified path.
-v, --verbose
Increase the verbosity.
-w QNX_DEPLOYMENT_WORKSPACE, --workspace=QNX_DEPLOYMENT_WORKSPACE
Specify the path to the QNX_DEPLOYMENT_WORKSPACE. This workspace is where you deployed the assets required to build the image.
You should refer to the Getting Started guide for the value of the QNX_DEPLOYMENT_WORKSPACE variable.

Description:

The mksysimage.py utility is a Python script that invokes other utilities to generate tar files and images for each platform. The script is located at $QNX_DEPLOYMENT_WORKSPACE/infra/utils/scripts. You should refer to the Getting Started guide for the value of QNX_DEPLOYMENT_WORKSPACE.

By default, mksysimage.py reads a configuration file from: $QNX_DEPLOYMENT_WORKSPACE/infra/product/AnM/boards/platform.ext/mksysimage/platform-mksysimage.cfg

This configuration file defines the tar files and images created during the image-generation process. The image variants for each platform are defined within the configuration file. By default, for each image variant, mksysimage.py generates two tar files and one image. The tar file platform-os.tar contains two QNX filesystems that include all files except MLO and IFS files. The tar file platform-dos-image_variant contains a FAT16 filesystem that includes all bootup files, such as MLO and IFS files. The final generated image includes these two tar files.

You can change the default configuration file associated with mksysimage.py. The default file is located at: $QNX_DEPLOYMENT_WORKSPACE/infra/product/AnM/boards/platform.ext/mksysimage/platform-mksysimage.cfg

You can also specify your own file by using the -c option in mksysimage.py. Setting this option will enable you to further customize your tar files and images. For more information about changing the mksysimage.py configuration, see "Configuration file for mksysimage.py" in Getting Started. If you want mksysimage.py to skip some steps of the image-generation process and generate only certain types of intermediate files, see "Troubleshooting tips" in the same guide.

Examples:

To run mksysimage.py, you need to specify the platform, its variant, and the output path.

The following example reads the default configuration file for the omap5uevm platform and creates three images and their corresponding .tar files in the specified output path called /tmp: 

$QNX_DEPLOYMENT_WORKSPACE/infra/utils/scripts/mksysimage.py 
 -o /tmp/ omap5uevm.external

Exit status:

0
The specified image file was created successfully.
>0
An error occurred.

Caveats:

None.