Source: yosys
@DanielG FYI for building docs with Yosys >= v`0.56` since IIRC you're building
Debian release with docs included. This PR (re-)introduces changes to how the
command reference is formatted (currently live on the [latest
docs](https://yosyshq.readthedocs.io/projects/yosys/en/latest/cmd/index_passes.html)).
From the readme:
> It is recommended to use the `ENABLE_HELP_SOURCE` make option for Yosys
> builds that will be used to build the documentation. This option enables
> source location tracking for passes and improves the command reference
> through grouping related commands and allowing for the documentation to link
> to the corresponding source files.
The fallback behaviour without this make option set is that none of the passes
will have the "Help text automatically generated from ..." note, and that
*most* of them will end up in the "unknown" group (rendered on
`cmd/index_other`). Command groups with no associated passes (currently
`cmd/index_passes_{hierarchy,techmap,sat}`) will display a warning like this:
<img width="768" height="181" alt="image"
src="https://github.com/user-attachments/assets/1208fe9e-2455-4f64-8ed7-c1e64040fd2d";
/>
It should still be usable, but may be confusing.
Note that the `ENABLE_HELP_SOURCE` option does still require a compiler with
`source_location` support, but it tries both `<source_location>` and
`<experimental/source_location>` so a reasonably modern gcc/clang should work
fine.
--
Reply to this email directly or view it on GitHub:
https://github.com/YosysHQ/yosys/pull/5255#issuecomment-3157387088
You are receiving this because you were mentioned.
Message ID: <YosysHQ/yosys/pull/5255/[email protected]>
