repo - 2024.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2024-11-13
Version
2024.2 English
Get, set, or modify software repositories
Table 1. repo- Get, set, or modify software repositories
XSCT methods Arguments Corresponding Python API Arguments
-set   For example repos

add_local_example_repo

For sw repos

set_sw_repo

Required Arguments:

name = <repo_name>

The local repository name to be added. local_directory = <local_repo_directory_path> The local repository directory path.

Optional Arguments:

type = <repo_type>** The repository type.

Valid types are "SYS_PROJ" (system projects), "HLS", and "AIE". "SYS_PROJ" is the default type.

display_name = <repo_display_name>**

The repository display name.

description = <"Description of the repo">**

The description of the local repository.

Required Arguments:

level = <'LOCAL'/'GLOBAL'>

Level at which the software repo is to be set.

LOCAL - 'available to the current workspace'.

GLOBAL - 'available across workspaces'.

path = <repo_path>

Software repo path to be set. Path can be a single path or a list of paths.

-get  
  1. For example repos

    list_example_repos

  2. For sw repos

    get_sw_repo

Optional Arguments:

type = <repo_type>**

Valid types are "SYS_PROJ" (system projects) and "HLS", "AIE" and "EMBD_APP" (Embedded applications). "SYS_PROJ" is the default type.

Required Arguments:

level = <'LOCAL'/'GLOBAL'> Level of software repo.

-scan  
  1. For platform repos

    rescan_platform_repos

  2. For sw repo

    rescan_sw_repo

Required Arguments:

platform = <platform_path> User can give single platform path as string or multiple platform paths as strings list.

-os   For domain os use get_os()  
-libs   For domain libs use get_libs()  
-drivers   For domain drivers use get_drivers  
-app   For -app option dom.get_applicable_libs  
-add-platforms <platforms directory> add_platform_repos Required Arguments:

platform = <platform_path>

String/list of platform path(s).

-remove-platforms-dir <platforms directory> delete_platform_repos Required Arguments:

platform = <platform_path>

String/list of platform path(s).