3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2026-06-06 00:50:57 +00:00

docs: Resolving todos

Make explicit the location for the `CMakeUserPresets.json` file.
Update docs tests documentation.
Move `BUILD_DIR` and `PROGRAM_PREFIX` comments into the functional tests todo.
Add cmake to MacPorts/FreeBSD install instructions.
Add ccache to example `CMakeUserPresets.json` (it isn't otherwise documented, and is no longer as obvious without an `ENABLE_CCACHE` makevar).

Addressing comments
This commit is contained in:
Krystine Sherwin 2026-06-03 17:30:38 +12:00
parent e1931596ae
commit 72f5836fb1
No known key found for this signature in database
7 changed files with 55 additions and 98 deletions

View file

@ -18,7 +18,7 @@ custom passes written in C++.
.. note::
It is recommended to install ``uv`` for managing python environments:
It is recommended to install :program:`uv` for managing python environments:
.. code:: console
@ -30,10 +30,6 @@ Getting Pyosys
Pyosys supports CPython 3.8 or higher. You can access Pyosys using one of two
methods:
.. TODO:: CMAKE_TODO
may still be pending further changes
1. Compiling Yosys with the CMake flag ``-DYOSYS_WITH_PYTHON=ON``
This adds the flag ``-y`` to the Yosys binary, which allows you to execute
@ -42,9 +38,9 @@ methods:
``yosys -y ./my_pyosys_script.py``
Do note this requires some build-time dependencies to be available to Python,
namely, ``pybind11`` and ``cxxheaderparser``. If available, ``uv`` will be
used to create an ephemeral environment with the correct versions of the
tools installed.
namely, ``pybind11`` and ``cxxheaderparser``. :program:`uv` may be used to
create an ephemeral environment with the correct versions of the tools
installed if the current python environment doesn't provide them.
2. Installing the Pyosys wheels