#
# Copyright 2004 Jörg Mayer (see AUTHORS file)
#
-# $Id$
-#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
# If "version.conf" is present, it is parsed for configuration values.
# Possible values are:
#
-# enable - Enable or disable versioning. Zero (0) disables, nonzero
-# enables.
-# svn_client - Use svn client i.s.o. ugly internal SVN file hack
-# format - A strftime() formatted string to use as a template for
-# the version string. The sequence "%#" will substitute
-# the SVN revision number.
-# pkg_enable - Enable or disable local package versioning.
-# pkg_format - Like "format", but used for the local package version.
+# enable - Enable or disable versioning. Zero (0) disables, nonzero
+# enables.
+# svn_client - Use svn client i.s.o. ugly internal SVN file hack
+# tortoise_svn - Use TortoiseSVN client instead of ugly internal SVN
+# file hack
+# format - A strftime() formatted string to use as a template for
+# the version string. The sequence "%#" will substitute
+# the number of commits for Git or the revision number
+# for SVN.
+# pkg_enable - Enable or disable local package versioning.
+# pkg_format - Like "format", but used for the local package version.
#
# If run with the "-r" or "--set-release" argument the AC_INIT macro in
# configure.ac and the VERSION macro in config.nmake will have the
-# pkg_format template appended to the version number. svnversion.h will
+# pkg_format template appended to the version number. version.h will
# _not_ be generated if either argument is present.
#
# Default configuration:
#
# enable: 1
-# svn_client: 1
-# format: SVN %Y%m%d%H%M%S
+# git_client: 0
+# svn_client: 0
+# tortoise_svn: 0
+# format: git %Y%m%d%H%M%S
# pkg_enable: 1
-# pkg_format: -SVN-%#
+# pkg_format: -%#
# XXX - We're pretty dumb about the "%#" substitution, and about having
# spaces in the package format.
use IO::Handle;
use English;
-my $version_file = 'svnversion.h';
+my $version_file = 'version.h';
my $package_string = "";
my $vconf_file = 'version.conf';
+my $vcs_name = "Git";
my $tortoise_file = "tortoise_template";
my $last_change = 0;
-my $revision = 0;
-my $repo_path = "unknown";
+my $num_commits = 0;
+my $commit_id = '';
+my $repo_branch = "unknown";
+my $git_executable = "git";
my $git_description = undef;
-my $get_svn = 0;
-my $set_svn = 0;
+my $get_vcs = 0;
+my $set_vcs = 0;
+my $print_vcs = 0;
my $set_version = 0;
my $set_release = 0;
my %version_pref = (
- "version_major" => 1,
- "version_minor" => 11,
- "version_micro" => 3,
+ "version_major" => 2,
+ "version_minor" => 1,
+ "version_micro" => 0,
"version_build" => 0,
"enable" => 1,
- "git_client" => 0,
- "svn_client" => 1,
+ "git_client" => 0, # set if .git found and .git/svn not found
+ "svn_client" => 0, # set if .svn found
"tortoise_svn" => 0,
- "format" => "SVN %Y%m%d%H%M%S",
- "is_release" => 0,
+ "format" => "git %Y%m%d%H%M%S",
# Normal development builds
"pkg_enable" => 1,
- "pkg_format" => "-SVN-%#",
+ "pkg_format" => "-%#",
# Development releases
#"pkg_enable" => 0,
$ENV{LC_ALL} = "C";
$ENV{GIT_PAGER} = "";
-# Run "svn info". Parse out the most recent modification time and the
-# revision number.
+# Attempt to get revision information from the repository.
sub read_repo_info {
my $line;
my $version_format = $version_pref{"format"};
my $in_entries = 0;
my $svn_name;
my $repo_version;
- my $repo_root = undef;
- my $repo_url = undef;
my $do_hack = 1;
my $info_source = "Unknown";
- if ($version_pref{"pkg_enable"}) {
+ # Make sure git is available.
+ if (!`$git_executable --version`) {
+ print STDERR "Git unavailable. Git revision will be missing from version string.\n";
+ return;
+ }
+
+ if ($version_pref{"pkg_enable"} > 0) {
$package_format = $version_pref{"pkg_format"};
}
} elsif (-d "$srcdir/.svn" or -d "$srcdir/../.svn") {
$info_source = "Command line (svn info)";
$info_cmd = "svn info $srcdir";
+ $version_pref{"svn_client"} = 1;
} elsif (-d "$srcdir/.git/svn") {
$info_source = "Command line (git-svn)";
- $info_cmd = "(cd $srcdir; git svn info)";
+ $info_cmd = "(cd $srcdir; $git_executable svn info)";
}
#Git can give us:
# 1ddc838
#
# The upstream branch path: git rev-parse --abbrev-ref --symbolic-full-name @{upstream}
- # origin/master-1.8
+ # origin/master
#
# A version description: git describe --tags --dirty
# wireshark-1.8.12-15-g1ddc838
use warnings "all";
no warnings "all";
- chomp($line = qx{git log -1 --pretty=format:%at});
- if (defined($line)) {
+ chomp($line = qx{$git_executable --git-dir="$srcdir"/.git log -1 --pretty=format:%at});
+ if ($? == 0 && length($line) > 1) {
$last_change = $line;
}
- # Commits in current (master-1.8) branch. We may want to use
- # a different number.
- chomp($line = qx{git rev-list --count ea19c7f952ce9fc53fe4c223f1d9d6797346258b..HEAD});
- if (defined($line)) {
- $revision = $line;
- }
-
- chomp($line = qx{git ls-remote --get-url origin});
- if (defined($line)) {
- $repo_url = $line;
- }
-
- # Probably not quite what we're looking for
- chomp($line = qx{git rev-parse --abbrev-ref --symbolic-full-name \@\{upstream\}});
- if (defined($line)) {
- $repo_path = basename($line);
+ # Commits since last annotated tag.
+ chomp($line = qx{$git_executable --git-dir="$srcdir"/.git describe --long --always --match "v*"});
+ if ($? == 0 && length($line) > 1) {
+ my @parts = split(/-/, $line);
+ $git_description = $line;
+ $num_commits = $parts[-2];
+ $commit_id = $parts[-1];
}
-
- # XXX After the SVN->git migration we'll create tags for 1.11.x.
- # Until then we'll fake it.
- #chomp($line = qx{git describe --tags --dirty});
- chomp($line = qx{git rev-parse --short HEAD});
- if (defined($line)) {
- #$git_description = $line;
- $git_description = "wireshark-1.11." . $version_pref{"version_minor"} .
- "-$revision-g$line";
+ # This will break in some cases. Hopefully not during
+ # official package builds.
+ chomp($line = qx{$git_executable --git-dir="$srcdir"/.git rev-parse --abbrev-ref --symbolic-full-name \@\{upstream\}});
+ if ($? == 0 && length($line) > 1) {
+ $repo_branch = basename($line);
}
1;
};
- if ($last_change && $revision && $repo_url && $repo_path) {
+ if ($last_change && $num_commits && $repo_branch) {
$do_hack = 0;
}
} elsif ($version_pref{"svn_client"}) {
+ my $repo_root = undef;
+ my $repo_url = undef;
eval {
use warnings "all";
no warnings "all";
$last_change = timegm($6, $5, $4, $3, $2 - 1, $1);
}
if ($line =~ /Last Changed Rev: (\d+)/) {
- $revision = $1;
+ $num_commits = $1;
}
if ($line =~ /URL: (\S+)/) {
$repo_url = $1;
if ($line =~ /Repository Root: (\S+)/) {
$repo_root = $1;
}
+ $vcs_name = "SVN";
}
1;
};
- if ($last_change && $revision && $repo_url && $repo_root) {
+ if ($repo_url && $repo_root && index($repo_url, $repo_root) == 0) {
+ $repo_branch = substr($repo_url, length($repo_root));
+ }
+
+ if ($last_change && $num_commits && $repo_url && $repo_root) {
$do_hack = 0;
}
} elsif ($version_pref{"tortoise_svn"}) {
# Dynamically generic template file needed by TortoiseSVN
open(TORTOISE, ">$tortoise_file");
- print TORTOISE "#define SVNVERSION \"\$WCREV\$\"\r\n";
- print TORTOISE "#define SVNPATH \"\$WCURL\$\"\r\n";
+ print TORTOISE "#define VCSVERSION \"\$WCREV\$\"\r\n";
+ print TORTOISE "#define VCSBRANCH \"\$WCURL\$\"\r\n";
close(TORTOISE);
$info_source = "Command line (SubWCRev)";
if ($tortoise == 0) {
$do_hack = 0;
}
+ $vcs_name = "SVN";
#clean up the template file
unlink($tortoise_file);
}
- if ($revision == 0) {
+ if ($num_commits == 0) {
# Fall back to config.nmake
$info_source = "Prodding config.nmake";
my $filepath = "$srcdir/config.nmake";
open(CFGNMAKE, "< $filepath") || die "Can't read $filepath!";
while ($line = <CFGNMAKE>) {
- if ($line =~ /^SVN_REVISION=(\d+)/) {
- $revision = $1;
+ if ($line =~ /^VCS_REVISION=(\d+)/) {
+ $num_commits = $1;
$do_hack = 0;
last;
}
}
close (CFGNMAKE);
}
- if ($revision == 0 and -d "$srcdir/.git") {
+ if ($num_commits == 0 and -d "$srcdir/.git") {
# Try git...
eval {
no warnings "all";
# If someone had properly tagged 1.9.0 we could also use
# "git describe --abbrev=1 --tags HEAD"
-
- $info_cmd = "(cd $srcdir; git log --format='%b' -n 1)";
+
+ $info_cmd = "(cd $srcdir; $git_executable log --format='%b' -n 1)";
$line = qx{$info_cmd};
if (defined($line)) {
if ($line =~ /svn path=.*; revision=(\d+)/) {
- $revision = $1;
+ $num_commits = $1;
}
}
- $info_cmd = "(cd $srcdir; git log --format='%ad' -n 1 --date=iso)";
+ $info_cmd = "(cd $srcdir; $git_executable log --format='%ad' -n 1 --date=iso)";
$line = qx{$info_cmd};
if (defined($line)) {
if ($line =~ /(\d{4})-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)/) {
$last_change = timegm($6, $5, $4, $3, $2 - 1, $1);
}
}
- $info_cmd = "(cd $srcdir; git branch)";
+ $info_cmd = "(cd $srcdir; $git_executable branch)";
$line = qx{$info_cmd};
if (defined($line)) {
if ($line =~ /\* (\S+)/) {
- $repo_path = $1;
+ $repo_branch = $1;
}
}
1;
};
}
- if ($revision == 0 and -d "$srcdir/.bzr") {
+ if ($num_commits == 0 and -d "$srcdir/.bzr") {
# Try bzr...
eval {
$last_change = timegm($6, $5, $4, $3, $2 - 1, $1);
}
if ($line =~ /svn revno: (\d+) \(on (\S+)\)/) {
- $revision = $1;
- $repo_path = $2;
+ $num_commits = $1;
+ $repo_branch = $2;
}
+ $vcs_name = "Bzr";
}
1;
};
if ($do_hack) {
# Start of ugly internal SVN file hack
if (! open (ENTRIES, "< $srcdir/.svn/entries")) {
- print ("Unable to open $srcdir/.svn/entries\n");
+ print STDERR "Unable to open $srcdir/.svn/entries\n";
} else {
$info_source = "Prodding .svn";
# We need to find out whether our parser can handle the entries file
if ($line =~ /committed-date="(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)/) {
$last_change = timegm($6, $5, $4, $3, $2 - 1, $1);
}
- if ($line =~ /revision="(\d+)"/) { $revision = $1; }
+ if ($line =~ /revision="(\d+)"/) { $num_commits = $1; }
}
if ($line =~ /\/>/) {
if (($svn_name eq "" || $svn_name eq "svn:this_dir") &&
- $last_change && $revision) {
+ $last_change && $num_commits) {
$in_entries = 0;
last;
}
# If we picked up the revision and modification time,
# generate our strings.
- if ($revision && $last_change) {
- $version_format =~ s/%#/$revision/;
- $package_format =~ s/%#/$revision/;
+ if ($version_pref{"pkg_enable"}) {
+ $version_format =~ s/%#/$num_commits/;
+ $package_format =~ s/%#/$num_commits-$commit_id/;
$package_string = strftime($package_format, gmtime($last_change));
}
- if ($repo_url && $repo_root && index($repo_url, $repo_root) == 0) {
- $repo_path = substr($repo_url, length($repo_root));
- }
-
- if ($get_svn) {
+ if ($get_vcs) {
print <<"Fin";
-SVN revision : $revision
+Commit distance : $num_commits
+Commit ID : $commit_id
Revision source : $info_source
Release stamp : $package_string
Fin
+ } elsif ($print_vcs) {
+ print new_version_h();
}
}
+# Read CMakeLists.txt, then write it back out with updated "set(PROJECT_..._VERSION ...)
+# lines
+# set(GIT_REVISION 999)
+# set(PROJECT_MAJOR_VERSION 1)
+# set(PROJECT_MINOR_VERSION 99)
+# set(PROJECT_PATCH_VERSION 0)
+# set(PROJECT_VERSION_EXTENSION "-rc5")
+sub update_cmakelists_txt
+{
+ my $line;
+ my $contents = "";
+ my $version = "";
+ my $filepath = "$srcdir/CMakeLists.txt";
+ my $cmake_package_string = "\$ENV{WIRESHARK_VERSION_EXTRA}";
+
+ if ($package_string ne "") { $cmake_package_string = $package_string; }
+
+ return if (!$set_version && $package_string eq "");
+
+ open(CFGIN, "< $filepath") || die "Can't read $filepath!";
+ while ($line = <CFGIN>) {
+ if ($line =~ /^set *\( *GIT_REVISION .*([\r\n]+)$/) {
+ $line = sprintf("set(GIT_REVISION %d)$1", $num_commits);
+ } elsif ($line =~ /^set *\( *PROJECT_MAJOR_VERSION .*([\r\n]+)$/) {
+ $line = sprintf("set(PROJECT_MAJOR_VERSION %d)$1", $version_pref{"version_major"});
+ } elsif ($line =~ /^set *\( *PROJECT_MINOR_VERSION .*([\r\n]+)$/) {
+ $line = sprintf("set(PROJECT_MINOR_VERSION %d)$1", $version_pref{"version_minor"});
+ } elsif ($line =~ /^set *\( *PROJECT_PATCH_VERSION .*([\r\n]+)$/) {
+ $line = sprintf("set(PROJECT_PATCH_VERSION %d)$1", $version_pref{"version_micro"});
+ } elsif ($line =~ /^set *\( *PROJECT_VERSION_EXTENSION.*([\r\n]+)$/) {
+ $line = sprintf("set(PROJECT_VERSION_EXTENSION \"%s\")$1", $cmake_package_string);
+ }
+ $contents .= $line
+ }
+
+ open(CFGIN, "> $filepath") || die "Can't write $filepath!";
+ print(CFGIN $contents);
+ close(CFGIN);
+ print "$filepath has been updated.\n";
+}
+
# Read configure.ac, then write it back out with an updated
# "AC_INIT" line.
sub update_configure_ac
my $contents = "";
my $version = "";
my $filepath = "$srcdir/config.nmake";
+ my $win_package_string = "\$(WIRESHARK_VERSION_EXTRA)";
+
+ if ($package_string ne "") { $win_package_string = $package_string; }
+
open(CFGNMAKE, "< $filepath") || die "Can't read $filepath!";
while ($line = <CFGNMAKE>) {
- if ($line =~ /^SVN_REVISION=.*([\r\n]+)$/) {
- $line = sprintf("SVN_REVISION=%d$1", $revision);
+ if ($line =~ /^VCS_REVISION=.*([\r\n]+)$/) {
+ $line = sprintf("VCS_REVISION=%d$1", $num_commits);
} elsif ($set_version && $line =~ /^VERSION_MAJOR=.*([\r\n]+)$/) {
$line = sprintf("VERSION_MAJOR=%d$1", $version_pref{"version_major"});
} elsif ($set_version && $line =~ /^VERSION_MINOR=.*([\r\n]+)$/) {
} elsif ($set_version && $line =~ /^VERSION_MICRO=.*([\r\n]+)$/) {
$line = sprintf("VERSION_MICRO=%d$1", $version_pref{"version_micro"});
} elsif ($line =~ /^VERSION_EXTRA=.*([\r\n]+)$/) {
- $line = "VERSION_EXTRA=$package_string$1";
+ $line = "VERSION_EXTRA=$win_package_string$1";
}
$contents .= $line
}
print "$filepath has been updated.\n";
}
-# Read debian/wireshark-common.files, then write back out an updated version.
-# The libraries updated here MUST match the updates made by update_lib_releases
-# below. We should do this automatically.
-sub update_debian_wcf
-{
- my $line;
- my $contents = "";
- my $version = "";
- my $filepath = "$srcdir/debian/wireshark-common.files";
-
- return if (!$set_version);
-
- open(DWCF, "< $filepath") || die "Can't read $filepath!";
- while ($line = <DWCF>) {
- # /usr/lib/wireshark/libwireshark.so.1.1.0
-
- if ($line =~ qr{^(/usr/lib/wireshark/lib(wireshark|wiretap|filetap).so\.\d+\.\d+\.)\d+$}) {
- $line = sprintf("$1%d\n", $version_pref{"version_micro"});
- }
- $contents .= $line
- }
-
- open(DWCF, "> $filepath") || die "Can't write $filepath!";
- print(DWCF $contents);
- close(DWCF);
- print "$filepath has been updated.\n";
-}
-
# Read Makefile.am for each library, then write back out an updated version.
-sub update_lib_releases
+sub update_automake_lib_releases
{
my $line;
my $contents = "";
# "If the library source code has changed at all since the last
# update, then increment revision (‘c:r:a’ becomes ‘c:r+1:a’)."
# epan changes with each minor release, almost by definition. wiretap
- # and filetap changes with *most* releases.
+ # changes with *most* releases.
#
# http://www.gnu.org/software/libtool/manual/libtool.html#Updating-version-info
- for $filedir ("epan", "wiretap", "filetap") { # "wsutil"
+ for $filedir ("epan", "wiretap") { # "wsutil"
$contents = "";
$filepath = $filedir . "/Makefile.am";
open(MAKEFILE_AM, "< $filepath") || die "Can't read $filepath!";
}
}
+# Read CMakeLists.txt for each library, then write back out an updated version.
+sub update_cmake_lib_releases
+{
+ my $line;
+ my $contents = "";
+ my $version = "";
+ my $filedir;
+ my $filepath;
+
+ return if (!$set_version);
+
+ for $filedir ("epan", "wiretap") { # "wsutil"
+ $contents = "";
+ $filepath = $filedir . "/CMakeLists.txt";
+ open(CMAKELISTS_TXT, "< $filepath") || die "Can't read $filepath!";
+ while ($line = <CMAKELISTS_TXT>) {
+ # set(FULL_SO_VERSION "0.0.0")
+
+ if ($line =~ /^(set\s*\(\s*FULL_SO_VERSION\s+"\d+\.\d+\.)\d+(".*)/) {
+ $line = sprintf("$1%d$2\n", $version_pref{"version_micro"});
+ }
+ $contents .= $line
+ }
+
+ open(CMAKELISTS_TXT, "> $filepath") || die "Can't write $filepath!";
+ print(CMAKELISTS_TXT $contents);
+ close(CMAKELISTS_TXT);
+ print "$filepath has been updated.\n";
+ }
+}
+
# Update distributed files that contain any version information
sub update_versioned_files
{
+ &update_cmakelists_txt;
&update_configure_ac;
&update_config_nmake;
&update_release_notes;
&update_debian_changelog;
- &update_debian_wcf;
- &update_lib_releases;
+ &update_automake_lib_releases;
+ &update_cmake_lib_releases;
}
-# Print the SVN version to $version_file.
-# Don't change the file if it is not needed.
-sub print_svn_revision
+sub new_version_h
{
- my $svn_revision;
- my $needs_update = 1;
+ my $VCS_REVISION;
if ($git_description) {
- $svn_revision = "#define SVNVERSION \"" .
+ $VCS_REVISION = "#define VCSVERSION \"" .
$git_description . "\"\n" .
- "#define SVNPATH \"" . $repo_path . "\"\n";
- } elsif ($last_change && $revision) {
- $svn_revision = "#define SVNVERSION \"SVN Rev " .
- $revision . "\"\n" .
- "#define SVNPATH \"" . $repo_path . "\"\n";
+ "#define VCSBRANCH \"" . $repo_branch . "\"\n";
+ } elsif ($last_change && $num_commits) {
+ $VCS_REVISION = "#define VCSVERSION \"" . $vcs_name . " Rev " .
+ $num_commits . "\"\n" .
+ "#define VCSBRANCH \"" . $repo_branch . "\"\n";
} else {
- $svn_revision = "#define SVNVERSION \"SVN Rev Unknown\"\n" .
- "#define SVNPATH \"unknown\"\n";
+ $VCS_REVISION = "#define VCSVERSION \"" . $vcs_name .
+ " Rev Unknown\"\n" .
+ "#define VCSBRANCH \"unknown\"\n";
}
+
+ return $VCS_REVISION;
+}
+
+# Print the version control system's version to $version_file.
+# Don't change the file if it is not needed.
+sub print_VCS_REVISION
+{
+ my $VCS_REVISION = new_version_h();
+ my $needs_update = 1;
if (open(OLDREV, "<$version_file")) {
- my $old_
svn_revision = <OLDREV> . <OLDREV>;
- if ($old_svn_revision eq $svn_revision) {
+ my $old_
VCS_REVISION = <OLDREV> . <OLDREV>;
+ if ($old_VCS_REVISION eq $VCS_REVISION) {
$needs_update = 0;
}
close OLDREV;
}
- if (! $set_svn) { return; }
+ if (! $set_vcs) { return; }
if ($needs_update) {
- # print "Updating $version_file so it contains:\n$svn_revision";
+ # print "Updating $version_file so it contains:\n$VCS_REVISION";
open(VER, ">$version_file") || die ("Cannot write to $version_file ($!)\n");
- print VER "$svn_revision";
+ print VER "$VCS_REVISION";
close VER;
print "$version_file has been updated.\n";
} else {
# XXX - Do we need an option to undo --set-release?
GetOptions(
"help|h", \$show_help,
- "get-svn|g", \$get_svn,
- "set-svn|s", \$set_svn,
+ "get-vcs|get-svn|g", \$get_vcs,
+ "set-vcs|set-svn|s", \$set_vcs,
+ "git-bin", \$git_executable,
+ "print-vcs", \$print_vcs,
"set-version|v", \$set_version,
"set-release|r|package-version|p", \$set_release
) || pod2usage(2);
if ($show_help) { pod2usage(1); }
- if ( !( $show_help || $get_svn || $set_svn || $set_version || $set_release ) ) {
- $set_svn = 1;
+ if ( !( $show_help || $get_vcs || $set_vcs || $print_vcs || $set_version || $set_release ) ) {
+ $set_vcs = 1;
}
if ($#ARGV >= 0) {
}
while (<FILE>) {
- chomp;
+ s/^\s+|\s+$//g; # chomp() may not handle CR
next if (/^#/);
next unless (/^(\w+)(:|=)\s*(\S.*)/);
$version_pref{$1} = $3;
&read_repo_info();
-&print_svn_revision;
+&print_VCS_REVISION;
if ($set_version || $set_release) {
if ($set_version) {
print "Generating release information\n";
} else {
print "Resetting release information\n";
- $revision = 0;
+ $num_commits = 0;
$package_string = "";
}
Options:
--help, -h This help message
- --get-svn, -g Print the SVN revision and source.
- --set-svn, -s Set the information in svnversion.h
+ --get-vcs, -g Print the VCS revision and source.
+ --set-vcs, -s Set the information in version.h
+ --print-vcs Print the vcs version to standard output
--set-version, -v Set the major, minor, and micro versions in
configure.ac, config.nmake, debian/changelog,
and docbook/asciidoc.conf.
Options can be used in any combination. If none are specified B<--set-svn>
is assumed.
+=cut
+
#
# Editor modelines - http://www.wireshark.org/tools/modelines.html
#
git.samba.org / metze / wireshark / wip.git / blobdiff