From patchwork Thu Nov 21 00:05:49 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 36079 Received: (qmail 44829 invoked by alias); 21 Nov 2019 00:05:58 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 44815 invoked by uid 89); 21 Nov 2019 00:05:58 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-20.7 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, RCVD_IN_DNSWL_NONE, SPF_HELO_PASS autolearn=ham version=3.3.1 spammy=HX-HELO:sk:gateway, H*RU:sk:gateway, HX-Spam-Relays-External:sk:gateway, debugged X-HELO: gateway33.websitewelcome.com Received: from gateway33.websitewelcome.com (HELO gateway33.websitewelcome.com) (192.185.146.119) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 21 Nov 2019 00:05:53 +0000 Received: from cm17.websitewelcome.com (cm17.websitewelcome.com [100.42.49.20]) by gateway33.websitewelcome.com (Postfix) with ESMTP id C8BEF13C1B1 for ; Wed, 20 Nov 2019 18:05:51 -0600 (CST) Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with SMTP id XZypiuBvEqNtvXZypihIFd; Wed, 20 Nov 2019 18:05:51 -0600 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:MIME-Version :Content-Type:Content-Transfer-Encoding:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: In-Reply-To:References:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=kPscXHhNULVGwloVgcK4agsSL+kMml+dpfTMdjjDZCE=; b=g9PG7lqaiKaHURM48OOW1jxD3a UT5RRqW5b7T3FsTRWhavt8Izwz2Ne9lZBFPNKjcFYmW/sLJV4xFPnGQMPy0Fzvjw6VvfIewZHjc7q mP9ErDZz8TWhjaojLPW0FB5iG; Received: from 75-166-123-17.hlrn.qwest.net ([75.166.123.17]:38784 helo=bapiya.Home) by box5379.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92) (envelope-from ) id 1iXZyp-003hbe-Ih; Wed, 20 Nov 2019 17:05:51 -0700 From: Tom Tromey To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [FYI] Restore parameter names in observable.h Date: Wed, 20 Nov 2019 17:05:49 -0700 Message-Id: <20191121000549.15420-1-tom@tromey.com> Ages ago, when we switched observables to be templates, Joel asked me to restore the parameter names that were used in the old observer.texi. I've finally done this. I also updated the comments in this file to use the GNU metasyntactic variable convention as well. gdb/ChangeLog 2019-11-20 Tom Tromey * observable.h: Update comments. Change-Id: Id71bea7a7fcaa8f5d4491f33aa8861c56ba9c3f0 --- gdb/ChangeLog | 4 ++ gdb/observable.h | 162 ++++++++++++++++++++++++----------------------- 2 files changed, 86 insertions(+), 80 deletions(-) diff --git a/gdb/observable.h b/gdb/observable.h index b58966ea90b..215b9606d0e 100644 --- a/gdb/observable.h +++ b/gdb/observable.h @@ -35,9 +35,9 @@ namespace gdb namespace observers { -/* The inferior has stopped for real. The bs argument describes the +/* The inferior has stopped for real. The BS argument describes the breakpoints were are stopped at, if any. Second argument - print_frame non-zero means display the location where the + PRINT_FRAME non-zero means display the location where the inferior has stopped. gdb notifies all normal_stop observers when the inferior execution @@ -49,19 +49,19 @@ namespace observers condition that is not met. If the breakpoint has any associated commands list, the commands are executed after the notification is emitted. */ -extern observable normal_stop; +extern observable normal_stop; /* The inferior was stopped by a signal. */ -extern observable signal_received; +extern observable signal_received; /* We are done with a step/next/si/ni command. */ extern observable<> end_stepping_range; /* The inferior was terminated by a signal. */ -extern observable signal_exited; +extern observable signal_exited; /* The inferior program is finished. */ -extern observable exited; +extern observable exited; /* Reverse execution: target ran out of history info. */ extern observable<> no_history; @@ -73,7 +73,7 @@ extern observable<> sync_execution_done; extern observable<> command_error; /* The target's register contents have changed. */ -extern observable target_changed; +extern observable target_changed; /* The executable being debugged by GDB has changed: The user decided to debug a different program, or the program he was @@ -86,147 +86,149 @@ extern observable<> executable_changed; instruction. For 'attach' and 'core', gdb calls this observer immediately after connecting to the inferior, and before any information on the inferior has been printed. */ -extern observable inferior_created; +extern observable inferior_created; /* The status of process record for inferior inferior in gdb has - changed. The process record is started if started is true, and - the process record is stopped if started is false. + changed. The process record is started if STARTED is true, and + the process record is stopped if STARTED is false. - When started is true, method indicates the short name of the + When STARTED is true, METHOD indicates the short name of the method used for recording. If the method supports multiple - formats, format indicates which one is being used, otherwise it - is NULL. When started is false, they are both NULL. */ -extern observable + formats, FORMAT indicates which one is being used, otherwise it + is NULL. When STARTED is false, they are both NULL. */ +extern observable record_changed; -/* The shared library specified by solib has been loaded. Note that +/* The shared library specified by SOLIB has been loaded. Note that when gdb calls this observer, the library's symbols probably haven't been loaded yet. */ -extern observable solib_loaded; +extern observable solib_loaded; -/* The shared library specified by solib has been unloaded. Note +/* The shared library specified by SOLIB has been unloaded. Note that when gdb calls this observer, the library's symbols have not been unloaded yet, and thus are still available. */ -extern observable solib_unloaded; +extern observable solib_unloaded; -/* The symbol file specified by objfile has been loaded. Called - with objfile equal to NULL to indicate previously loaded symbol +/* The symbol file specified by OBJFILE has been loaded. Called + with OBJFILE equal to NULL to indicate previously loaded symbol table data has now been invalidated. */ -extern observable new_objfile; +extern observable new_objfile; -/* The object file specified by objfile is about to be freed. */ -extern observable free_objfile; +/* The object file specified by OBJFILE is about to be freed. */ +extern observable free_objfile; -/* The thread specified by t has been created. */ -extern observable new_thread; +/* The thread specified by T has been created. */ +extern observable new_thread; -/* The thread specified by t has exited. The silent argument +/* The thread specified by T has exited. The SILENT argument indicates that gdb is removing the thread from its tables without wanting to notify the user about it. */ -extern observable thread_exit; +extern observable thread_exit; -/* An explicit stop request was issued to ptid. If ptid equals +/* An explicit stop request was issued to PTID. If PTID equals minus_one_ptid, the request applied to all threads. If - ptid_is_pid(ptid) returns true, the request applied to all - threads of the process pointed at by ptid. Otherwise, the - request applied to the single thread pointed at by ptid. */ -extern observable thread_stop_requested; + ptid_is_pid(PTID) returns true, the request applied to all + threads of the process pointed at by PTID. Otherwise, the + request applied to the single thread pointed at by PTID. */ +extern observable thread_stop_requested; -/* The target was resumed. The ptid parameter specifies which +/* The target was resumed. The PTID parameter specifies which thread was resume, and may be RESUME_ALL if all threads are resumed. */ -extern observable target_resumed; +extern observable target_resumed; /* The target is about to be proceeded. */ extern observable<> about_to_proceed; -/* A new breakpoint b has been created. */ -extern observable breakpoint_created; +/* A new breakpoint B has been created. */ +extern observable breakpoint_created; -/* A breakpoint has been destroyed. The argument b is the +/* A breakpoint has been destroyed. The argument B is the pointer to the destroyed breakpoint. */ -extern observable breakpoint_deleted; +extern observable breakpoint_deleted; -/* A breakpoint has been modified in some way. The argument b +/* A breakpoint has been modified in some way. The argument B is the modified breakpoint. */ -extern observable breakpoint_modified; +extern observable breakpoint_modified; -/* The trace frame is changed to tfnum (e.g., by using the 'tfind' - command). If tfnum is negative, it means gdb resumes live +/* The trace frame is changed to TFNUM (e.g., by using the 'tfind' + command). If TFNUM is negative, it means gdb resumes live debugging. The number of the tracepoint associated with this - traceframe is tpnum. */ -extern observable traceframe_changed; + traceframe is TPNUM. */ +extern observable traceframe_changed; -/* The current architecture has changed. The argument newarch is a +/* The current architecture has changed. The argument NEWARCH is a pointer to the new architecture. */ -extern observable architecture_changed; +extern observable architecture_changed; -/* The thread's ptid has changed. The old_ptid parameter specifies - the old value, and new_ptid specifies the new value. */ -extern observable thread_ptid_changed; +/* The thread's ptid has changed. The OLD_PTID parameter specifies + the old value, and NEW_PTID specifies the new value. */ +extern observable thread_ptid_changed; -/* The inferior inf has been added to the list of inferiors. At +/* The inferior INF has been added to the list of inferiors. At this point, it might not be associated with any process. */ -extern observable inferior_added; +extern observable inferior_added; -/* The inferior identified by inf has been attached to a +/* The inferior identified by INF has been attached to a process. */ -extern observable inferior_appeared; +extern observable inferior_appeared; -/* Either the inferior associated with inf has been detached from +/* Either the inferior associated with INF has been detached from the process, or the process has exited. */ -extern observable inferior_exit; +extern observable inferior_exit; -/* The inferior inf has been removed from the list of inferiors. - This method is called immediately before freeing inf. */ -extern observable inferior_removed; +/* The inferior INF has been removed from the list of inferiors. + This method is called immediately before freeing INF. */ +extern observable inferior_removed; -/* Bytes from data to data + len have been written to the inferior - at addr. */ -extern observable +/* Bytes from DATA to DATA + LEN have been written to the inferior + at ADDR. */ +extern observable memory_changed; -/* Called before a top-level prompt is displayed. current_prompt is +/* Called before a top-level prompt is displayed. CURRENT_PROMPT is the current top-level prompt. */ -extern observable before_prompt; +extern observable before_prompt; /* Variable gdb_datadir has been set. The value may not necessarily change. */ extern observable<> gdb_datadir_changed; /* The parameter of some 'set' commands in console are changed. - This method is called after a command 'set param value'. param - is the parameter of 'set' command, and value is the value of + This method is called after a command 'set param value'. PARAM + is the parameter of 'set' command, and VALUE is the value of changed parameter. */ -extern observable command_param_changed; +extern observable command_param_changed; -/* The new trace state variable tsv is created. */ -extern observable tsv_created; +/* The new trace state variable TSV is created. */ +extern observable tsv_created; -/* The trace state variable tsv is deleted. If tsv is NULL, all +/* The trace state variable TSV is deleted. If TSV is NULL, all trace state variables are deleted. */ -extern observable tsv_deleted; +extern observable tsv_deleted; -/* The trace state value tsv is modified. */ -extern observable tsv_modified; +/* The trace state value TSV is modified. */ +extern observable tsv_modified; -/* An inferior function at address is about to be called in thread - thread. */ -extern observable inferior_call_pre; +/* An inferior function at ADDRESS is about to be called in thread + THREAD. */ +extern observable inferior_call_pre; -/* The inferior function at address has just been called. This +/* The inferior function at ADDRESS has just been called. This observer is called even if the inferior exits during the call. - thread is the thread in which the function was called, which may + THREAD is the thread in which the function was called, which may be different from the current thread. */ -extern observable inferior_call_post; +extern observable inferior_call_post; /* A register in the inferior has been modified by the gdb user. */ -extern observable register_changed; +extern observable register_changed; /* The user-selected inferior, thread and/or frame has changed. The user_select_what flag specifies if the inferior, thread and/or frame has changed. */ -extern observable user_selected_context_changed; +extern observable user_selected_context_changed; /* This is notified when the source styling setting has changed and should be reconsulted. */