2010-12-28 Michael Snyder <msnyder@vmware.com>

	* event-loop.c: Comment clean-up.
	* event-loop.h: Ditto.
	* event-top.c: Ditto.
	* gdb.c: Ditto.
	* gdb.h: Ditto.
	* main.c: Ditto.
	* top.c: Ditto.
	* top.h: Ditto.

1 files changed, 81 insertions, 76 deletions

diff --git a/gdb/top.c b/gdb/top.c
index 6680c38c356..45c92596cb7 100644
--- a/gdb/top.c
+++ b/gdb/top.c
@@ -49,7 +49,7 @@
 #include "gdbthread.h"
 #include "python/python.h"
 
-/* readline include files */
+/* readline include files.  */
 #include "readline/readline.h"
 #include "readline/history.h"
 
@@ -65,7 +65,7 @@
 #include "ui-out.h"
 #include "cli-out.h"
 
-/* Default command line prompt.  This is overriden in some configs. */
+/* Default command line prompt.  This is overriden in some configs.  */
 
 #ifndef DEFAULT_PROMPT
 #define DEFAULT_PROMPT	"(gdb) "
@@ -97,7 +97,7 @@ extern char lang_frame_mismatch_warn[];		/* language.c */
 
 /* Flag for whether we want all the "from_tty" gubbish printed.  */
 
-int caution = 1;		/* Default is yes, sigh. */
+int caution = 1;		/* Default is yes, sigh.  */
 static void
 show_caution (struct ui_file *file, int from_tty,
 	      struct cmd_list_element *c, const char *value)
@@ -107,9 +107,10 @@ Whether to confirm potentially dangerous operations is %s.\n"),
 		    value);
 }
 
-/* stdio stream that command input is being read from.  Set to stdin normally.
-   Set by source_command to the file we are sourcing.  Set to NULL if we are
-   executing a user-defined command or interacting via a GUI.  */
+/* stdio stream that command input is being read from.  Set to stdin
+   normally.  Set by source_command to the file we are sourcing.  Set
+   to NULL if we are executing a user-defined command or interacting
+   via a GUI.  */
 
 FILE *instream;
 
@@ -149,12 +150,12 @@ int server_command;
 
 /* Baud rate specified for talking to serial target systems.  Default
    is left as -1, so targets can choose their own defaults.  */
-/* FIXME: This means that "show remotebaud" and gr_files_info can print -1
-   or (unsigned int)-1.  This is a Bad User Interface.  */
+/* FIXME: This means that "show remotebaud" and gr_files_info can
+   print -1 or (unsigned int)-1.  This is a Bad User Interface.  */
 
 int baud_rate = -1;
 
-/* Timeout limit for response from target. */
+/* Timeout limit for response from target.  */
 
 /* The default value has been changed many times over the years.  It 
    was originally 5 seconds.  But that was thought to be a long time 
@@ -172,7 +173,7 @@ int baud_rate = -1;
    a single variable for all protocol timeouts.
 
    As remote.c is used much more than remote-e7000.c, it was changed 
-   back to 2 seconds in 1999. */
+   back to 2 seconds in 1999.  */
 
 int remote_timeout = 2;
 
@@ -187,17 +188,18 @@ char *lim_at_start;
 
 /* Hooks for alternate command interfaces.  */
 
-/* Called after most modules have been initialized, but before taking users
-   command file.
+/* Called after most modules have been initialized, but before taking
+   users command file.
 
-   If the UI fails to initialize and it wants GDB to continue
-   using the default UI, then it should clear this hook before returning. */
+   If the UI fails to initialize and it wants GDB to continue using
+   the default UI, then it should clear this hook before returning.  */
 
 void (*deprecated_init_ui_hook) (char *argv0);
 
-/* This hook is called from within gdb's many mini-event loops which could
-   steal control from a real user interface's event loop. It returns
-   non-zero if the user is requesting a detach, zero otherwise. */
+/* This hook is called from within gdb's many mini-event loops which
+   could steal control from a real user interface's event loop.  It
+   returns non-zero if the user is requesting a detach, zero
+   otherwise.  */
 
 int (*deprecated_ui_loop_hook) (int);
 
@@ -209,8 +211,10 @@ void (*deprecated_command_loop_hook) (void);
 
 /* Called from print_frame_info to list the line we stopped in.  */
 
