diff mbox series

[1/3] gcore: add -v or --version option to show version number

Message ID e9327d007606a588e2bb52e856670b891f952e90.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-aarch64 success Test passed

Commit Message

Andrew Burgess March 6, 2025, 5:10 p.m. UTC 
  Based on the work in this commit:

  commit fb2ded33c1e519659743047ed7817166545b6d91
  Date:   Fri Dec 20 12:46:11 2024 -0800

      Add gstack script

This commit adds a '-v' or '--version' option to the existing gcore
script.  This new option causes the script to print its version
number, and then exit.

I needed to adjust the getopts handling a little in order to support
the long form '--version' argument, but as this makes gcore more
consistent with gstack, then this seems like a good thing.

The usage message is now getting a little long.  Don't worry, I plan
to clean that up in the next commit.
---
 gdb/Makefile.in              |  7 ++-----
 gdb/NEWS                     |  3 +++
 gdb/configure                |  5 ++---
 gdb/configure.ac             |  2 +-
 gdb/doc/gdb.texinfo          |  7 ++++++-
 gdb/{gcore.in => gcore-1.in} | 23 ++++++++++++++++++++---
 6 files changed, 34 insertions(+), 13 deletions(-)
 rename gdb/{gcore.in => gcore-1.in} (88%)

Comments

Eli Zaretskii March 6, 2025, 5:31 p.m. UTC | #1 
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Thu,  6 Mar 2025 17:10:22 +0000
> 
> Based on the work in this commit:
> 
>   commit fb2ded33c1e519659743047ed7817166545b6d91
>   Date:   Fri Dec 20 12:46:11 2024 -0800
> 
>       Add gstack script
> 
> This commit adds a '-v' or '--version' option to the existing gcore
> script.  This new option causes the script to print its version
> number, and then exit.
> 
> I needed to adjust the getopts handling a little in order to support
> the long form '--version' argument, but as this makes gcore more
> consistent with gstack, then this seems like a good thing.
> 
> The usage message is now getting a little long.  Don't worry, I plan
> to clean that up in the next commit.
> ---
>  gdb/Makefile.in              |  7 ++-----
>  gdb/NEWS                     |  3 +++
>  gdb/configure                |  5 ++---
>  gdb/configure.ac             |  2 +-
>  gdb/doc/gdb.texinfo          |  7 ++++++-
>  gdb/{gcore.in => gcore-1.in} | 23 ++++++++++++++++++++---
>  6 files changed, 34 insertions(+), 13 deletions(-)
>  rename gdb/{gcore.in => gcore-1.in} (88%)

Thanks, the documentation parts are okay.

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

Patch

diff --git a/gdb/Makefile.in b/gdb/Makefile.in
index 1619c8253dc..a87e9520ffe 100644
--- a/gdb/Makefile.in
+++ b/gdb/Makefile.in
@@ -2347,18 +2347,15 @@  run: Makefile
 jit-reader.h: $(srcdir)/jit-reader.in config.status
 	$(ECHO_GEN) $(SHELL) config.status $(SILENT_FLAG) $@
 
-gcore: $(srcdir)/gcore.in config.status
+gstack.in gcore.in: %.in : $(srcdir)/%-1.in config.status
 	$(ECHO_GEN) $(SHELL) config.status $(SILENT_FLAG) $@
 
-gstack: gstack.in version.c
+gstack gcore: % : %.in version.c
 	$(ECHO_GEN) \
 	vv=`grep 'version\[\] = ' version.c | grep -o '".*"' | tr -d \"`; \
 	sed -e "s,@VERSION@,$$vv," $< > $@
 	@chmod +x $@
 
-gstack.in: $(srcdir)/gstack-1.in config.status
-	$(ECHO_GEN) $(SHELL) config.status $(SILENT_FLAG) $@
-
 gdb-gdb.py: $(srcdir)/gdb-gdb.py.in config.status
 	$(ECHO_GEN) $(SHELL) config.status $(SILENT_FLAG) $@
 
diff --git a/gdb/NEWS b/gdb/NEWS
index f5dbf5c3350..d4453914755 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -26,6 +26,9 @@ 
 
 * Linux checkpoint code has been updated to work with multiple inferiors.
 
+* The gcore script now has a -v or --version option, which prints the
+  version number, and then exits.
+
 * New commands
 
 maintenance check psymtabs
diff --git a/gdb/configure b/gdb/configure
index bdc405e01b3..3e990064197 100755
--- a/gdb/configure
+++ b/gdb/configure
@@ -33775,7 +33775,7 @@  fi
   fi
 
 
-ac_config_files="$ac_config_files gcore"
+ac_config_files="$ac_config_files gcore.in:gcore-1.in"
 
 ac_config_files="$ac_config_files gstack.in:gstack-1.in"
 
