From 079a53e82007079cf78b822fcc2856791c18280b Mon Sep 17 00:00:00 2001
From: Todd Strader <todd.strader@gmail.com>
Date: Thu, 19 Dec 2024 17:14:15 -0500
Subject: [PATCH] Commentary: SYMRSVDWORD + VPI documentation (#5696)

---
 docs/guide/warnings.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/guide/warnings.rst b/docs/guide/warnings.rst
index d86bbc0f8..0f5f7131d 100644
--- a/docs/guide/warnings.rst
+++ b/docs/guide/warnings.rst
@@ -1692,6 +1692,9 @@ List Of Warnings
    Warning that a symbol matches a C++ reserved word, and using this as a
    symbol name would result in odd C++ compiler errors.  You may disable
    this warning, but Verilator will rename the symbol to avoid conflict.
+   If you are using `--vpi` and only mark things as public for VPI access
+   (and not C++ access) then it is advisable to disable this warning with
+   :code:`-Wno-SYMRSVDWORD`.
 
 
 .. option:: SYNCASYNCNET