Skip to content

Utility script to add xitem entry in store catalog file

saikrishnamaddali edited this page May 15, 2019 · 13 revisions

Description

The utility script adds xitem entry for new board in to store catalog database file. The script parses the xitem json file of new board and extracts the mandatory fields of board, adds board entry in the board store catalog file

The properties of xitem along with their direct mapping xitem fields in board store catalog file are as follows.

property of xitem in board store catalog file xitem property in xitem json file
name name attribute in xitem json
display display attribute in xitem json
company company attribute in xitem json
revision revision tag

The following fields for xitem entry are taken from user :

property of xitem in board store catalog file xitem Usage
commit_id Commit-id of the xitem file when it is submitted in github
history Description of the newly added board

Commands :

python add_xitem_entry.py --help (To get the details of arguements for script) `

python add_xitem_entry.py --store_dir <store_root_dir_path> --xitem_file <xitem_json_path> --description <description> --product <tool_name (Vivado/sdx)> --version <tool_version> --mark_latest <True/False , to mark this xitem as latest revision>

Note:

Please use the utility script in master branch.

Version:

Python Version Supported: 3.3.x

Store catalog version Supported: 2.0

Xitem.json Schema version : 1.0