FAQ

1. How to resolve merge conflicts when raising a Pull Request?

Please refer to the official GitHub documentation for guidance on resolving merge conflicts: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github

2. Where to find more information on Board Files and xml tags supported by VIVADO?

Information Related to Board files is available in AMD official Documentation - Vivado Design Suite User Guide: System-Level Design Entry (UG895) https://docs.amd.com/r/en-US/ug895-vivado-system-level-design-entry/Board-File

3. How to run Board linters locally before making a Pull request?

Information related to board linter usage is available in the AMD official documentation at the following link: https://docs.amd.com/r/en-US/ug895-vivado-system-level-design-entry/Steps-to-Use-Board-File-Linter

4. How to validate xitem.json?

The xitem.json can be validated using the following online utility: https://jsonlint.com/

5. What are some recommended tests to be performed by board file contributor when raising a pull request?

To reduce pull request (PR) merge turnaround time, board file contributors are strongly encouraged to perform the following validations before raising a PR:

• Verify the board.xml, part0_pins.xml, and preset.xml files using the Board File Linter.
• Validate the xitem.json file using a JSON linter utility.
• It is recommended to use the Python script referenced in the wiki documentation to accurately generate and validate the xitem.json file.

6. Where can I find a reference folder to create board files?

A reference example of the board file folder structure is available in the Xilinx Board Store repository at the following location: https://github.com/Xilinx/XilinxBoardStore/tree/2018.1-dev/boards/example_vendor/example_board