verilator/docs
Yilou Wang 31f8be0b85
Support detailed failure info for constraint violations (#6617) (#6883)
* logging for the unsatisfied constraints

* Apply 'make format'

* fix teh quote error in the array indexing

* Apply 'make format'

* Len change for the hash for randomity when named assertion is used

* seperate name assertion and satisfied case

* Apply 'make format'

* simply comments and display info

* refine code and fix protect case

* format

* update display in test and .out file

* add an enable flag and warning type, add a protect_id version test and update out files

* Apply 'make format'

* simplify some comments

* update out file, ready to be merged.

* update .py file to set the hash key solid

* rename and reformate the warning message to follow the verilator style

* add a nowarn test

* Apply 'make format'

* ordering

---------

Co-authored-by: Udaya Raj Subedi <075bei047.udaya@pcampus.edu.np>
Co-authored-by: github action <action@example.com>
2026-01-12 15:53:49 +01:00
..
_static Fix Codacy warnings. No functional change. 2021-07-07 19:42:49 -04:00
bin Copyright year update. 2026-01-01 07:22:09 -05:00
gen Improve format of runtime errors, especially DIDNOTCONVERGE 2026-01-08 01:01:54 -05:00
guide Support detailed failure info for constraint violations (#6617) (#6883) 2026-01-12 15:53:49 +01:00
.gitignore Spelling fixes. 2022-05-14 16:12:57 -04:00
CONTRIBUTING.rst Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05:00
CONTRIBUTORS Fix missing include on FreeBSD (#6864) 2025-12-27 10:17:03 -05:00
Makefile Copyright year update. 2026-01-01 07:22:09 -05:00
README.rst Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05:00
internals.rst Copyright year update. 2026-01-01 07:22:09 -05:00
security.rst Add security policy 2025-05-16 22:08:12 -04:00
spelling.txt Commentary: Changes update 2026-01-10 04:10:35 -05:00
verilated.dox Cleanup missing copyrights and those on simply copied files. No functional change. 2023-01-20 20:42:30 -05:00
xml.rst Copyright year update. 2026-01-01 07:22:09 -05:00

README.rst

Verilator Documentation
=======================

This folder contains sources for Verilator documentation.

For formatted documentation see:

- `Verilator README <https://github.com/verilator/verilator>`_

- `Verilator installation and package directory structure
  <https://verilator.org/install>`_

- `Verilator manual (HTML) <https://verilator.org/verilator_doc.html>`_, or
  `Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>`_

- `Subscribe to Verilator announcements
  <https://github.com/verilator/verilator-announce>`_

- `Verilator forum <https://verilator.org/forum>`_

- `Verilator issues <https://verilator.org/issues>`_