From 5a29c7fa895a14112a1ac65e541f4b87ae9dba04 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Tue, 23 Mar 2010 00:09:32 +0800 Subject: automatically include program version and print it from vty and --version --- openbsc/.gitignore | 3 + openbsc/Makefile.am | 7 +- openbsc/configure.in | 6 +- openbsc/git-version-gen | 151 +++++++++++++++++++++++++++++++++++++++++ openbsc/src/bsc_hack.c | 30 +++++++- openbsc/src/mgcp/mgcp_main.c | 23 ++++++- openbsc/src/telnet_interface.c | 15 ++-- openbsc/src/vty/cardshell.h | 5 +- 8 files changed, 221 insertions(+), 19 deletions(-) create mode 100755 openbsc/git-version-gen (limited to 'openbsc') diff --git a/openbsc/.gitignore b/openbsc/.gitignore index 267c906ec..f9681147a 100644 --- a/openbsc/.gitignore +++ b/openbsc/.gitignore @@ -23,6 +23,9 @@ install-sh missing stamp-h1 +# git-version-gen magic +.tarball-version +.version # apps and app data diff --git a/openbsc/Makefile.am b/openbsc/Makefile.am index 7acae7512..4ce11cec5 100644 --- a/openbsc/Makefile.am +++ b/openbsc/Makefile.am @@ -6,5 +6,8 @@ SUBDIRS = include src tests pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = openbsc.pc libsccp.pc -#dist-hook: -# rm -rf `find $(distdir) -name .svn` +BUILT_SOURCES = $(top_srcdir)/.version +$(top_srcdir)/.version: + echo $(VERSION) > $@-t && mv $@-t $@ +dist-hook: + echo $(VERSION) > $(distdir)/.tarball-version diff --git a/openbsc/configure.in b/openbsc/configure.in index 71ed10b5f..9e3c486a6 100644 --- a/openbsc/configure.in +++ b/openbsc/configure.in @@ -1,7 +1,9 @@ dnl Process this file with autoconf to produce a configure script -AC_INIT +AC_INIT([openbsc], + m4_esyscmd([./git-version-gen .tarball-version]), + [openbsc-devel@lists.openbsc.org]) -AM_INIT_AUTOMAKE(openbsc, 0.0alpha1) +AM_INIT_AUTOMAKE([dist-bzip2]) dnl kernel style compile messages m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) diff --git a/openbsc/git-version-gen b/openbsc/git-version-gen new file mode 100755 index 000000000..f2ad4a762 --- /dev/null +++ b/openbsc/git-version-gen @@ -0,0 +1,151 @@ +#!/bin/sh +# Print a version string. +scriptversion=2010-01-28.01 + +# Copyright (C) 2007-2010 Free Software Foundation, Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# This script is derived from GIT-VERSION-GEN from GIT: http://git.or.cz/. +# It may be run two ways: +# - from a git repository in which the "git describe" command below +# produces useful output (thus requiring at least one signed tag) +# - from a non-git-repo directory containing a .tarball-version file, which +# presumes this script is invoked like "./git-version-gen .tarball-version". + +# In order to use intra-version strings in your project, you will need two +# separate generated version string files: +# +# .tarball-version - present only in a distribution tarball, and not in +# a checked-out repository. Created with contents that were learned at +# the last time autoconf was run, and used by git-version-gen. Must not +# be present in either $(srcdir) or $(builddir) for git-version-gen to +# give accurate answers during normal development with a checked out tree, +# but must be present in a tarball when there is no version control system. +# Therefore, it cannot be used in any dependencies. GNUmakefile has +# hooks to force a reconfigure at distribution time to get the value +# correct, without penalizing normal development with extra reconfigures. +# +# .version - present in a checked-out repository and in a distribution +# tarball. Usable in dependencies, particularly for files that don't +# want to depend on config.h but do want to track version changes. +# Delete this file prior to any autoconf run where you want to rebuild +# files to pick up a version string change; and leave it stale to +# minimize rebuild time after unrelated changes to configure sources. +# +# It is probably wise to add these two files to .gitignore, so that you +# don't accidentally commit either generated file. +# +# Use the following line in your configure.ac, so that $(VERSION) will +# automatically be up-to-date each time configure is run (and note that +# since configure.ac no longer includes a version string, Makefile rules +# should not depend on configure.ac for version updates). +# +# AC_INIT([GNU project], +# m4_esyscmd([build-aux/git-version-gen .tarball-version]), +# [bug-project@example]) +# +# Then use the following lines in your Makefile.am, so that .version +# will be present for dependencies, and so that .tarball-version will +# exist in distribution tarballs. +# +# BUILT_SOURCES = $(top_srcdir)/.version +# $(top_srcdir)/.version: +# echo $(VERSION) > $@-t && mv $@-t $@ +# dist-hook: +# echo $(VERSION) > $(distdir)/.tarball-version + +case $# in + 1) ;; + *) echo 1>&2 "Usage: $0 \$srcdir/.tarball-version"; exit 1;; +esac + +tarball_version_file=$1 +nl=' +' + +# First see if there is a tarball-only version file. +# then try "git describe", then default. +if test -f $tarball_version_file +then + v=`cat $tarball_version_file` || exit 1 + case $v in + *$nl*) v= ;; # reject multi-line output + [0-9]*) ;; + *) v= ;; + esac + test -z "$v" \ + && echo "$0: WARNING: $tarball_version_file seems to be damaged" 1>&2 +fi + +if test -n "$v" +then + : # use $v +elif test -d ./../.git \ + && v=`git describe --abbrev=4 --match='v*' HEAD 2>/dev/null \ + || git describe --abbrev=4 HEAD 2>/dev/null` \ + && case $v in + [0-9]*) ;; + v[0-9]*) ;; + *) (exit 1) ;; + esac +then + # Is this a new git that lists number of commits since the last + # tag or the previous older version that did not? + # Newer: v6.10-77-g0f8faeb + # Older: v6.10-g0f8faeb + case $v in + *-*-*) : git describe is okay three part flavor ;; + *-*) + : git describe is older two part flavor + # Recreate the number of commits and rewrite such that the + # result is the same as if we were using the newer version + # of git describe. + vtag=`echo "$v" | sed 's/-.*//'` + numcommits=`git rev-list "$vtag"..HEAD | wc -l` + v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`; + ;; + esac + + # Change the first '-' to a '.', so version-comparing tools work properly. + # Remove the "g" in git describe's output string, to save a byte. + v=`echo "$v" | sed 's/-/./;s/\(.*\)-g/\1-/'`; +else + v=UNKNOWN +fi + +v=`echo "$v" |sed 's/^v//'` + +# Don't declare a version "dirty" merely because a time stamp has changed. +git status > /dev/null 2>&1 + +dirty=`sh -c 'git diff-index --name-only HEAD' 2>/dev/null` || dirty= +case "$dirty" in + '') ;; + *) # Append the suffix only if there isn't one already. + case $v in + *-dirty) ;; + *) v="$v-dirty" ;; + esac ;; +esac + +# Omit the trailing newline, so that m4_esyscmd can use the result directly. +echo "$v" | tr -d '\012' + +# Local variables: +# eval: (add-hook 'write-file-hooks 'time-stamp) +# time-stamp-start: "scriptversion=" +# time-stamp-format: "%:y-%02m-%02d.%02H" +# time-stamp-end: "$" +# End: diff --git a/openbsc/src/bsc_hack.c b/openbsc/src/bsc_hack.c index 49c9d36ef..2405ceebd 100644 --- a/openbsc/src/bsc_hack.c +++ b/openbsc/src/bsc_hack.c @@ -37,12 +37,21 @@ #include #include +#include "../bscconfig.h" + /* MCC and MNC for the Location Area Identifier */ static struct debug_target *stderr_target; struct gsm_network *bsc_gsmnet = 0; static const char *database_name = "hlr.sqlite3"; static const char *config_file = "openbsc.cfg"; - +const char *openbsc_version = "OpenBSC " PACKAGE_VERSION; +const char *openbsc_copyright = + "Copyright (C) 2008-2010 Harald Welte, Holger Freyther\n" + "Contributions by Daniel Willmann, Jan Lübbe,Stefan Schmidt\n" + "Dieter Spaar, Andreas Eversberg\n\n" + "License GPLv2+: GNU GPL version 2 or later \n" + "This is free software: you are free to change and redistribute it.\n" + "There is NO WARRANTY, to the extent permitted by law.\n"; /* timer to store statistics */ #define DB_SYNC_INTERVAL 60, 0 @@ -83,6 +92,16 @@ static void print_help() printf(" -P --rtp-proxy Enable the RTP Proxy code inside OpenBSC\n"); } +static void print_version() +{ + printf("%s\n", openbsc_version); +} + +static void print_copyright() +{ + printf(openbsc_copyright); +} + static void handle_options(int argc, char** argv) { while (1) { @@ -96,11 +115,12 @@ static void handle_options(int argc, char** argv) {"authorize-everyone", 0, 0, 'a'}, {"pcap", 1, 0, 'p'}, {"timestamp", 0, 0, 'T'}, + {"version", 0, 0, 'V' }, {"rtp-proxy", 0, 0, 'P'}, {0, 0, 0, 0} }; - c = getopt_long(argc, argv, "hd:sl:ar:p:TPc:", + c = getopt_long(argc, argv, "hd:sl:ar:p:TPVc:", long_options, &option_index); if (c == -1) break; @@ -131,6 +151,12 @@ static void handle_options(int argc, char** argv) case 'P': ipacc_rtp_direct = 0; break; + case 'V': + print_version(); + printf("\n"); + print_copyright(); + exit(0); + break; default: /* ignore */ break; diff --git a/openbsc/src/mgcp/mgcp_main.c b/openbsc/src/mgcp/mgcp_main.c index cea0ba427..e45a1e981 100644 --- a/openbsc/src/mgcp/mgcp_main.c +++ b/openbsc/src/mgcp/mgcp_main.c @@ -40,6 +40,8 @@ #include #include +#include "../../bscconfig.h" + /* this is here for the vty... it will never be called */ void subscr_put() { abort(); } @@ -51,6 +53,14 @@ void subscr_put() { abort(); } static struct bsc_fd bfd; static int first_request = 1; static struct mgcp_config *cfg; +const char *openbsc_version = "OpenBSC MGCP " PACKAGE_VERSION; +const char *openbsc_copyright = + "Copyright (C) 2009-2010 Holger Freyther and On-Waves\n" + "Contributions by Daniel Willmann, Jan Lübbe,Stefan Schmidt\n" + "Dieter Spaar, Andreas Eversberg, Harald Welte\n\n" + "License GPLv2+: GNU GPL version 2 or later \n" + "This is free software: you are free to change and redistribute it.\n" + "There is NO WARRANTY, to the extent permitted by law.\n"; static char *config_file = "mgcp.cfg"; @@ -64,6 +74,12 @@ static void print_help() printf(" -c --config-file filename The config file to use.\n"); } +static void print_version() +{ + printf("%s\n\n", openbsc_version); + printf(openbsc_copyright); +} + static void handle_options(int argc, char** argv) { while (1) { @@ -71,10 +87,11 @@ static void handle_options(int argc, char** argv) static struct option long_options[] = { {"help", 0, 0, 'h'}, {"config-file", 1, 0, 'c'}, + {"version", 0, 0, 'V'}, {0, 0, 0, 0}, }; - c = getopt_long(argc, argv, "hc:", long_options, &option_index); + c = getopt_long(argc, argv, "hc:V", long_options, &option_index); if (c == -1) break; @@ -87,6 +104,10 @@ static void handle_options(int argc, char** argv) case 'c': config_file = talloc_strdup(tall_bsc_ctx, optarg); break; + case 'V': + print_version(); + exit(0); + break; default: /* ignore */ break; diff --git a/openbsc/src/telnet_interface.c b/openbsc/src/telnet_interface.c index 805dd127d..aa119b464 100644 --- a/openbsc/src/telnet_interface.c +++ b/openbsc/src/telnet_interface.c @@ -98,21 +98,16 @@ void telnet_init(struct gsm_network *network, int port) { bsc_register_fd(&server_socket); } +extern const char *openbsc_copyright; +extern const char *openbsc_version; + static void print_welcome(int fd) { int ret; static char *msg = - "Welcome to the OpenBSC Control interface\n" - "Copyright (C) 2008-2010 Harald Welte\n" - "Contributions by Daniel Willmann, Jan Lübbe, " - "Stefan Schmidt, Holger Freyther, Andreas Eversberg\n\n" - "License GPLv2+: GNU GPL version 2 or later " - "\n" - "This is free software: you are free to change " - "and redistribute it.\n" - "There is NO WARRANTY, to the extent permitted " - "by law.\nType \"help\" to get a short introduction.\n"; + "Welcome to the OpenBSC Control interface\n"; ret = write(fd, msg, strlen(msg)); + ret = write(fd, openbsc_copyright, strlen(openbsc_copyright)); } int telnet_close_client(struct bsc_fd *fd) { diff --git a/openbsc/src/vty/cardshell.h b/openbsc/src/vty/cardshell.h index d963a3810..85164d2bd 100644 --- a/openbsc/src/vty/cardshell.h +++ b/openbsc/src/vty/cardshell.h @@ -1,5 +1,6 @@ -#define QUAGGA_PROGNAME "OpenBSC" -#define QUAGGA_VERSION "0.01" +#include "../../bscconfig.h" +#define QUAGGA_PROGNAME PACKAGE_NAME +#define QUAGGA_VERSION PACKAGE_VERSION #define QUAGGA_COPYRIGHT "Harald Welte " #define CONFIGFILE_MASK 022 #define SYSCONFDIR "/usr/local/etc" -- cgit v1.2.3