Bug#1068174: yosys: Please package the latest upstream release

Fri Mar 14 20:10:38 GMT 2025

Hi Scott,
Hi ∀¬Scott,

tl;dr: yosys packaging still has issues in the docs build. Python/sphinx
help wanted :-).

On Mon, Feb 10, 2025 at 01:04:01AM +0100, Daniel Gröber wrote:
> I'm also working my way through the copyright review. I think 48k was
> underestimating the amount of code added since you didn't import the abc
> component properly, so now I'm looking at 145k LoC
> 
>     1321 files changed, 145055 insertions(+), 28546 deletions(-)

Finally got around to finishing the 0.49 copyright review. It's all on on
salsa. Now in electronics-team FYI.

> 25% in and I already found a DFSG problem: abc/test.ps so now I have to
> update d/copyright to add that to Files-Excluded and re-do the gbp import
> and rebase again gah.

That turned out to be the only real problem. Everything else was just new
copyright notices.

So when properly done the output looks like
https://salsa.debian.org/electronics-team/yosys/-/commit/c723cde3b43ae251e3422a7e52e86d8be38eb4f8

It technically doesn't have to be quite as precise as I usually make it:
noting down exactly which files have which license, but it's preferred.

> I'm kind of burned out on this gbp friction tbh. No clue how other DDs
> put up with this I'm probably doing something (everything?) wrong. Oh
> well.

So what ends up having to happen here is resetting master, upstream and
pristine-tar to the old 0.33 state and deleting the upstream/0.49 tag. I
just did that in magit so I don't have a nice transcript but it's pretty
obvious when you know all the places to fiddle with.

Next challange: repacking the abc component tarball due to the test.ps
blob.

The incantation that ended up working was

    $ mk-origtargz --component abc --compression gzip -v 0.49 ../yosys-abc-0.49.tar.gz

Unlike gbp import-orig mk-origtargz doesn't do all components at once but
you have to do them one at a time. I found that mildly surprising.

The reason I need --compression gzip is that it seems to default to xz and
gbp in it's infinite wisdom doesn't have an option to specify component
tarballs explicitly but rather assumes the compression must SURELY match
and just searches for $pkg_$ver.orig-$component.tar.pkg_compression. UGH!

This right here is the friction I'm talking about... :-)

Anyway. That done we can import that back into gbp. The yosys tarball
didn't change so I just did:

    $ gbp import-orig --component=abc ../yosys_0.49.orig.tar.gz

After that re-applying your commits using git-format-patch+git-am cause I
was too lazy to try and fail twice at constructing the right rebase call
;-).

Now when I build in sbuild I still get a number of failures. For one
Makefile's rsync dependency isn't declared. Easy fix already done. This
type of thing is why we usually build with some kind of isolated builder
and not using debuild/dpkg-buildpackage directly on our workstation.

Then build-indep breaks because of python problems:

```
./yosys-smtbmc --help > docs/source/generated/yosys-smtbmc
Traceback (most recent call last):
  File "/build/yosys-ghivvZ/yosys-0.49/./yosys-smtbmc", line 22, in <module>
    from smtio import SmtIo, SmtOpts, MkVcd
ModuleNotFoundError: No module named 'smtio'
make: *** [Makefile:1034: docs/source/generated/yosys-smtbmc] Error 1
dh_auto_build: error: make -j1 "INSTALL=install --strip-program=true" docs DOC_TARGET=latexpdf -j1 returned exit code 2
```

My guess is backends/smt2/Makefile.inc needs some new
fiddling. cf. debian/patches/0010-Fix-adding-of-sys.path-in-yosys-smtbmc.patch.

Also: ModuleNotFoundError: No module named 'click'. We probably just need
python3-click in Build-Depends-Indep.

I also found that manually running `dh_auto_build -- docs
DOC_TARGET=latexpdf` inside my sbuild --anything-failed-commands
'%SBUILD_SHELL' shell that just running it again lets the build progress
further despite the errors. No good. Upstream forgot to invalidate the
generated --help output files if the process fails. Another patch for the
stack:

-	-$(Q) ./$(PROGRAM_PREFIX)$(1) --help 2> $$@
+	-$(Q) ./$(PROGRAM_PREFIX)$(1) --help 2> $$@ || rm $$@

The `|| rm $@` pattern is something more people should commit to memory
:-).

Finally sphinx complains:

    build finished with problems, 89 warnings (with warnings treated as errors).

Bah!

