Wrap help strings at 80 columns

This patch ensures that all ordinary help strings are wrapped at 80
columns.  For the most part this consists of changing code like this
(note the embedded \n and the trailing backslash without a newline):

-Manage the space-separated list of debuginfod server URLs that GDB will query \
-when missing debuginfo, executables or source files.\nThe default value is \
-copied from the DEBUGINFOD_URLS environment variable."),

... to end each line with \n\, like:

+Manage the space-separated list of debuginfod server URLs that GDB will\n\
+query when missing debuginfo, executables or source files.\n\
+The default value is copied from the DEBUGINFOD_URLS environment variable."),

Approved-By: Eli Zaretskii <eliz@gnu.org>
This commit is contained in:
Tom Tromey 2024-06-03 09:37:27 -06:00
parent bf0a217775
commit fc55e99ad7
21 changed files with 89 additions and 80 deletions

View File

@ -13957,11 +13957,11 @@ this option to \"off\" unless necessary."),
add_setshow_boolean_cmd ("print-signatures", class_vars,
&print_signatures, _("\
Enable or disable the output of formal and return types for functions in the \
overloads selection menu."), _("\
Show whether the output of formal and return types for functions in the \
overloads selection menu is activated."),
NULL, NULL, NULL, &set_ada_list, &show_ada_list);
Control the display of functions in overloads selection menu."), _("\
Show how functions in overloads selection menu will be displayed."),
_("\
When enabled, formal and return types are shown."),
NULL, NULL, &set_ada_list, &show_ada_list);
ada_source_charset = gnat_source_charsets[0];
add_setshow_enum_cmd ("source-charset", class_files,

View File

@ -2655,7 +2655,9 @@ If not, generate remote agent bytecode for current frame pc address."),
&maintenancelist);
add_cmd ("agent-printf", class_maintenance, maint_agent_printf_command,
_("Translate an expression into remote "
"agent bytecode for evaluation and display the bytecodes."),
_("\
Translate a printf into remote agent bytecode and display the bytecodes.\n\
Usage: maint agent-printf FORMAT, EXPR...\n\
The expressions are translated for evaluation, not tracing."),
&maintenancelist);
}

View File

@ -2644,9 +2644,9 @@ to be printed or after trailing whitespace."));
Set mode for script filename extension recognition."), _("\
Show mode for script filename extension recognition."), _("\
off == no filename extension recognition (all sourced files are GDB scripts)\n\
soft == evaluate script according to filename extension, fallback to GDB script"
"\n\
strict == evaluate script according to filename extension, error if not supported"
soft == evaluate script according to filename extension, fallback to GDB script\n\
strict == evaluate script according to filename extension,\n\
error if not supported"
),
NULL,
show_script_ext_mode,
@ -2741,9 +2741,10 @@ as 0 or -1 depending on the setting."),
gdb_setting_internal_fn, NULL);
add_internal_function ("_gdb_maint_setting_str", _("\
$_gdb_maint_setting_str - returns the value of a GDB maintenance setting as a string.\n\
$_gdb_maint_setting_str - returns the value of a GDB maintenance setting.\n\
Usage: $_gdb_maint_setting_str (setting)\n\
\n\
Like \"$_gdb_maint_setting\", but the return value is always a string.\n\
auto-boolean values are \"off\", \"on\", \"auto\".\n\
boolean values are \"off\", \"on\".\n\
Some integer settings accept an unlimited value, returned\n\

View File

@ -197,10 +197,10 @@ info_print_args_help (const char *prefix,
bool document_n_flag)
{
return xstrprintf (_("\
%sIf NAMEREGEXP is provided, only prints the %s whose name\n\
matches NAMEREGEXP.\n\
If -t TYPEREGEXP is provided, only prints the %s whose type\n\
matches TYPEREGEXP. Note that the matching is done with the type\n\
%sIf NAMEREGEXP is provided, only prints the %s\n\
whose name matches NAMEREGEXP.\n\
If -t TYPEREGEXP is provided, only prints the %s\n\
whose type matches TYPEREGEXP. Note that the matching is done with the type\n\
printed by the 'whatis' command.\n\
By default, the command might produce headers and/or messages indicating\n\
why no %s can be printed.\n\

View File

@ -624,9 +624,9 @@ When set to \"ask\", prompt whether to enable or disable debuginfod." ),
add_setshow_string_noescape_cmd ("urls", class_run, _("\
Set the list of debuginfod server URLs."), _("\
Show the list of debuginfod server URLs."), _("\
Manage the space-separated list of debuginfod server URLs that GDB will query \
when missing debuginfo, executables or source files.\nThe default value is \
copied from the DEBUGINFOD_URLS environment variable."),
Manage the space-separated list of debuginfod server URLs that GDB will\n\
query when missing debuginfo, executables or source files.\n\
The default value is copied from the DEBUGINFOD_URLS environment variable."),
set_debuginfod_urls,
get_debuginfod_urls,
show_debuginfod_urls,
@ -657,9 +657,9 @@ query.\nTo disable, set to zero. Verbose output is displayed by default."),
add_setshow_boolean_cmd ("download-sections", class_maintenance, _("\
Set whether debuginfod may download individual ELF/DWARF sections."), _("\
Show whether debuginfod may download individual ELF/DWARF sections."), _("\
When enabled, debuginfod may attempt to download individual ELF/DWARF \
sections from debug info files.\nIf disabled, only whole debug info files \
may be downloaded."),
When enabled, debuginfod may attempt to download individual ELF/DWARF\n\
sections from debug info files.\n\
If disabled, only whole debug info files may be downloaded."),
maint_set_debuginfod_download_sections,
maint_get_debuginfod_download_sections,
nullptr,

View File

@ -4124,13 +4124,13 @@ _initialize_dwarf2loc ()
{
add_setshow_zuinteger_cmd ("entry-values", class_maintenance,
&entry_values_debug,
_("Set entry values and tail call frames "
"debugging."),
_("Show entry values and tail call frames "
"debugging."),
_("When non-zero, the process of determining "
"parameter values from function entry point "
"and tail call frames will be printed."),
_("\
Set entry values and tail call frames debugging."),
_("\
Show entry values and tail call frames debugging."),
_("\
When non-zero, the process of determining parameter values from\n\
function entry point and tail call frames will be printed."),
NULL,
show_entry_values_debug,
&setdebuglist, &showdebuglist);

View File

@ -1543,8 +1543,8 @@ Set whether CTF is always read."),
_("\
Show whether CTF is always read."),
_("\
When off, CTF is only read if DWARF is not present. When on, CTF is read\
regardless of whether DWARF is present."),
When off, CTF is only read if DWARF is not present. When on, CTF is read\n\
regardless of whether DWARF is present."),
nullptr /* set_func */, nullptr /* show_func */,
&setlist, &showlist);
}

View File

@ -376,7 +376,8 @@ _initialize_frame_unwind ()
add_cmd ("frame-unwinders",
class_maintenance,
maintenance_info_frame_unwinders,
_("List the frame unwinders currently in effect, "
"starting with the highest priority."),
_("\
List the frame unwinders currently in effect.\n\
Unwinders are listed starting with the highest priority."),
&maintenanceinfolist);
}

View File

@ -3282,8 +3282,10 @@ frame."));
add_com_alias ("u", until_cmd, class_run, 1);
c = add_com ("advance", class_run, advance_command, _("\
Continue the program up to the given location (same form as args for break \
command).\n\
Continue the program up to the given location.\n\
Usage: advance LOCSPEC\n\
The argument is a location specification, i.e., the same forms\n\
accepted by the 'break' command.\n\
Execution will also stop upon exit from the current stack frame."));
set_cmd_completer (c, location_completer);

View File

@ -595,8 +595,7 @@ void
_initialize_mem ()
{
add_com ("mem", class_vars, mem_command, _("\
Define attributes for memory region or reset memory region handling to "
"target-based.\n\
Define or reset attributes for memory regions.\n\
Usage: mem auto\n\
mem LOW HIGH [MODE WIDTH CACHE],\n\
where MODE may be rw (read/write), ro (read-only) or wo (write-only),\n\

View File

@ -1560,7 +1560,8 @@ Usage: mt print psymbols [-objfile OBJFILE] [-pc ADDRESS] [--] [OUTFILE]\n\
mt print psymbols [-objfile OBJFILE] [-source SOURCE] [--] [OUTFILE]\n\
Entries in the partial symbol table are dumped to file OUTFILE,\n\
or the terminal if OUTFILE is unspecified.\n\
If ADDRESS is provided, dump only the symbols for the file with code at that address.\n\
If ADDRESS is provided, dump only the symbols for the file\n\
with code at that address.\n\
If SOURCE is provided, dump only that file's symbols.\n\
If OBJFILE is provided, dump only that object file's symbols."),
&maintenanceprintlist);

View File

@ -3253,10 +3253,10 @@ Set what memory accesses are allowed during replay."), _("\
Show what memory accesses are allowed during replay."),
_("Default is READ-ONLY.\n\n\
The btrace record target does not trace data.\n\
The memory therefore corresponds to the live target and not \
The memory therefore corresponds to the live target and not\n\
to the current replay position.\n\n\
When READ-ONLY, allow accesses to read-only memory during replay.\n\
When READ-WRITE, allow accesses to read-only and read-write memory during \
When READ-WRITE, allow accesses to read-only and read-write memory during\n\
replay."),
NULL, cmd_show_replay_memory_access,
&set_record_btrace_cmdlist,
@ -3300,10 +3300,10 @@ Show the cpu to be used for trace decode."),
&record_btrace_conf.bts.size,
_("Set the record/replay bts buffer size."),
_("Show the record/replay bts buffer size."), _("\
When starting recording request a trace buffer of this size. \
The actual buffer size may differ from the requested size. \
When starting recording request a trace buffer of this size.\n\
The actual buffer size may differ from the requested size.\n\
Use \"info record\" to see the actual buffer size.\n\n\
Bigger buffers allow longer recording but also take more time to process \
Bigger buffers allow longer recording but also take more time to process\n\
the recorded execution trace.\n\n\
The trace buffer size may not be changed while recording."), NULL,
show_record_bts_buffer_size_value,
@ -3322,9 +3322,9 @@ The trace buffer size may not be changed while recording."), NULL,
&record_btrace_conf.pt.size,
_("Set the record/replay pt buffer size."),
_("Show the record/replay pt buffer size."), _("\
Bigger buffers allow longer recording but also take more time to process \
Bigger buffers allow longer recording but also take more time to process\n\
the recorded execution.\n\
The actual buffer size may differ from the requested size. Use \"info record\" \
The actual buffer size may differ from the requested size. Use \"info record\"\n\
to see the actual buffer size."), NULL, show_record_pt_buffer_size_value,
&set_record_btrace_pt_cmdlist,
&show_record_btrace_pt_cmdlist);
@ -3333,9 +3333,9 @@ to see the actual buffer size."), NULL, show_record_pt_buffer_size_value,
_("Set event-tracing for record pt."),
_("Show event-tracing for record pt."),
_("\
Use \"on\" to enable event tracing for recordings with Intel Processor Trace, \
Use \"on\" to enable event tracing for recordings with Intel Processor Trace,\n\
and \"off\" to disable it.\n\
Without an argument, event tracing is enabled. Changing this setting has no\
Without an argument, event tracing is enabled. Changing this setting has no\n\
effect on an active recording."),
set_record_pt_event_tracing_value,
show_record_pt_event_tracing_value,

View File

@ -2987,8 +2987,8 @@ When ON, query if PREC cannot record memory change of next instruction."),
_("\
Print a recorded instruction.\n\
If no argument is provided, print the last instruction recorded.\n\
If a negative argument is given, prints how the nth previous \
If a negative argument is given, prints how the nth previous\n\
instruction will be undone.\n\
If a positive argument is given, prints \
If a positive argument is given, prints\n\
how the nth following instruction will be redone."), &maintenanceprintlist);
}

View File

@ -865,25 +865,25 @@ With a /m or /s modifier, source lines are included (if available).\n\
With a /r modifier, raw instructions in hex are included.\n\
With a /f modifier, function names are omitted.\n\
With a /p modifier, current position markers are omitted.\n\
With a /a modifier, omits output of auxiliary data, which is enabled \
With a /a modifier, omits output of auxiliary data, which is enabled\n\
by default.\n\
With no argument, disassembles ten more instructions after the previous \
With no argument, disassembles ten more instructions after the previous\n\
disassembly.\n\
\"record instruction-history -\" disassembles ten instructions before a \
\"record instruction-history -\" disassembles ten instructions before a\n\
previous disassembly.\n\
One argument specifies an instruction number as shown by 'info record', and \
One argument specifies an instruction number as shown by 'info record', and\n\
ten instructions are disassembled after that instruction.\n\
Two arguments with comma between them specify starting and ending instruction \
Two arguments with comma between them specify starting and ending instruction\n\
numbers to disassemble.\n\
If the second argument is preceded by '+' or '-', it specifies the distance \
If the second argument is preceded by '+' or '-', it specifies the distance\n\
from the first argument.\n\
The number of instructions to disassemble can be defined with \"set record \
instruction-history-size\"."),
The number of instructions to disassemble can be defined with\n\
\"set record instruction-history-size\"."),
&record_cmdlist);
add_cmd ("function-call-history", class_obscure, cmd_record_call_history, _("\
Prints the execution history at function granularity.\n\
It prints one line for each sequence of instructions that belong to the same \
It prints one line for each sequence of instructions that belong to the same\n\
function.\n\
Without modifiers, it prints the function name.\n\
With a /l modifier, the source file and line number range is included.\n\
@ -892,15 +892,15 @@ With a /c modifier, the output is indented based on the call stack depth.\n\
With a /a modifier, omits output of auxiliary data, which is enabled \
by default.\n\
With no argument, prints ten more lines after the previous ten-line print.\n\
\"record function-call-history -\" prints ten lines before a previous ten-line \
\"record function-call-history -\" prints ten lines before a previous ten-line\n\
print.\n\
One argument specifies a function number as shown by 'info record', and \
One argument specifies a function number as shown by 'info record', and\n\
ten lines are printed after that function.\n\
Two arguments with comma between them specify a range of functions to print.\n\
If the second argument is preceded by '+' or '-', it specifies the distance \
If the second argument is preceded by '+' or '-', it specifies the distance\n\
from the first argument.\n\
The number of functions to print can be defined with \"set record \
function-call-history-size\"."),
The number of functions to print can be defined with\n\
\"set record function-call-history-size\"."),
&record_cmdlist);
/* Sync command control variables. */

View File

@ -329,11 +329,11 @@ _initialize_regcache_dump ()
"Takes an optional file parameter."),
&maintenanceprintlist);
add_cmd ("remote-registers", class_maintenance,
maintenance_print_remote_registers,
_("Print the internal register configuration including remote "
"register number and g/G packets offset.\n"
"Also prints which registers were sent in the last stop reply "
"packet (i.e. expedited).\n"
"Takes an optional file parameter."),
maintenance_print_remote_registers, _("\
Print the internal register configuration.\n\
Usage: maintenance print remote-registers [FILE]\n\
The remote register number and g/G packets offset are included,\n\
as well as which registers were sent in the last stop reply packet\n\
(i.e., expedited)."),
&maintenanceprintlist);
}

View File

@ -1758,8 +1758,9 @@ _initialize_stap_probe ()
&stap_expression_debug,
_("Set SystemTap expression debugging."),
_("Show SystemTap expression debugging."),
_("When non-zero, the internal representation "
"of SystemTap expressions will be printed."),
_("\
When non-zero, the internal representation of SystemTap expressions\n\
will be printed."),
NULL,
show_stapexpressiondebug,
&setdebuglist, &showdebuglist);

View File

@ -3868,8 +3868,8 @@ to execute.\n" READNOW_READNEVER_HELP), &cmdlist);
c = add_cmd ("add-symbol-file", class_files, add_symbol_file_command, _("\
Load symbols from FILE, assuming FILE has been dynamically loaded.\n\
Usage: add-symbol-file FILE [-readnow | -readnever] [-o OFF] [ADDR] \
[-s SECT-NAME SECT-ADDR]...\n\
Usage: add-symbol-file FILE [-readnow|-readnever] [-o OFF] [ADDR]\n\
[-s SECT-NAME SECT-ADDR]...\n\
ADDR is the starting address of the file's text.\n\
Each '-s' argument provides a section name and address, and\n\
should be specified if the data and bss segments are not contiguous\n\
@ -3975,8 +3975,9 @@ full == print messages for the executable,\n\
&separate_debug_file_debug, _("\
Set printing of separate debug info file search debug."), _("\
Show printing of separate debug info file search debug."), _("\
When on, GDB prints the searched locations while looking for separate debug \
info files."), NULL, NULL, &setdebuglist, &showdebuglist);
When on, GDB prints the searched locations while looking for separate\n\
debug info files."),
NULL, NULL, &setdebuglist, &showdebuglist);
#if GDB_SELF_TEST
selftests::register_test

View File

@ -1061,7 +1061,8 @@ Usage: mt print symbols [-pc ADDRESS] [--] [OUTFILE]\n\
mt print symbols [-objfile OBJFILE] [-source SOURCE] [--] [OUTFILE]\n\
Entries in the full symbol table are dumped to file OUTFILE,\n\
or the terminal if OUTFILE is unspecified.\n\
If ADDRESS is provided, dump only the symbols for the file with code at that address.\n\
If ADDRESS is provided, dump only the symbols for the file\n\
with code at that address.\n\
If SOURCE is provided, dump only that file's symbols.\n\
If OBJFILE is provided, dump only that object file's symbols."),
&maintenanceprintlist);