-void (*deprecated_print_frame_info_listing_hook) (struct symtab * s, int line,
-						  int stopline, int noerror);
+void (*deprecated_print_frame_info_listing_hook) (struct symtab * s, 
+						  int line,
+						  int stopline, 
+						  int noerror);
 /* Replaces most of query.  */
 
 int (*deprecated_query_hook) (const char *, va_list);
@@ -236,33 +240,33 @@ char *(*deprecated_readline_hook) (char *);
 void (*deprecated_readline_end_hook) (void);
 
 /* Called as appropriate to notify the interface that we have attached
-   to or detached from an already running process. */
+   to or detached from an already running process.  */
 
 void (*deprecated_attach_hook) (void);
 void (*deprecated_detach_hook) (void);
 
-/* Called during long calculations to allow GUI to repair window damage, and to
-   check for stop buttons, etc... */
+/* Called during long calculations to allow GUI to repair window
+   damage, and to check for stop buttons, etc...  */
 
 void (*deprecated_interactive_hook) (void);
 
 /* Tell the GUI someone changed the register REGNO. -1 means
    that the caller does not know which register changed or
-   that several registers have changed (see value_assign). */
+   that several registers have changed (see value_assign).  */
 void (*deprecated_register_changed_hook) (int regno);
 
-/* Called when going to wait for the target.  Usually allows the GUI to run
-   while waiting for target events.  */
+/* Called when going to wait for the target.  Usually allows the GUI
+   to run while waiting for target events.  */
 
 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
 				       struct target_waitstatus *status,
 				       int options);
 
-/* Used by UI as a wrapper around command execution.  May do various things
-   like enabling/disabling buttons, etc...  */
+/* Used by UI as a wrapper around command execution.  May do various
+   things like enabling/disabling buttons, etc...  */
 
-void (*deprecated_call_command_hook) (struct cmd_list_element * c, char *cmd,
-				      int from_tty);
+void (*deprecated_call_command_hook) (struct cmd_list_element * c, 
+				      char *cmd, int from_tty);
 
 /* Called after a `set' command has finished.  Is only run if the
    `set' command succeeded.  */
@@ -283,7 +287,8 @@ void (*deprecated_context_hook) (int id);
 quit_cover (void *s)
 {
   caution = 0;			/* Throw caution to the wind -- we're exiting.
-				   This prevents asking the user dumb questions.  */
+				   This prevents asking the user dumb 
+				   questions.  */
   quit_command ((char *) 0, 0);
   return 0;
 }
@@ -339,10 +344,10 @@ prepare_execute_command (void)
 {
   free_all_values ();
 
-  /* With multiple threads running while the one we're examining is stopped,
-     the dcache can get stale without us being able to detect it.
-     For the duration of the command, though, use the dcache to help
-     things like backtrace.  */
+  /* With multiple threads running while the one we're examining is
+     stopped, the dcache can get stale without us being able to detect
+     it.  For the duration of the command, though, use the dcache to
+     help things like backtrace.  */
   if (non_stop)
     target_dcache_invalidate ();
 }
@@ -405,7 +410,7 @@ execute_command (char *p, int from_tty)
 	  *(p + 1) = '\0';
 	}
 
-      /* If this command has been pre-hooked, run the hook first. */
+      /* If this command has been pre-hooked, run the hook first.  */
       execute_cmd_pre_hook (c);
 
       if (c->flags & DEPRECATED_WARN_USER)
@@ -422,7 +427,7 @@ execute_command (char *p, int from_tty)
       else
 	cmd_func (c, arg, from_tty & caution);
        
-      /* If this command has been post-hooked, run the hook last. */
+      /* If this command has been post-hooked, run the hook last.  */
       execute_cmd_post_hook (c);
 
     }
@@ -442,7 +447,7 @@ execute_command (char *p, int from_tty)
 
   /* Warn the user if the working language does not match the
      language of the current frame.  Only warn the user if we are
-     actually running the program, i.e. there is a stack. */
+     actually running the program, i.e. there is a stack.  */
   /* FIXME:  This should be cacheing the frame and only running when
      the frame changes.  */
 
@@ -523,7 +528,7 @@ command_loop (void)
 	reinitialize_more_filter ();
       old_chain = make_cleanup (null_cleanup, 0);
 
-      /* Get a command-line. This calls the readline package. */
+      /* Get a command-line. This calls the readline package.  */
       command = command_line_input (instream == stdin ?
 				    get_prompt () : (char *) NULL,
 				    instream == stdin, "prompt");
@@ -550,8 +555,8 @@ dont_repeat (void)
     return;
 
   /* If we aren't reading from standard input, we are saving the last
-     thing read from stdin in line and don't want to delete it.  Null lines
-     won't repeat here in any case.  */
+     thing read from stdin in line and don't want to delete it.  Null
+     lines won't repeat here in any case.  */
   if (instream == stdin)
     *line = 0;
 }
@@ -880,8 +885,9 @@ command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
 
   while (1)
     {
-      /* Make sure that all output has been output.  Some machines may let
-         you get away with leaving out some of the gdb_flush, but not all.  */
+      /* Make sure that all output has been output.  Some machines may
+         let you get away with leaving out some of the gdb_flush, but
+         not all.  */
       wrap_here ("");
       gdb_flush (gdb_stdout);
       gdb_flush (gdb_stderr);
@@ -931,7 +937,7 @@ command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
 	}
       p1 = rl;
       /* Copy line.  Don't copy null at end.  (Leaves line alone
-         if this was just a newline)  */
+         if this was just a newline).  */
       while (*p1)
 	*p++ = *p1++;
 
@@ -997,9 +1003,8 @@ command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
       xfree (history_value);
     }
 
-  /* If we just got an empty line, and that is supposed
-     to repeat the previous command, return the value in the
-     global buffer.  */
+  /* If we just got an empty line, and that is supposed to repeat the
+     previous command, return the value in the global buffer.  */
   if (repeat && p == linebuffer)
     return line;
   for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
@@ -1020,7 +1025,7 @@ command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
      and remove the '#'.  The kill ring is probably better, but some
      people are in the habit of commenting things out.  */
   if (*p1 == '#')
-    *p1 = '\0';			/* Found a comment. */
+    *p1 = '\0';			/* Found a comment.  */
 
   /* Save into global buffer if appropriate.  */
   if (repeat)
@@ -1037,24 +1042,24 @@ command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
   return linebuffer;
 }
 
-/* Print the GDB banner. */
+/* Print the GDB banner.  */
 void
 print_gdb_version (struct ui_file *stream)
 {
   /* From GNU coding standards, first line is meant to be easy for a
      program to parse, and is just canonical program name and version
-     number, which starts after last space. */
+     number, which starts after last space.  */
 
   fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
 
-  /* Second line is a copyright notice. */
+  /* Second line is a copyright notice.  */
 
   fprintf_filtered (stream, "Copyright (C) 2010 Free Software Foundation, Inc.\n");
 
   /* Following the copyright is a brief statement that the program is
      free software, that users are free to copy and change it on
      certain conditions, that it is covered by the GNU GPL, and that
-     there is no warranty. */
+     there is no warranty.  */
 
   fprintf_filtered (stream, "\
 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
@@ -1062,7 +1067,7 @@ This is free software: you are free to change and redistribute it.\n\
 There is NO WARRANTY, to the extent permitted by law.  Type \"show copying\"\n\
 and \"show warranty\" for details.\n");
 
-  /* After the required info we print the configuration information. */
+  /* After the required info we print the configuration information.  */
 
   fprintf_filtered (stream, "This GDB was configured as \"");
   if (strcmp (host_name, target_name) != 0)
@@ -1097,7 +1102,7 @@ set_prompt (char *s)
 /* ??rehrauer: I don't know why this fails, since it looks as though
    assignments to prompt are wrapped in calls to xstrdup...
    if (prompt != NULL)
-   xfree (prompt);
+     xfree (prompt);
  */
   PROMPT (0) = xstrdup (s);
 }
@@ -1221,8 +1226,8 @@ quit_target (void *arg)
   if (write_history_p && history_filename)
     write_history (history_filename);
 
-  do_final_cleanups (ALL_CLEANUPS);	/* Do any final cleanups before exiting */
-
+  do_final_cleanups (ALL_CLEANUPS);    /* Do any final cleanups before
+					  exiting.  */
   return 0;
 }
 
@@ -1235,7 +1240,7 @@ quit_force (char *args, int from_tty)
   struct qt_args qt;
 
   /* An optional expression may be used to cause gdb to terminate with the 
-     value of that expression. */
+     value of that expression.  */
   if (args)
     {
       struct value *val = parse_and_eval (args);
@@ -1305,8 +1310,8 @@ input_from_terminal_p (void)
 static void
 dont_repeat_command (char *ignored, int from_tty)
 {
-  *line = 0;			/* Can't call dont_repeat here because we're not
-				   necessarily reading from stdin.  */
+  *line = 0;			/* Can't call dont_repeat here because we're 
+				   not necessarily reading from stdin.  */
 }
 
 /* Functions to manipulate command line editing control variables.  */
@@ -1414,7 +1419,7 @@ show_history (char *args, int from_tty)
   cmd_show_list (showhistlist, from_tty, "");
 }
 
-int info_verbose = 0;		/* Default verbose msgs off */
+int info_verbose = 0;		/* Default verbose msgs off.  */
 
 /* Called by do_setshow_command.  An elaborate joke.  */
 void
@@ -1438,10 +1443,9 @@ set_verbose (char *args, int from_tty, struct cmd_list_element *c)
 }
 
 /* Init the history buffer.  Note that we are called after the init file(s)
- * have been read so that the user can change the history file via his
- * .gdbinit file (for instance).  The GDBHISTFILE environment variable
- * overrides all of this.
- */
+   have been read so that the user can change the history file via his
+   .gdbinit file (for instance).  The GDBHISTFILE environment variable
+   overrides all of this.  */
 
 void
 init_history (void)
@@ -1647,7 +1651,7 @@ gdb_init (char *argv0)
   if (pre_init_ui_hook)
     pre_init_ui_hook ();
 
-  /* Run the init function of each source file */
+  /* Run the init function of each source file.  */
 
 #ifdef __MSDOS__
   /* Make sure we return to the original directory upon exit, come
@@ -1655,9 +1659,9 @@ gdb_init (char *argv0)
   make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
 #endif
 
-  init_cmd_lists ();		/* This needs to be done first */
-  initialize_targets ();	/* Setup target_terminal macros for utils.c */
-  initialize_utils ();		/* Make errors and warnings possible */
+  init_cmd_lists ();	    /* This needs to be done first.  */
+  initialize_targets ();    /* Setup target_terminal macros for utils.c.  */
+  initialize_utils ();	    /* Make errors and warnings possible.  */
 
   /* Here is where we call all the _initialize_foo routines.  */
   initialize_all_files ();
@@ -1671,17 +1675,18 @@ gdb_init (char *argv0)
   initialize_inferiors ();
   initialize_current_architecture ();
   init_cli_cmds();
-  init_main ();			/* But that omits this file!  Do it now */
+  init_main ();			/* But that omits this file!  Do it now.  */
 
   initialize_stdin_serial ();
 
   async_init_signals ();
 
-  /* We need a default language for parsing expressions, so simple things like
-     "set width 0" won't fail if no language is explicitly set in a config file
-     or implicitly set by reading an executable during startup. */
+  /* We need a default language for parsing expressions, so simple
+     things like "set width 0" won't fail if no language is explicitly
+     set in a config file or implicitly set by reading an executable
+     during startup.  */
   set_language (language_c);
-  expected_language = current_language;		/* don't warn about the change.  */
+  expected_language = current_language;	/* Don't warn about the change.  */
 
   /* Allow another UI to initialize. If the UI fails to initialize,
      and it wants GDB to revert to the CLI, it should clear
@@ -1690,10 +1695,10 @@ gdb_init (char *argv0)
     deprecated_init_ui_hook (argv0);
 
 #ifdef HAVE_PYTHON
-  /* Python initialization can require various commands to be installed.
-     For example "info pretty-printer" needs the "info" prefix to be
-     installed.  Keep things simple and just do final python initialization
-     here.  */
+  /* Python initialization can require various commands to be
+     installed.  For example "info pretty-printer" needs the "info"
+     prefix to be installed.  Keep things simple and just do final
+     python initialization here.  */
   finish_python_initialization ();
 #endif
 }