[Valgrind-developers] [valgrind] vgdb.c: Update --vargs documentation

[Mark W. <ma...@so...>]

https://sourceware.org/cgit/valgrind/commit/?id=79020198175d40429e84f502a92afc779d9a9d5e

commit 79020198175d40429e84f502a92afc779d9a9d5e
Author: Alexandra Hájková <aha...@re...>
Date:   Wed Oct 15 07:32:06 2025 -0400

    vgdb.c: Update --vargs documentation

Diff:
---
 coregrind/vgdb.c             | 6 +++++-
 docs/xml/manual-core-adv.xml | 4 +++-
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/coregrind/vgdb.c b/coregrind/vgdb.c
index c635f94b50..8cf524a4f8 100644
--- a/coregrind/vgdb.c
+++ b/coregrind/vgdb.c
@@ -2077,7 +2077,11 @@ void usage(void)
 "     gdbserver has not processed a command after number seconds\n"
 "  --multi start in extended-remote mode, wait for gdb to tell us what to run\n"
 "   --valgrind, pass the path to valgrind to use. If not specified, the system valgrind will be launched.\n"
-"   --vargs everything that follows is an argument for valgrind.\n"
+"   --vargs Additional valgrind tool options (must be used with --multi).\n"
+"           Everything following --vargs is passed to valgrind as tool options\n"
+"           (like -q, --leak-check=full, --tool=helgrind, etc.). The program\n"
+"           executable and its arguments are specified separately by GDB and\n"
+"           should NOT be included here.\n"
 "  -l  arg tells to show the list of running Valgrind gdbserver and then exit.\n"
 "  -T  arg tells to add timestamps to vgdb information messages.\n"
 "  -D  arg tells to show shared mem status and then exit.\n"
diff --git a/docs/xml/manual-core-adv.xml b/docs/xml/manual-core-adv.xml
index d7944b8a15..3591cf731f 100644
--- a/docs/xml/manual-core-adv.xml
+++ b/docs/xml/manual-core-adv.xml
@@ -1424,7 +1424,9 @@ gdb prog
     <listitem><para>Options to run valgrind with, in extended-remote
     mode. For example <option>-q</option>. Everything
     following <option>--vargs</option> will be provided as arguments
-    to valgrind as is. </para></listitem>
+    to valgrind as is. This is only for supplying valgrind options.
+    The program executable and its arguments are specified separately
+    by GDB and should NOT be included here.</para></listitem>
   </varlistentry>
 
   <varlistentry>