verilator/docs
Geza Lore 2daa09a255
Optimize constify within Expand and Subst (#6111)
These passes blow up the Ast size on some designs, so delaying running V3Const
until after the whole pass can notably increase peak memory usage. In this
patch we apply V3Const per CFunc within these passes, which saves on memory.
Added -fno-const-eager to disable the intra-pass V3Const application, for
debugging.
2025-06-23 17:58:26 -04:00
..
_static Fix Codacy warnings. No functional change. 2021-07-07 19:42:49 -04:00
bin Copyright year update. 2025-01-01 08:30:25 -05:00
gen Disable symbol from parser: Support redeclaring type as non-type; major parsing change (#2412). 2025-05-18 07:13:37 -04:00
guide Optimize constify within Expand and Subst (#6111) 2025-06-23 17:58:26 -04:00
.gitignore Spelling fixes. 2022-05-14 16:12:57 -04:00
CONTRIBUTING.rst Commentary 2025-02-15 00:58:14 -05:00
CONTRIBUTORS Add hint of the signed rhsval in oversized replication error (#6098) 2025-06-17 16:59:18 -07:00
Makefile Cleanup some missed `make clean` files 2025-03-30 11:02:05 -04:00
README.rst Commentary: add docs/README.rst 2023-11-11 17:19:27 -05:00
internals.rst Add RTLMeter badge and note in internals docs (#6095) 2025-06-16 16:35:31 +01:00
security.rst Add security policy 2025-05-16 22:08:12 -04:00
spelling.txt Support SARIF JSON diagnostic output with `--diagnostics-sarif`. (#6017) 2025-05-17 15:46:15 -04: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. 2025-01-01 08:30:25 -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>`_