binutils-gdb/gdb/doc
Sergio Durigan Junior 129eb0f1f1 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.
2018-07-27 15:56:54 -04:00
..
.gitignore Update and add .gitignore's 2016-09-21 13:12:21 -04:00
a4rc.sed
agentexpr.texi Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
all-cfg.texi Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
annotate.texinfo Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
ChangeLog Improve gcore manpage and clarify "-o" option 2018-07-27 15:56:54 -04:00
doxy-index.in Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
Doxyfile-base.in Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
Doxyfile-gdb-api.in Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
Doxyfile-gdb-xref.in Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
Doxyfile-gdbserver.in Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
fdl.texi
filter-for-doxygen
filter-params.pl
gdb.texinfo Improve gcore manpage and clarify "-o" option 2018-07-27 15:56:54 -04:00
gpl.texi
guile.texi Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
lpsrc.sed
Makefile.in Install and generate docs for gdb-add-index 2018-01-12 15:29:06 -05:00
psrc.sed
python.texi Fix "set" handling of Python parameters 2018-05-31 15:02:01 -06:00
refcard.tex Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
stabs.texinfo Update copyright year range in all GDB files 2018-01-02 07:38:06 +04:00
stack_frame.eps
stack_frame.pdf
stack_frame.png
stack_frame.svg
stack_frame.txt