[FYI] fix incorrect comments in minsyms.h

Message ID 1402926854-16825-1-git-send-email-tromey@redhat.com
State Committed
Headers

Commit Message

Tom Tromey June 16, 2014, 1:54 p.m. UTC
  minsyms.h incorrectly claims that a couple of functions call
prim_record_minimal_symbol_full with COPY_NAME=0 -- but actually they
pass 1.  Passing 1 is the correct behavior, so this patch fixes the
documentation.

I'm checking this in as obvious.

2014-06-16  Tom Tromey  <tromey@redhat.com>

	* minsyms.h (prim_record_minimal_symbol)
	(prim_record_minimal_symbol_and_info): Update comments.
---
 gdb/ChangeLog | 5 +++++
 gdb/minsyms.h | 4 ++--
 2 files changed, 7 insertions(+), 2 deletions(-)
  

Patch

diff --git a/gdb/minsyms.h b/gdb/minsyms.h
index 289dcae..807e5ee 100644
--- a/gdb/minsyms.h
+++ b/gdb/minsyms.h
@@ -102,7 +102,7 @@  struct minimal_symbol *prim_record_minimal_symbol_full
 
 /* Like prim_record_minimal_symbol_full, but:
    - uses strlen to compute NAME_LEN,
-   - passes COPY_NAME = 0,
+   - passes COPY_NAME = 1,
    - and passes a default SECTION, depending on the type
    
    This variant does not return the new symbol.  */
@@ -113,7 +113,7 @@  void prim_record_minimal_symbol (const char *, CORE_ADDR,
 
 /* Like prim_record_minimal_symbol_full, but:
    - uses strlen to compute NAME_LEN,
-   - passes COPY_NAME = 0.  */
+   - passes COPY_NAME = 1.  */
 
 struct minimal_symbol *prim_record_minimal_symbol_and_info
     (const char *,