Skip to content

Commit 7cdf433

Browse files
committed
[doc] clarify that clang-format is not required to build VPR
1 parent 1bd97f1 commit 7cdf433

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

doc/src/quickstart/index.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,9 @@ If you cloned the repository, you will need to set up the git submodules (if you
2424
> git submodule init
2525
> git submodule update
2626
27-
VTR requires several system and Python packages to build and run the flow.
28-
Ubuntu users can install the required system packages using the provided script or
29-
the command below. This setup works on Ubuntu 18.04, 20.04, 22.04, and 24.04, but note
30-
that some packages (such as ``clang-format-18``) are only available by default on Ubuntu 24.04.
31-
On older versions, this package will not be installed unless you manually add the appropriate
32-
LLVM APT repository.
33-
34-
To install ``clang-format-18`` on older Ubuntu versions (e.g., 20.04 or 22.04), you must add the
35-
LLVM repository manually:
27+
VTR requires several system and Python packages to build and run the flow. Ubuntu users can install the required system packages using the provided script or the command below. This setup works on Ubuntu 18.04, 20.04, 22.04, and 24.04, but note that some packages (such as ``clang-format-18``) are only available by default on Ubuntu 24.04. On older versions, this package will not be installed unless you manually add the appropriate LLVM APT repository.
28+
29+
To install ``clang-format-18`` on older Ubuntu versions (e.g., 20.04 or 22.04), you must add the LLVM repository manually. Note that this tool is only required if you want to run ``make format`` to automatically fix formatting issues in the code. It is not necessary for building or running VPR.
3630

3731
.. code-block:: bash
3832

0 commit comments

Comments
 (0)