Change regcache list to be an hash map

[deliverable/binutils-gdb.git] / gdb / annotate.h

diff --git a/gdb/annotate.h b/gdb/annotate.h
index 9683b7e09ac4b5c43b1355d1981bc2b51aae6a15..70c2f280507b2aea59bd6e75610ec83ba830d19c 100644 (file)
--- a/gdb/annotate.h
+++ b/gdb/annotate.h
@@ -1,5 +1,5 @@
 /* Annotation routines for GDB.
-   Copyright (C) 1986-2019 Free Software Foundation, Inc.
+   Copyright (C) 1986-2020 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -94,8 +94,17 @@ struct annotate_arg_emitter
    MID_STATEMENT is nonzero if the PC is not at the beginning of that
    line.
 
-   Return true if successful, false if the file could not be found or
-   annotations are turned off.  */
+   The current symtab and line is updated to reflect S and LINE.
+
+   Return true if the annotation was printed and the current symtab and
+   line were updated, otherwise return false, which can happen if the
+   source file for S can't be found, or LINE is out of range.
+
+   This does leave GDB in the weird situation where, even when annotations
+   are on, we only sometimes print the annotation, and only sometimes
+   update the current symtab and line.  However, this particular annotation
+   has behaved this way for some time, and front ends that still use
+   annotations now depend on this behaviour.  */
 extern bool annotate_source_line (struct symtab *s, int line,
                                  int mid_statement, CORE_ADDR pc);