Intel® Quartus® Prime Pro Edition User Guide: Platform Designer

ID 683609
Date 4/03/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

8.5. Create an .ipx File with ip-make-ipx

The ip-make-ipx command creates an .ipx index file. This file provides a convenient way to include a collection of IP components from an arbitrary directory. You can edit the .ipx file to disable visibility of one or more IP components in the IP Catalog.

You can use the following options with the ip-make-ipx utility:

Table 202.  ip-make-ipx Command-Line Options
Option Usage Description
--source-directory=<directory> Optional

Specifies the directory containing your IP components. The default directory is ‘.’. You can provide a comma-separated list of directories.

--output=<file> Optional

Specifies the name of the index file to generate. The default name is /component.ipx. Set as --output=<""> to print the output to the console.

--relative-vars=<value> Optional

Causes the output file to include references relative to the specified variable or variables wherever possible. You can specify multiple variables as a comma-separated list.

--thorough-descent Optional

If you set this option, Platform Designer searches all the component files, without skipping the sub-directories.

--message-before=<value> Optional

Prints a log message at the start of reading an index file.

--message-after=<value> Optional

Prints a log message at the end of reading an index file.

--jvm-max-heap-size=<value> Optional

The maximum memory size Platform Designer uses when running ipr-make-ipx. You specify this value as <size><unit>, where unit is m (or M) for multiples of megabytes, or g (or G) for multiples of gigabytes. The default value is 512m.

--help Optional

Displays help for the ip-make-ipx command.