@@ -34878,7 +34878,7 @@  do
     "default-1") CONFIG_COMMANDS="$CONFIG_COMMANDS default-1" ;;
     "jit-reader.h") CONFIG_FILES="$CONFIG_FILES jit-reader.h:jit-reader.in" ;;
     "nm.h") CONFIG_LINKS="$CONFIG_LINKS nm.h:$GDB_NM_FILE" ;;
-    "gcore") CONFIG_FILES="$CONFIG_FILES gcore" ;;
+    "gcore.in") CONFIG_FILES="$CONFIG_FILES gcore.in:gcore-1.in" ;;
     "gstack.in") CONFIG_FILES="$CONFIG_FILES gstack.in:gstack-1.in" ;;
     "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;;
     "gdb-gdb.gdb") CONFIG_FILES="$CONFIG_FILES gdb-gdb.gdb" ;;
@@ -36425,7 +36425,6 @@  _LT_EOF
       esac
     done ;;
     "nm.h":L) echo > stamp-nmh ;;
-    "gcore":F) chmod +x gcore ;;
 
   esac
 done # for ac_tag
diff --git a/gdb/configure.ac b/gdb/configure.ac
index fb77e79e73b..4604a2d8e87 100644
--- a/gdb/configure.ac
+++ b/gdb/configure.ac
@@ -2278,7 +2278,7 @@  GDB_AC_SELFTEST([
 
 GDB_AC_TRANSFORM([gdb], [GDB_TRANSFORM_NAME])
 GDB_AC_TRANSFORM([gcore], [GCORE_TRANSFORM_NAME])
-AC_CONFIG_FILES([gcore], [chmod +x gcore])
+AC_CONFIG_FILES([gcore.in:gcore-1.in])
 AC_CONFIG_FILES([gstack.in:gstack-1.in])
 AC_CONFIG_FILES([Makefile gdb-gdb.gdb gdb-gdb.py doc/Makefile data-directory/Makefile])
 
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 29c0118dda2..1ab87dd37f9 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -51386,7 +51386,8 @@  gcore man
 
 @format
 @c man begin SYNOPSIS gcore
-gcore [-a] [-o @var{prefix}] [-d @var{directory}] @var{pid1} [@var{pid2}...@var{pidN}]
+gcore [-v | --version] [-a] [-o @var{prefix}] [-d @var{directory}]
+      @var{pid1} [@var{pid2}...@var{pidN}]
 @c man end
 @end format
 
@@ -51418,6 +51419,10 @@  gcore man
 @item -d @var{directory}
 Use @var{directory} as the data directory when invoking @value{GDBN} for running
 the gcore command. This argument is optional.
+
+@item --version
+@itemx -v
+Print version information and then exit.
 @end table
 @c man end
 
diff --git a/gdb/gcore.in b/gdb/gcore-1.in
similarity index 88%
rename from gdb/gcore.in
rename to gdb/gcore-1.in
index 0c40e5a54cd..ce2f7321148 100644
--- a/gdb/gcore.in
+++ b/gdb/gcore-1.in
@@ -20,6 +20,9 @@ 
 # It starts up gdb, attaches to the given PID and invokes the gcore command.
 #
 
+PKGVERSION=@PKGVERSION@
+VERSION=@VERSION@
+
 # Need to check for -o option, but set default basename to "core".
 prefix=core
 
@@ -29,8 +32,18 @@  dump_all_cmds=()
 
 data_directory_opt=()
 
-while getopts :ao:d: opt; do
-    case "$opt" in
+function print_version() {
+    echo "GNU gcore (${PKGVERSION}) ${VERSION}"
+}
+
+while getopts :vao:d:-: OPT; do
+    if [ "$OPT" = "-" ]; then
+	OPT="${OPTARG%%=*}"
+	OPTARG="${OPTARG#'$OPT'}"
+	OPTARG="${OPTARG#=}"
+    fi
+
+    case "$OPT" in
         a)
             case "$OSTYPE" in
                 linux*)
@@ -45,8 +58,12 @@  while getopts :ao:d: opt; do
         d)
             data_directory_opt=("--data-directory" "$OPTARG")
             ;;
+	v | version)
+	    print_version
+	    exit 0
+	    ;;
         *)
-            echo "usage:  @GCORE_TRANSFORM_NAME@ [-a] [-o prefix] [-d data-directory] pid1 [pid2...pidN]"
+            echo "usage:  @GCORE_TRANSFORM_NAME@ [-v | --version] [-a] [-o prefix] [-d data-directory] pid1 [pid2...pidN]"
             exit 2
             ;;
     esac