verilator/docs
Jose Drowne 56fcdc05cb Add runtime threading advisor for configuration warnings
- Add VlThreadingAdvisor class to detect potential threading misconfigurations
- Reads CPU topology on Linux via /sys/devices/system/cpu/ to detect:
  - Hyperthreading-enabled systems where threads > physical cores
- Warns users when threading configuration may reduce performance
- Integrates automatically when thread pool is created (threads > 1)
- Respects quiet() flag to suppress output
- Advisory only - does not affect simulation behavior

This provides earlier feedback than verilator_gantt which requires explicit
profiling and post-hoc analysis.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-05 23:27:02 -05:00
..
_static Fix Codacy warnings. No functional change. 2021-07-07 19:42:49 -04:00
bin Internals: Add more python strict typing. No functional change intended 2025-11-01 14:14:56 -04:00
gen Internals: Make all scheduling region use a single trigger vector. (#6620) 2025-11-01 15:43:20 +00:00
guide Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05: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 Add runtime threading advisor for configuration warnings 2025-12-05 23:27:02 -05:00
Makefile Commentary: Changes update 2025-07-16 17:26:01 -04:00
README.rst Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05:00
internals.rst Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -05:00
security.rst Add security policy 2025-05-16 22:08:12 -04:00
spelling.txt Commentary: Changes update 2025-12-03 21:21:42 -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 Documentation: Adapt format suggested by docstrfmt 2025-11-22 10:59:38 -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>`_