Skip to content

docs/build_tb: Updated export variables based on Vivado/Vitis version #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2025
Merged

docs/build_tb: Updated export variables based on Vivado/Vitis version #256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion docs/user_guide/build_tb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ You may also do this manually (for better or worse); the following snippet is
from a **.bashrc** file. Please note that unless you are an expert at manipulating
these things, it is best to leave it to the tools to set up the environment.

For Vivado versions of 2025 and later, use the following command:

.. shell::

$export PATH=$PATH:/opt/Xilinx/202x.x/Vivado/bin:/opt/Xilinx/202x.x/Vitis/bin

For Vivado versions prior to 2025, use the following command:

.. shell::

$export PATH=$PATH:/opt/Xilinx/Vivado/202x.x/bin:/opt/Xilinx/Vitis/202x.x/bin
Expand All @@ -89,6 +97,14 @@ The best option on Windows is to use
``make`` and ``git`` packages. You should do changes to your **.bashrc** in a
similar manner to the Linux environment.

For Vivado versions of 2025 and later, use the following command:

.. shell::

$export PATH=$PATH:/cygdrive/d/Xilinx/202x.x/Vivado/bin:/cygdrive/d/Xilinx/202x.x/Vitis/bin

For Vivado versions prior to 2025, use the following command:

.. shell::

$export PATH=$PATH:/cygdrive/d/Xilinx/Vivado/202x.x/bin:/cygdrive/d/Xilinx/Vitis/202x.x/bin
Expand All @@ -97,6 +113,14 @@ A very good alternative to Cygwin is
`WSL <https://learn.microsoft.com/en-us/windows/wsl/install/>`__. The
manual changes to your **.bashrc** should look like:

For Vivado versions of 2025 and later, use the following command:

.. shell::

$export PATH=$PATH:/opt/path_to/202x.x/Vivado/bin:/opt/202x.x/Vitis/bin

For Vivado versions prior to 2025, use the following command:

.. shell::

$export PATH=$PATH:/opt/path_to/Vivado/202x.x/bin:/opt/Vitis/202x.x/bin
Expand All @@ -108,7 +132,8 @@ variations** installed by the tools itself.

Some of these may not be fully functional with our scripts and/or projects.
If you are an AMD user, use the **gnuwin** installed as part of the SDK,
usually at ``C:\Xilinx\Vitis\202x.x\gnuwin\bin``.
usually at ``C:\Xilinx\202x.x\Vitis\gnuwin\bin`` for Vitis versions of 2025 and
later, or ``C:\Xilinx\Vitis\202x.x\gnuwin\bin`` for prior versions.

Repository path setup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down