Skip to content

Docs: Add bugpoint guide #5139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
b960d98
Docs: Initial outline of minimizing designs
KrystalDelusion Mar 11, 2025
b986180
docs: Outline loading a design page
KrystalDelusion Mar 13, 2025
c705193
Docs: Bugpoint fixups from JF
KrystalDelusion Mar 18, 2025
830605d
Docs: Tidying
KrystalDelusion Mar 19, 2025
57e6b9c
docs: Some extra bugpoint bullets
KrystalDelusion Mar 20, 2025
bb0606b
docs: Minimizing synth with -run bullets
KrystalDelusion Mar 20, 2025
2b84005
docs: Bullets for identifying issues
KrystalDelusion Mar 21, 2025
7b7d901
Docs: Move verilog.rst to using_yosys
KrystalDelusion Mar 22, 2025
3e6884c
docs: User-defined failures in bugpoint
KrystalDelusion Mar 22, 2025
1eea1be
Docs: What is bugpoint in paragraphs
KrystalDelusion Mar 24, 2025
72dd57e
Docs: How to use bugpoint paragraphs
KrystalDelusion Mar 25, 2025
cb1fa66
bugpoint.rst: Why context matters (bullets)
KrystalDelusion Apr 4, 2025
d94c821
bugpoint.rst: More paragraphs
KrystalDelusion Apr 17, 2025
3db588a
Docs: More bugpoint bullets
KrystalDelusion Apr 17, 2025
bbc954c
bugpoint.rst: yosys -h bugpoint does work
KrystalDelusion Apr 26, 2025
4c95e69
bugpoint.rst: Minimizing scripts
KrystalDelusion Apr 27, 2025
b23a081
bugpoint.rst: Extra notes
KrystalDelusion Apr 28, 2025
8ba612b
docs: Shuffling bug reporting guidelines
KrystalDelusion Apr 28, 2025
6e2695a
docs: Split bugpoint.rst into user/developer
KrystalDelusion Apr 29, 2025
8a5e00a
bugpoint.rst: Some paragraphs on verilog
KrystalDelusion Apr 30, 2025
1b3566a
bugpoint.rst: Finish paragraphs
KrystalDelusion May 16, 2025
a9d4579
advanced_bugpoint.rst: Paragraphing
KrystalDelusion May 16, 2025
f8cc37d
bugpoint.rst: How to creduce
KrystalDelusion Jun 14, 2025
d5e48ce
bugpoint.rst: How to sv-bugpoint
KrystalDelusion Jun 14, 2025
3d9fcea
advanced_bugpoint.rst: --dump-design
KrystalDelusion Jun 14, 2025
0425310
bugpoint.rst: Expand note on checking errors
KrystalDelusion Jun 14, 2025
ea86ef9
docs: Fix formatting
KrystalDelusion Jun 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ much easier for someone to respond and help.

### Bug reports

Before you submit an issue, please have a search of the existing issues in case
one already exists. Making sure that you have a minimal, complete and
verifiable example (MVCE) is a great way to quickly check an existing issue
against a new one. Stack overflow has a guide on [how to create an
MVCE](https://stackoverflow.com/help/minimal-reproducible-example). The
[`bugpoint`
command](https://yosyshq.readthedocs.io/projects/yosys/en/latest/cmd/bugpoint.html)
in Yosys can be helpful for this process.
Before you submit an issue, please check out the [how-to guide for
`bugpoint`](https://yosys.readthedocs.io/en/latest/using_yosys/bugpoint.html).
This guide will take you through the process of using the [`bugpoint`
command](https://yosys.readthedocs.io/en/latest/cmd/bugpoint.html) in Yosys to
produce a [minimal, complete and verifiable
example](https://stackoverflow.com/help/minimal-reproducible-example) (MVCE).
Providing an MVCE with your bug report drastically increases the likelihood that
someone will be able to help resolve your issue.


# Using pull requests
Expand Down
2 changes: 0 additions & 2 deletions docs/source/cmd_ref.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _cmd_ref:

================================================================================
Command line reference
================================================================================
Expand Down
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@

# Ensure that autosectionlabel will produce unique names
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 1

# include todos for previews
extensions.append('sphinx.ext.todo')
Expand Down
9 changes: 8 additions & 1 deletion docs/source/getting_started/scripting_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of the comment is a semicolon ``;`` or a new line.
.. code-block::
:caption: Using the ``-p`` option

$ yosys -p "read_verilog fifo.v; :this is a comment; prep"
$ yosys -p 'read_verilog fifo.v; :this is a comment; prep'

.. warning::

Expand All @@ -42,6 +42,13 @@ will be raised by Yosys. `exec` provides a much more flexible way of executing
commands, allowing the output to be logged and more control over when to
generate errors.

.. warning::

Take care when using the ``yosys -p`` option. Some shells such as bash will
perform substitution options inside of a double quoted string, such as ``!``
for history substitution and ``$`` for variable substitution; single quotes
should be used instead to pass the string to Yosys without substitution.

The synthesis starter script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading
Loading