3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-04-29 03:45:52 +00:00

Docs: More bugpoint bullets

More info for creating GitHub issues and the different sections.
Discuss additional details that can be included as comments on the issue.  Also mention Gists for large files (preferable to downloading a .txt).
Add a warning about external plugins/tools.
Also add a note to `load_design.rst` about `Frontend`s and `-f` command line option.
This commit is contained in:
Krystine Sherwin 2025-04-17 16:23:36 +12:00
parent 5d04baad0c
commit a461870050
No known key found for this signature in database
2 changed files with 100 additions and 6 deletions

View file

@ -498,10 +498,27 @@ Why context matters
Creating an issue on GitHub Creating an issue on GitHub
--------------------------- ---------------------------
- "Reproduction Steps" is ideally a code-block (starting and ending with triple - use the `bug report template`_
backquotes) containing the minimized design (Verilog or RTLIL), followed by a
code-block containing the minimized yosys script OR a command line call to .. _bug report template: https://github.com/YosysHQ/yosys/issues/new?template=bug_report.yml
yosys with code-formatting (starting and ending with single backquotes)
- short title briefly describing the issue, e.g.
techmap of wide mux with undefined inputs raises error during synth_xilinx
+ tells us what's happening ("raises error")
+ gives the command affected (`techmap`)
+ an overview of the input design ("wide mux with undefined inputs")
+ and some context where it was found ("during `synth_xilinx`")
Reproduction Steps
~~~~~~~~~~~~~~~~~~
- ideally a code-block (starting and ending with triple backquotes) containing
the minimized design (Verilog or RTLIL), followed by a code-block containing
the minimized yosys script OR a command line call to yosys with
code-formatting (starting and ending with single backquotes)
.. code-block:: markdown .. code-block:: markdown
@ -535,5 +552,78 @@ Creating an issue on GitHub
# minimum sequence of commands # minimum sequence of commands
``` ```
- any environment variables or command line options should also be mentioned in - any environment variables or command line options should also be mentioned
the "Reproduction Steps" - if the problem occurs for a range of values/designs, what is that range
- if you're using an external tool, such as ``valgrind``, to detect the issue,
what version of that tool are you using and what options are you giving it
.. warning::
Please try to avoid the use of any external plugins/tools in the reproduction
steps if they are not directly related to the issue being raised. This
includes frontend plugins such as GHDL or slang; use `write_rtlil` on the
minimized design instead. This also includes tools which provide a wrapper
around Yosys such as OpenLane; you should instead minimize your input and
reproduction steps to just the Yosys part.
"Expected Behaviour"
~~~~~~~~~~~~~~~~~~~~
- if you have a similar design/script that doesn't give the error, include it
here as a reference
- if the bug is that an error *should* be raised but isn't, are there any other
commands with similar error messages
"Actual Behaviour"
~~~~~~~~~~~~~~~~~~
- any error messages go here
- any details relevant to the crash that were found with ``--trace`` or
``--debug`` flags
- if you identified the point of failure in the source code, you could mention
it here, or as a comment below
+ if possible, use a permalink to the source on GitHub
+ you can browse the source repository for a certain commit with the failure
and open the source file, select the relevant lines (click on the line
number for the first relevant line, then while holding shift click on the
line number for the last relevant line), click on the `...` that appears and
select "Copy permalink"
+ should look something like
``https://github.com/YosysHQ/yosys/blob/<commit_hash>/path/to/file#L139-L147``
+ clicking on "Preview" should reveal a code block containing the lines of
source specified, with a link to the source file at the given commit
Additional details
~~~~~~~~~~~~~~~~~~
- once you have created the issue, any additional details can be added as a
comment on that issue
- could include any additional context as to what you were doing when you first
encountered the bug
- was this issue discovered through the use of a fuzzer
- if you've minimized the script, consider including the `bugpoint` script you
used, or the original script, e.g.
.. code-block:: markdown
Minimized with
```
read_verilog design.v
# original sequence of commands prior to error
bugpoint -script <failure.ys> -grep "<string>"
write_rtlil min.il
```
OR
Minimized from
`yosys -p ': original sequence of commands to produce error;' design.v`
- if you're able to, it may also help to share the original un-minimized design
+ if the design is too big for a comment, consider turning it into a `Gist`_
.. _Gist: https://gist.github.com/

View file

@ -68,6 +68,10 @@ Yosys frontends
+ executed as multiple successive calls to the frontend + executed as multiple successive calls to the frontend
- compatible with ``-f`` command line option, e.g. ``yosys -f verilog
design.txt`` will use the `read_verilog` frontend with the input file
``design.txt``
- `verific` and `read` commands are technically not 'Frontends', but their - `verific` and `read` commands are technically not 'Frontends', but their
behaviour is kept in sync behaviour is kept in sync