diff options
author | Sergio Durigan Junior <sergiodj@redhat.com> | 2018-07-27 00:52:23 -0400 |
---|---|---|
committer | Sergio Durigan Junior <sergiodj@redhat.com> | 2018-07-27 15:56:54 -0400 |
commit | 129eb0f1f16dc7a49799a024a7bcb109d954a1e7 (patch) | |
tree | 849c60c6ccaf2b577240a5293e1f4cd1a4cf5cb1 /gdb/doc | |
parent | 1286ab788188bb8f0b0da2a3def4641fb3817f10 (diff) | |
download | binutils-gdb-129eb0f1f16dc7a49799a024a7bcb109d954a1e7.tar.gz |
Improve gcore manpage and clarify "-o" option
Ref.: https://bugs.debian.org/904628
It has been reported that gcore's manpage is a bit imprecise when it
comes to two things:
- It doesn't explicity say that the command accepts more than one PID
on its CLI.
- It fails to mention that the argument passed through the "-o" option
is actually a prefix that will be used to compose the corefile's
filename, and not the actual filename.
I decided to give it a try and rewrite parts of the text to further
clarify these two points. I ended up rewording the "Description"
section because, IMHO, it was a bit confuse to understand.
To make things consistent, I've also renamed the "$name" variable in
the gcore.in script, and expanded the usage text.
gdb/doc/ChangeLog:
2018-07-27 Sergio Durigan Junior <sergiodj@redhat.com>
* gdb.texinfo (gcore man): Rewrite "Description" and "-o"
option sections to further clarify that gcore can take more
than one PID, and that "-o" is used to specify a prefix, not a
filename.
gdb/ChangeLog:
2018-07-27 Sergio Durigan Junior <sergiodj@redhat.com>
* gcore.in: Rename variable "name" to "prefix". Expand
"usage" text.
Diffstat (limited to 'gdb/doc')
-rw-r--r-- | gdb/doc/ChangeLog | 7 | ||||
-rw-r--r-- | gdb/doc/gdb.texinfo | 24 |
2 files changed, 20 insertions, 11 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 1bcf9dfc167..90784b5ad60 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,10 @@ +2018-07-27 Sergio Durigan Junior <sergiodj@redhat.com> + + * gdb.texinfo (gcore man): Rewrite "Description" and "-o" + option sections to further clarify that gcore can take more + than one PID, and that "-o" is used to specify a prefix, not a + filename. + 2018-07-26 Andrew Burgess <andrew.burgess@embecosm.com> * gdb.texinfo (Maintenance Commands): Add description of diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index b95c2b4f49a..71aef2293fb 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -43765,16 +43765,17 @@ Richard M. Stallman and Roland H. Pesch, July 1991. @format @c man begin SYNOPSIS gcore -gcore [-a] [-o @var{filename}] @var{pid} +gcore [-a] [-o @var{prefix}] @var{pid1} [@var{pid2}...@var{pidN}] @c man end @end format @c man begin DESCRIPTION gcore -Generate a core dump of a running program with process ID @var{pid}. -Produced file is equivalent to a kernel produced core file as if the process -crashed (and if @kbd{ulimit -c} were used to set up an appropriate core dump -limit). Unlike after a crash, after @command{gcore} the program remains -running without any change. +Generate core dumps of one or more running programs with process IDs +@var{pid1}, @var{pid2}, etc. A core file produced by @command{gcore} +is equivalent to one produced by the kernel when the process crashes +(and when @kbd{ulimit -c} was used to set up an appropriate core dump +limit). However, unlike after a crash, after @command{gcore} finishes +its job the program remains running without any change. @c man end @c man begin OPTIONS gcore @@ -43786,11 +43787,12 @@ the Operating System. On @sc{gnu}/Linux, it will disable enable @code{dump-excluded-mappings} (@pxref{set dump-excluded-mappings}). -@item -o @var{filename} -The optional argument -@var{filename} specifies the file name where to put the core dump. -If not specified, the file name defaults to @file{core.@var{pid}}, -where @var{pid} is the running program process ID. +@item -o @var{prefix} +The optional argument @var{prefix} specifies the prefix to be used +when composing the file names of the core dumps. The file name is +composed as @file{@var{prefix}.@var{pid}}, where @var{pid} is the +process ID of the running program being analyzed by @command{gcore}. +If not specified, @var{prefix} defaults to @var{gcore}. @end table @c man end |