From fa16eff003b78dcebe5fa77a9ff98a0aa26657be Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Thu, 13 Apr 2023 22:09:55 -0400 Subject: [PATCH] Commentary (#4118) --- docs/guide/simulating.rst | 17 +++++++++++++++++ docs/guide/warnings.rst | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/guide/simulating.rst b/docs/guide/simulating.rst index b65573be1..5f9440da9 100644 --- a/docs/guide/simulating.rst +++ b/docs/guide/simulating.rst @@ -498,3 +498,20 @@ Clang. The process in GCC 10 was as follows: Clang and GCC also support -fauto-profile, which uses sample-based feedback-directed optimization. See the appropriate compiler documentation. + + +.. _Runtime Debugging + +Runtime Debugging +================= + +To debug a Verilated executable, use the standard GNU debugger ``gdb`` or a +similar tool. Typically you will want to have debugger symbols inserted by +the compiler, assertions enabled in the C library, and assertions enabled +in the Verilated library. (These options slow down the executable, so do +this only when debugging.) To enable this, Verilate with: + + -CFLAGS -ggdb -LDFLAGS -ggdb -CFLAGS -DVL_DEBUG=1 -CFLAGS -D_GLIBCXX_DEBUG + +The :vlopt:`-CFLAGS` and/or :vlopt:`-LDFLAGS` options pass arguments +directly to the compiler or linker. diff --git a/docs/guide/warnings.rst b/docs/guide/warnings.rst index 1a754c8f6..b88f2ce20 100644 --- a/docs/guide/warnings.rst +++ b/docs/guide/warnings.rst @@ -878,7 +878,7 @@ List Of Warnings .. TODO better example - The naming of this worning is in contradiction with the common + The naming of this warning is in contradiction with the common interpretation of little endian. It was therefore renamed to :option:`ASCRANGE`. While :option:`LITENDIAN` remains for backwards compatibility, new projects should use :option:`ASCRANGE`.