luke/yosys
1
0
Fork 0
mirror of https://github.com/YosysHQ/yosys.git synced 2026-10-06 01:53:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6226 from YosysHQ/krys/contributing_formatting

Browse Source 
contributing.rst: Fixing up formatting
This commit is contained in:
N. Engelhardt
2026-09-21 08:33:10 +00:00
committed by GitHub
parent 2d2f2cfede 1cf1c5f02d
commit 950ac95e85
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/yosys_internals/extending_yosys/contributing.rst
+8 -8
View File
@@ -25,10 +25,10 @@ briefly describe the issue, for example:
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`")
+ 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
@@ -67,10 +67,8 @@ code-formatting (starting and ending with single backquotes).
`yosys -p ': minimum sequence of commands;' min.v`
Alternatively, you can provide a single code-block which includes the minimized
design as a "here document" followed by the sequence of commands which
reproduce the error
+ see :doc:`/using_yosys/more_scripting/load_design` for more on heredocs.
design as a "here document" followed by the sequence of commands which reproduce
the error:
.. code-block:: markdown
@@ -81,6 +79,8 @@ reproduce the error
# minimum sequence of commands
```
.. seealso:: See :doc:`/using_yosys/more_scripting/load_design` for more on heredocs.
Don't forget to mention:
- any important environment variables or command line options