mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-11-24 18:44:20 +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.
101 lines
3.1 KiB
C
101 lines
3.1 KiB
C
/* Handle different target file systems for GDB, the GNU Debugger.
|
|
|
|
Copyright (C) 2010-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 "filesystem.h"
|
|
#include "gdbarch.h"
|
|
#include "gdbcmd.h"
|
|
|
|
const char file_system_kind_auto[] = "auto";
|
|
const char file_system_kind_unix[] = "unix";
|
|
const char file_system_kind_dos_based[] = "dos-based";
|
|
const char *const target_file_system_kinds[] =
|
|
{
|
|
file_system_kind_auto,
|
|
file_system_kind_unix,
|
|
file_system_kind_dos_based,
|
|
NULL
|
|
};
|
|
const char *target_file_system_kind = file_system_kind_auto;
|
|
|
|
const char *
|
|
effective_target_file_system_kind (void)
|
|
{
|
|
if (target_file_system_kind == file_system_kind_auto)
|
|
{
|
|
if (gdbarch_has_dos_based_file_system (target_gdbarch ()))
|
|
return file_system_kind_dos_based;
|
|
else
|
|
return file_system_kind_unix;
|
|
}
|
|
else
|
|
return target_file_system_kind;
|
|
}
|
|
|
|
const char *
|
|
target_lbasename (const char *kind, const char *name)
|
|
{
|
|
if (kind == file_system_kind_dos_based)
|
|
return dos_lbasename (name);
|
|
else
|
|
return unix_lbasename (name);
|
|
}
|
|
|
|
static void
|
|
show_target_file_system_kind_command (struct ui_file *file,
|
|
int from_tty,
|
|
struct cmd_list_element *c,
|
|
const char *value)
|
|
{
|
|
if (target_file_system_kind == file_system_kind_auto)
|
|
fprintf_filtered (file, _("\
|
|
The assumed file system kind for target reported file names \
|
|
is \"%s\" (currently \"%s\").\n"),
|
|
value,
|
|
effective_target_file_system_kind ());
|
|
else
|
|
fprintf_filtered (file, _("\
|
|
The assumed file system kind for target reported file names \
|
|
is \"%s\".\n"),
|
|
value);
|
|
}
|
|
|
|
void
|
|
_initialize_filesystem (void)
|
|
{
|
|
add_setshow_enum_cmd ("target-file-system-kind",
|
|
class_files,
|
|
target_file_system_kinds,
|
|
&target_file_system_kind, _("\
|
|
Set assumed file system kind for target reported file names."), _("\
|
|
Show assumed file system kind for target reported file names."),
|
|
_("\
|
|
If `unix', target file names (e.g., loaded shared library file names)\n\
|
|
starting the forward slash (`/') character are considered absolute,\n\
|
|
and the directory separator character is the forward slash (`/'). If\n\
|
|
`dos-based', target file names starting with a drive letter followed\n\
|
|
by a colon (e.g., `c:'), are also considered absolute, and the\n\
|
|
backslash (`\\') is also considered a directory separator. Set to\n\
|
|
`auto' (which is the default), to let GDB decide, based on its\n\
|
|
knowledge of the target operating system."),
|
|
NULL, /* setfunc */
|
|
show_target_file_system_kind_command,
|
|
&setlist, &showlist);
|
|
}
|