[v3,4/5] Document the new "-a" command line option for gcore

Message ID 874lp65sh5.fsf@redhat.com
State New, archived
Headers

Commit Message

Sergio Durigan Junior Dec. 4, 2017, 5:10 p.m. UTC
  On Monday, December 04 2017, Eli Zaretskii wrote:

>> From: Sergio Lopez <slp@redhat.com>
>> Cc: Sergio Lopez <slp@redhat.com>
>> Date: Mon,  4 Dec 2017 09:17:15 +0100
>> 
>> gdb/ChangeLog:
>> 2017-11-29  Sergio Lopez  <slp@redhat.com>
>> 
>> 	* NEWS (Changes since GDB 8.0): Announce new "-a"
>> 	command line option for gcore.
>> 
>> gdb/doc/ChangeLog:
>> 2017-11-29  Sergio Lopez  <slp@redhat.com>
>> 
>> 	* gdb.texinfo (gcore man): Document new "-a" command line option.
>
> OK, but...
>
>>  @c man begin OPTIONS gcore
>>  @table @env
>> +@item -a
>> +Dump all memory mappings.  The actual effect of this option depends on the
>> +Operating System.  On @sc{gnu}/Linux, it will disable
>> +@code{use-coredump-filter} and enable @code{dump-excluded-mappings}.
>
> ...should we have a cross-reference here to where the above commands
> are described?

Pedro approved the patches and I pushed them for Sergio.  I also took
the liberty to address Eli's comment before applying the patches.
here's the diff against Sergio's original patch.

Thanks,
  

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 1c383b4d47..3b251c60c1 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -43063,9 +43063,11 @@  running without any change.
 @c man begin OPTIONS gcore
 @table @env
 @item -a
-Dump all memory mappings.  The actual effect of this option depends on the
-Operating System.  On @sc{gnu}/Linux, it will disable
-@code{use-coredump-filter} and enable @code{dump-excluded-mappings}.
+Dump all memory mappings.  The actual effect of this option depends on
+the Operating System.  On @sc{gnu}/Linux, it will disable
+@code{use-coredump-filter} (@pxref{set use-coredump-filter}) and
+enable @code{dump-excluded-mappings} (@pxref{set
+dump-excluded-mappings}).
 
 @item -o @var{filename}
 The optional argument