Посібник із використання Git з Unified Vitis IDE

Автоматизація налаштування проекту Vitis за допомогою Python

Сценарій Python для налаштування проекту Vitis та інтеграції Git

import vitis
import os

ROOT_PATH = os.path.abspath(os.path.dirname(__file__))
VITIS_BUILD_DIR_PATH = os.path.join(ROOT_PATH, "build-vitis")
os.makedirs(VITIS_BUILD_DIR_PATH, exist_ok=True)
EXPECTED_XSA_FILE_PATH = os.path.join(ROOT_PATH, "build-vivado", "mydesign.xsa")
COMPONENT_NAME = "MyComponent"
MAIN_SRC_PATH = os.path.join(ROOT_PATH, "src")

client = vitis.create_client()
client.set_workspace(path=VITIS_BUILD_DIR_PATH)

PLATFORM_NAME = "platform_baremetal"
platform = client.create_platform_component(
    name=PLATFORM_NAME,
    hw=EXPECTED_XSA_FILE_PATH,
    os="standalone",
    cpu="mycpu"
)

platform = client.get_platform_component(name=PLATFORM_NAME)
status = platform.build()

comp = client.create_app_component(
    name=COMPONENT_NAME,
    platform=os.path.join(VITIS_BUILD_DIR_PATH, PLATFORM_NAME, "export", PLATFORM_NAME, f"{PLATFORM_NAME}.xpfm"),
    domain="mydomainname"
)

comp = client.get_component(name=COMPONENT_NAME)
status = comp.import_files(
    from_loc=MAIN_SRC_PATH,
    files=["CMakeLists.txt", "UserConfig.cmake", "lscript.ld", "NOTUSED.cpp"],
    dest_dir_in_cmp="src"
)

comp.build()

Управління керуванням джерелом у проектах Vitis

Сценарій оболонки для оптимізації ініціалізації проекту Vitis і керування джерелами

#!/bin/bash

ROOT_PATH=$(pwd)
VITIS_BUILD_DIR_PATH="$ROOT_PATH/build-vitis"
mkdir -p "$VITIS_BUILD_DIR_PATH"
EXPECTED_XSA_FILE_PATH="$ROOT_PATH/build-vivado/mydesign.xsa"
COMPONENT_NAME="MyComponent"
MAIN_SRC_PATH="$ROOT_PATH/src"

vitis -s tools/build_app.py

# After running the Python script, set up Git repository
cd "$ROOT_PATH"
git init
echo "build-vitis/" >> .gitignore
echo "build-vivado/" >> .gitignore
git add src/ tools/ .gitignore
git commit -m "Initial commit with project structure and scripts"

# Script end

Поширені запитання та рішення щодо використання Git з Vitis IDE

1. Як ініціалізувати репозиторій Git для проекту Vitis?
2. Ви можете ініціалізувати репозиторій Git, перейшовши до кореня проекту та запустивши його git init. Додати необхідні файли в .gitignore щоб виключити непотрібні файли.
3. Які файли слід включити в .gitignore для проекту Vitis?
4. Включайте спеціальні папки IDE, наприклад build-vitis/ і build-vivado/ щоб уникнути автоматично створених файлів із керуванням версіями.
5. Як я можу автоматизувати налаштування проекту Vitis?
6. Використовуйте сценарій Python для автоматизації таких завдань, як створення компонентів платформи та імпорт необхідних файлів. Запустіть сценарій за допомогою vitis -s tools/build_app.py.
7. Чому мені потрібно копіювати конфігураційні файли вручну?
8. Vitis очікує, що певні конфігураційні файли будуть у певних місцях. Копіювання цих файлів вручну або за допомогою сценарію гарантує, що IDE знайде їх правильно.
9. Як працювати з папками платформи та програм у Vitis?
10. Виключіть ці папки з контролю версій і використовуйте сценарії для керування необхідними файлами, забезпечуючи послідовність і уникаючи конфліктів шляхів.
11. Чи можу я редагувати вихідні файли безпосередньо у Vitis, використовуючи Git?
12. Так, але переконайтеся, що ваші налаштування CMake вказують на правильні вихідні каталоги. Vitis може не правильно розпізнавати включення та імена для підсвічування синтаксису.
13. Які переваги використання сценаріїв для налаштування проекту?
14. Сценарії забезпечують узгоджену та повторювану настройку проекту, зменшуючи кількість помилок вручну та спрощуючи співпрацю в різних середовищах.
15. Як я можу оновити налаштування проекту, якщо внесено зміни?
16. Змініть свої сценарії автоматизації, щоб відобразити зміни, і повторно запустіть їх. Це гарантує правильне застосування всіх необхідних оновлень.
17. Що мені робити, якщо я зіткнувся з помилками збирання через проблеми зі шляхом?
18. Перевірте сценарії налаштування проекту та переконайтеся, що всі шляхи вказано правильно. Використовуйте відносні шляхи, де це можливо, щоб уникнути конфліктів.

Підсумок робочого процесу для Vitis і Git

Інтеграція Git з Unified Vitis IDE вимагає стратегічного підходу для ефективного керування версіями. Виключивши папки, якими керує Vitis, і зосередивши увагу на основних конфігураційних файлах, розробники можуть уникнути поширених пасток, пов’язаних із абсолютними шляхами та метаданими IDE. Сценарії автоматизації ще більше покращують цей процес, забезпечуючи повторюване та послідовне налаштування проекту. Ці стратегії гарантують, що проекти Vitis залишаються керованими та спільними навіть у складних середовищах розробки.