mirror of
https://github.com/YosysHQ/yosys
synced 2025-08-11 05:30:53 +00:00
CI: Enable source tracking for reusable build
The `test-docs-build` jobs require source tracking enabled to prevent warnings-as-errors. Also add an extra note to the readme in case users run into the same.
This commit is contained in:
parent
891a907a30
commit
ab403635e3
2 changed files with 4 additions and 1 deletions
1
.github/workflows/test-build.yml
vendored
1
.github/workflows/test-build.yml
vendored
|
@ -225,6 +225,7 @@ jobs:
|
|||
run: |
|
||||
make config-clang
|
||||
echo "ENABLE_CCACHE := 1" >> Makefile.conf
|
||||
echo "ENABLE_HELP_SOURCE := 1" >> Makefile.conf
|
||||
make -j$procs
|
||||
|
||||
- name: Install doc prereqs
|
||||
|
|
|
@ -281,4 +281,6 @@ 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.
|
||||
source files. Without this, a warning will be raised during the Sphinx build
|
||||
about `Found commands assigned to group unknown` and `make docs` is configured
|
||||
to fail on warnings by default.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue