mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-15 04:31:49 +08:00
590042fc45
With this patch, the help docs now respect 2 invariants: * The first line of a command help is terminated by a '.' character. * The last character of a command help is not a newline character. Note that the changes for the last invariant were done by Tom, as part of : [PATCH] Remove trailing newlines from help text https://sourceware.org/ml/gdb-patches/2019-06/msg00050.html but some occurrences have been re-introduced since then. Some help docs had to be rephrased/restructured to respect the above invariants. Before this patch, print_doc_line was printing the first line of a command help documentation, but stopping at the first '.' or ',' character. This was giving inconsistent results : * The first line of command helps was sometimes '.' terminated, sometimes not. * The first line of command helps was not always designed to be readable/understandable/unambiguous when stopping at the first '.' or ',' character. This e.g. created the following inconsistencies/problems: < catch exception -- Catch Ada exceptions < catch handlers -- Catch Ada exceptions < catch syscall -- Catch system calls by their names < down-silently -- Same as the `down' command while the new help is: > catch exception -- Catch Ada exceptions, when raised. > catch handlers -- Catch Ada exceptions, when handled. > catch syscall -- Catch system calls by their names, groups and/or numbers. > down-silently -- Same as the `down' command, but does not print anything. Also, the command help doc should not be terminated by a newline character, but this was not respected by all commands. The cli-option -OPT framework re-introduced some occurences. So, the -OPT build help framework was changed to not output newlines at the end of %OPTIONS% replacement. This patch changes the help documentations to ensure the 2 invariants given above. It implied to slightly rephrase or restructure some help docs. Based on the above invariants, print_doc_line (called by 'apropos' and 'help' commands to print the first line of a command help) now outputs the full first line of a command help. This all results in a lot of small changes in the produced help docs. There are less code changes than changes in the help docs, as a lot of docs are produced by some code (e.g. the remote packet usage settings). gdb/ChangeLog 2019-08-07 Philippe Waroquiers <philippe.waroquiers@skynet.be> * cli/cli-decode.h (print_doc_line): Add for_value_prefix argument. * cli/cli-decode.c (print_doc_line): Likewise. It now prints the full first line, except when FOR_VALUE_PREFIX. In this case, the trailing '.' is not output, and the first character is uppercased. (print_help_for_command): Update call to print_doc_line. (print_doc_of_command): Likewise. * cli/cli-setshow.c (deprecated_show_value_hack): Likewise. * cli/cli-option.c (append_indented_doc): Do not append newline. (build_help_option): Append newline after first appended_indented_doc only if a second call is done. (build_help): Append 2 new lines before each option, except the first one. * compile/compile.c (_initialize_compile): Add new lines after %OPTIONS%, when not at the end of the help. Change help doc or code producing the help doc to respect the invariants. * maint-test-options.c (_initialize_maint_test_options): Likewise. Also removed the new line after 'Options:', as all other commands do not put an empty line between 'Options:' and the first option. * printcmd.c (_initialize_printcmd): Likewise. * stack.c (_initialize_stack): Likewise. * interps.c (interpreter_exec_cmd): Fix "Usage:" line that was incorrectly telling COMMAND is optional. * ada-lang.c (_initialize_ada_language): Change help doc or code producing the help doc to respect the invariants. * ada-tasks.c (_initialize_ada_tasks): Likewise. * breakpoint.c (_initialize_breakpoint): Likewise. * cli/cli-cmds.c (_initialize_cli_cmds): Likewise. * cli/cli-logging.c (_initialize_cli_logging): Likewise. * cli/cli-setshow.c (_initialize_cli_setshow): Likewise. * cli/cli-style.c (cli_style_option::add_setshow_commands, _initialize_cli_style): Likewise. * corelow.c (core_target_info): Likewise. * dwarf-index-cache.c (_initialize_index_cache): Likewise. * dwarf2read.c (_initialize_dwarf2_read): Likewise. * filesystem.c (_initialize_filesystem): Likewise. * frame.c (_initialize_frame): Likewise. * gnu-nat.c (add_task_commands): Likewise. * infcall.c (_initialize_infcall): Likewise. * infcmd.c (_initialize_infcmd): Likewise. * interps.c (_initialize_interpreter): Likewise. * language.c (_initialize_language): Likewise. * linux-fork.c (_initialize_linux_fork): Likewise. * maint-test-settings.c (_initialize_maint_test_settings): Likewise. * maint.c (_initialize_maint_cmds): Likewise. * memattr.c (_initialize_mem): Likewise. * printcmd.c (_initialize_printcmd): Likewise. * python/lib/gdb/function/strfns.py (_MemEq, _StrLen, _StrEq, _RegEx): Likewise. * ravenscar-thread.c (_initialize_ravenscar): Likewise. * record-btrace.c (_initialize_record_btrace): Likewise. * record-full.c (_initialize_record_full): Likewise. * record.c (_initialize_record): Likewise. * regcache-dump.c (_initialize_regcache_dump): Likewise. * regcache.c (_initialize_regcache): Likewise. * remote.c (add_packet_config_cmd, init_remote_threadtests, _initialize_remote): Likewise. * ser-tcp.c (_initialize_ser_tcp): Likewise. * serial.c (_initialize_serial): Likewise. * skip.c (_initialize_step_skip): Likewise. * source.c (_initialize_source): Likewise. * stack.c (_initialize_stack): Likewise. * symfile.c (_initialize_symfile): Likewise. * symtab.c (_initialize_symtab): Likewise. * target-descriptions.c (_initialize_target_descriptions): Likewise. * top.c (init_main): Likewise. * tracefile-tfile.c (tfile_target_info): Likewise. * tracepoint.c (_initialize_tracepoint): Likewise. * tui/tui-win.c (_initialize_tui_win): Likewise. * utils.c (add_internal_problem_command): Likewise. * valprint.c (value_print_option_defs): Likewise. gdb/testsuite/ChangeLog 2019-08-07 Philippe Waroquiers <philippe.waroquiers@skynet.be> * gdb.base/style.exp: Update tests for help doc new invariants. * gdb.base/help.exp: Likewise.
247 lines
8.4 KiB
C
247 lines
8.4 KiB
C
/* Maintenance commands for testing the settings framework.
|
||
|
||
Copyright (C) 2019 Free Software Foundation, Inc.
|
||
|
||
This file is part of GDB.
|
||
|
||
This program is free software; you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation; either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
||
|
||
|
||
#include "defs.h"
|
||
#include "gdbcmd.h"
|
||
|
||
/* Command list for "maint set test-settings". */
|
||
static cmd_list_element *maintenance_set_test_settings_list;
|
||
|
||
/* Command list for "maint show test-settings". */
|
||
static cmd_list_element *maintenance_show_test_settings_list;
|
||
|
||
/* The "maintenance set test-settings" prefix command. */
|
||
|
||
static void
|
||
maintenance_set_test_settings_cmd (const char *args, int from_tty)
|
||
{
|
||
printf_unfiltered (_("\"maintenance set test-settings\" must be followed "
|
||
"by the name of a set command.\n"));
|
||
help_list (maintenance_set_test_settings_list,
|
||
"maintenance set test-settings ",
|
||
all_commands, gdb_stdout);
|
||
}
|
||
|
||
/* The "maintenance show test-settings" prefix command. */
|
||
|
||
static void
|
||
maintenance_show_test_settings_cmd (const char *args, int from_tty)
|
||
{
|
||
cmd_show_list (maintenance_show_test_settings_list, from_tty, "");
|
||
}
|
||
|
||
/* Control variables for all the "maintenance set/show test-settings
|
||
xxx" commands. */
|
||
|
||
static int maintenance_test_settings_boolean;
|
||
|
||
static auto_boolean maintenance_test_settings_auto_boolean = AUTO_BOOLEAN_AUTO;
|
||
|
||
static unsigned int maintenance_test_settings_uinteger;
|
||
|
||
static int maintenance_test_settings_integer;
|
||
|
||
static int maintenance_test_settings_zinteger;
|
||
|
||
static unsigned int maintenance_test_settings_zuinteger;
|
||
|
||
static int maintenance_test_settings_zuinteger_unlimited;
|
||
|
||
static char *maintenance_test_settings_string;
|
||
|
||
static char *maintenance_test_settings_string_noescape;
|
||
|
||
static char *maintenance_test_settings_optional_filename;
|
||
|
||
static char *maintenance_test_settings_filename;
|
||
|
||
/* Enum values for the "maintenance set/show test-settings boolean"
|
||
commands. */
|
||
static const char maintenance_test_settings_xxx[] = "xxx";
|
||
static const char maintenance_test_settings_yyy[] = "yyy";
|
||
static const char maintenance_test_settings_zzz[] = "zzz";
|
||
|
||
static const char *const maintenance_test_settings_enums[] = {
|
||
maintenance_test_settings_xxx,
|
||
maintenance_test_settings_yyy,
|
||
maintenance_test_settings_zzz,
|
||
nullptr
|
||
};
|
||
|
||
static const char *maintenance_test_settings_enum
|
||
= maintenance_test_settings_xxx;
|
||
|
||
/* The "maintenance show test-settings xxx" commands. */
|
||
|
||
static void
|
||
maintenance_show_test_settings_value_cmd
|
||
(struct ui_file *file, int from_tty,
|
||
struct cmd_list_element *c, const char *value)
|
||
{
|
||
fprintf_filtered (file, (("%s\n")), value);
|
||
}
|
||
|
||
|
||
void
|
||
_initialize_maint_test_settings (void)
|
||
{
|
||
maintenance_test_settings_filename = xstrdup ("/foo/bar");
|
||
|
||
add_prefix_cmd ("test-settings", class_maintenance,
|
||
maintenance_set_test_settings_cmd, _("\
|
||
Set GDB internal variables used for set/show command infrastructure testing."),
|
||
&maintenance_set_test_settings_list,
|
||
"maintenance set test-settings ",
|
||
0/*allow-unknown*/,
|
||
&maintenance_set_cmdlist);
|
||
|
||
add_prefix_cmd ("test-settings", class_maintenance,
|
||
maintenance_show_test_settings_cmd, _("\
|
||
Show GDB internal variables used for set/show command infrastructure testing."),
|
||
&maintenance_show_test_settings_list,
|
||
"maintenance show test-settings ",
|
||
0/*allow-unknown*/,
|
||
&maintenance_show_cmdlist);
|
||
|
||
add_setshow_boolean_cmd ("boolean", class_maintenance,
|
||
&maintenance_test_settings_boolean, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_auto_boolean_cmd ("auto-boolean", class_maintenance,
|
||
&maintenance_test_settings_auto_boolean, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_uinteger_cmd ("uinteger", class_maintenance,
|
||
&maintenance_test_settings_uinteger, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_integer_cmd ("integer", class_maintenance,
|
||
&maintenance_test_settings_integer, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_string_cmd ("string", class_maintenance,
|
||
&maintenance_test_settings_string, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_string_noescape_cmd
|
||
("string-noescape", class_maintenance,
|
||
&maintenance_test_settings_string_noescape, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_optional_filename_cmd
|
||
("optional-filename", class_maintenance,
|
||
&maintenance_test_settings_optional_filename, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_filename_cmd ("filename", class_maintenance,
|
||
&maintenance_test_settings_filename, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_zinteger_cmd ("zinteger", class_maintenance,
|
||
&maintenance_test_settings_zinteger, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_zuinteger_cmd ("zuinteger", class_maintenance,
|
||
&maintenance_test_settings_zuinteger, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_zuinteger_unlimited_cmd
|
||
("zuinteger-unlimited", class_maintenance,
|
||
&maintenance_test_settings_zuinteger_unlimited, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
|
||
add_setshow_enum_cmd ("enum", class_maintenance,
|
||
maintenance_test_settings_enums,
|
||
&maintenance_test_settings_enum, _("\
|
||
command used for internal testing."), _("\
|
||
command used for internal testing."),
|
||
nullptr, /* help_doc */
|
||
nullptr, /* set_cmd */
|
||
maintenance_show_test_settings_value_cmd,
|
||
&maintenance_set_test_settings_list,
|
||
&maintenance_show_test_settings_list);
|
||
}
|