From: Simon Marchi <simon.marchi@polymtl.ca>
Date: Sat, 8 Mar 2025 03:02:40 +0000 (-0500)
Subject: gdb/dwarf: add doc for cutu_reader::is_dummy
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3f239fd3ff0d0b25d5c4eb0bfca04416bf50b0c5;p=thirdparty%2Fbinutils-gdb.git

gdb/dwarf: add doc for cutu_reader::is_dummy

Change-Id: Ifb80557187c12822bdea7ad400c32c3dce968a7f
Approved-By: Tom Tromey <tom@tromey.com>
---

diff --git a/gdb/dwarf2/read.h b/gdb/dwarf2/read.h
index b6ff433978c..d6d119e038d 100644
--- a/gdb/dwarf2/read.h
+++ b/gdb/dwarf2/read.h
@@ -945,6 +945,11 @@ public:
 
   cutu_reader (cutu_reader &&) = default;
 
+  /* Return true if either:
+
+      - the unit is empty (just a header without any DIE)
+      - the unit is a partial unit and this cutu_reader was built with SKIP
+	PARTIAL true.  */
   bool is_dummy () const { return m_dummy_p; }
 
   dwarf2_cu *cu () const { return m_cu; }