[3/3] gcore/doc: fix mistake in the gcore man page

Message ID 1f75c841fe44eb4bbf8c9630ff4e4b128a462c7f.1741280898.git.aburgess@redhat.com
State New
Headers
Series gcore: add --help and --version options |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Build passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Build passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Test passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Test passed

Commit Message

Andrew Burgess March 6, 2025, 5:10 p.m. UTC
  The gcore man page says that the default prefix for a generated core
file will be 'gcore', i.e. we'll create files like 'gcore.pid'.  In
reality the default is 'core'.

As far as I can tell, the default has been 'core' for years, and the
docs used to say that the default was 'core', but the docs were
changed by mistake in commit:

  commit 129eb0f1f16dc7a49799a024a7bcb109d954a1e7
  Date:   Fri Jul 27 00:52:23 2018 -0400

      Improve gcore manpage and clarify "-o" option

So, lets bring the docs back inline with the code.
---
 gdb/doc/gdb.texinfo | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Eli Zaretskii March 6, 2025, 5:32 p.m. UTC | #1
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Thu,  6 Mar 2025 17:10:24 +0000
> 
> The gcore man page says that the default prefix for a generated core
> file will be 'gcore', i.e. we'll create files like 'gcore.pid'.  In
> reality the default is 'core'.
> 
> As far as I can tell, the default has been 'core' for years, and the
> docs used to say that the default was 'core', but the docs were
> changed by mistake in commit:
> 
>   commit 129eb0f1f16dc7a49799a024a7bcb109d954a1e7
>   Date:   Fri Jul 27 00:52:23 2018 -0400
> 
>       Improve gcore manpage and clarify "-o" option
> 
> So, lets bring the docs back inline with the code.
> ---
>  gdb/doc/gdb.texinfo | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

This is okay, thanks.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>
  

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index a1ae45c5121..5a8f8bddc05 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -51414,7 +51414,7 @@  gcore man
 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}.
+If not specified, @var{prefix} defaults to @var{core}.
 
 @item -d @var{directory}
 Use @var{directory} as the data directory when invoking @value{GDBN} for running