View File

@ -7259,8 +7259,8 @@ If zero then the symbol cache is disabled."),
_("Set if the PROLOGUE-END flag is ignored."),
_("Show if the PROLOGUE-END flag is ignored."),
_("\
The PROLOGUE-END flag from the line-table entries is used to place \
breakpoints past the prologue of functions. Disabling its use forces \
The PROLOGUE-END flag from the line-table entries is used to place\n\
breakpoints past the prologue of functions. Disabling its use forces\n\
the use of prologue scanners."),
nullptr, nullptr,
&maintenance_set_cmdlist,

View File

@ -875,8 +875,8 @@ Show printing of typedefs defined in classes."), NULL,
add_setshow_zuinteger_unlimited_cmd ("nested-type-limit", no_class,
&print_nested_type_limit,
_("\
Set the number of recursive nested type definitions to print \
(\"unlimited\" or -1 to show all)."), _("\
Set the number of recursive nested type definitions to print.\n\
Use \"unlimited\" or -1 to show all."), _("\
Show the number of recursive nested type definitions to print."), NULL,
set_print_type_nested_types,
show_print_type_nested_types,

View File

@ -3266,7 +3266,7 @@ _initialize_xtensa_tdep ()
&xtensa_debug_level,
_("Set Xtensa debugging."),
_("Show Xtensa debugging."), _("\
When non-zero, Xtensa-specific debugging is enabled. \
When non-zero, Xtensa-specific debugging is enabled.\n\
Can be 1, 2, 3, or 4 indicating the level of debugging."),
NULL,
NULL,