/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:131: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/addr_gen_hier.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:154: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/addr_gen_proc.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:174: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/addr_gen_clean.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:259: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_proc.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:305: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_flat.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:390: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_adffe.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:429: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_wreduce.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:451: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_memrdv2.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:536: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_alumacc.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:554: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_coarse.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:605: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_map_ram.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:647: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_map_ffram.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:682: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_map_gates.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:711: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_map_ffs.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:736: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_map_luts.*
/<<PKGBUILDDIR>>/docs/source/getting_started/example_synth.rst:753: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/rdata_map_cells.*
/<<PKGBUILDDIR>>/docs/source/getting_started/scripting_intro.rst:139: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/addr_gen_show.*
/<<PKGBUILDDIR>>/docs/source/getting_started/scripting_intro.rst:189: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/new_cells_show.*
/<<PKGBUILDDIR>>/docs/source/getting_started/scripting_intro.rst:204: WARNING: a suitable image for latex builder not found: _images/code_examples/fifo/addr_gen_hier.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/proc.rst:44: WARNING: a suitable image for latex builder not found: _images/code_examples/synth_flow/proc_01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/proc.rst:47: WARNING: a suitable image for latex builder not found: _images/code_examples/synth_flow/proc_02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/proc.rst:58: WARNING: a suitable image for latex builder not found: _images/code_examples/synth_flow/proc_03.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/memory.rst:41: WARNING: a suitable image for latex builder not found: _images/code_examples/synth_flow/memory_01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/memory.rst:52: WARNING: a suitable image for latex builder not found: _images/code_examples/synth_flow/memory_02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/opt.rst:90: WARNING: a suitable image for latex builder not found: _images/code_examples/opt/opt_expr.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/opt.rst:113: WARNING: a suitable image for latex builder not found: _images/code_examples/opt/opt_merge.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/opt.rst:135: WARNING: a suitable image for latex builder not found: _images/code_examples/opt/opt_muxtree.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/opt.rst:174: WARNING: a suitable image for latex builder not found: _images/code_examples/opt/opt_share.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:25: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_simple_test_00a.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:34: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_simple_test_00b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:51: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_simple_test_01a.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:54: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_simple_test_01b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:61: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_simple_test_02a.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:64: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_simple_test_02b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:151: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test1a.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:154: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test1b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:162: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2a.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:165: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:170: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test1b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:178: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test1c.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:183: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2b.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:191: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2c.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:196: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test1c.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:204: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test1d.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:209: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2c.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:217: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2d.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:222: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2d.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/extract.rst:230: WARNING: a suitable image for latex builder not found: _images/code_examples/macc/macc_xilinx_test2e.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/cell_libs.rst:53: WARNING: a suitable image for latex builder not found: _images/code_examples/intro/counter_00.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/cell_libs.rst:68: WARNING: a suitable image for latex builder not found: _images/code_examples/intro/counter_01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/cell_libs.rst:82: WARNING: a suitable image for latex builder not found: _images/code_examples/intro/counter_02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/synthesis/cell_libs.rst:115: WARNING: a suitable image for latex builder not found: _images/code_examples/intro/counter_03.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:162: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/sumprod_00.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:179: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/sumprod_01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:202: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/sumprod_02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:207: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/sumprod_03.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:212: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/sumprod_04.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:217: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/sumprod_05.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:282: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_00.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:293: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:305: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:319: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_03.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:330: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_05.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:342: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_04.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/selections.rst:419: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/select.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:57: WARNING: a suitable image for latex builder not found: _images/code_examples/show/example_first.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:89: WARNING: a suitable image for latex builder not found: _images/code_examples/show/example_second.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:111: WARNING: a suitable image for latex builder not found: _images/code_examples/show/example_third.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:138: WARNING: a suitable image for latex builder not found: _images/code_examples/show/splice.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:166: WARNING: a suitable image for latex builder not found: _images/code_examples/show/cmos_00.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:186: WARNING: a suitable image for latex builder not found: _images/code_examples/show/cmos_01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:355: WARNING: a suitable image for latex builder not found: _images/code_examples/scrambler/scrambler_p01.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:358: WARNING: a suitable image for latex builder not found: _images/code_examples/scrambler/scrambler_p02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:439: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/memdemo_00.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:460: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/submod_02.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:465: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/submod_03.*
/<<PKGBUILDDIR>>/docs/source/using_yosys/more_scripting/interactive_investigation.rst:471: WARNING: a suitable image for latex builder not found: _images/code_examples/selections/submod_01.*
/<<PKGBUILDDIR>>/docs/source/yosys_internals/extending_yosys/extensions.rst:137: WARNING: a suitable image for latex builder not found: _images/code_examples/extensions/test1.*
/<<PKGBUILDDIR>>/docs/source/yosys_internals/techmap.rst:36: WARNING: a suitable image for latex builder not found: _images/code_examples/techmap/red_or3x1.*
/<<PKGBUILDDIR>>/docs/source/yosys_internals/techmap.rst:63: WARNING: a suitable image for latex builder not found: _images/code_examples/techmap/sym_mul.*
/<<PKGBUILDDIR>>/docs/source/yosys_internals/techmap.rst:102: WARNING: a suitable image for latex builder not found: _images/code_examples/techmap/mymul.*
/<<PKGBUILDDIR>>/docs/source/yosys_internals/techmap.rst:132: WARNING: a suitable image for latex builder not found: _images/code_examples/techmap/mulshift.*
/<<PKGBUILDDIR>>/docs/source/yosys_internals/techmap.rst:164: WARNING: a suitable image for latex builder not found: _images/code_examples/techmap/addshift.*

I don't feel like figuring those out. If someone wants to have a look that
would be appreciated!

Worst case we can just disable the whole "warnings treated as errors"
thing.

--Daniel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/debian-science-maintainers/attachments/20250314/8366e13a/attachment-0001.sig>