Skip to contentSkip to conversation

Use git in scripts/setlocalversion

PATCH In review Rene Scharfe 4 participants 7 messages Jan 4, 2006 – Jan 9, 2006

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Use git in scripts/setlocalversion

Currently scripts/setlocalversion is a Perl script that tries to figure out the current git commit ID of a repo without using git. It also imports Digest::MD5 without using it and generally is too big for the small task it does. :] And it always reports a git ID, even when the HEAD is tagged -- this is a bug.

This patch replaces it with a Bourne Shell script that uses git commands to do the same. I can't come up with a scenario where someone would use a git repo and refuse to install git core at the same time, so I think it's reasonable to assume git is available.

The new script also reports uncommitted changes by adding -git_dirty to the version string. Obviously you can't see from that _what_ has been changed from the last commit, so it's more of a reminder that you forgot to commit something.

The script is easily extensible: simply add a check for Mercurial (or whatever) below the git check.

Note: the script doesn't print a newline char anymore. That's only because it was easier to implement it that way, not a feature (or bug). 'make kernelrelease' doesn't care.

scripts/setlocalversion +18 -52
index 7c805c8..f54dac8 100644
@@ -1,56 +1,22 @@
-#!/usr/bin/perl
-# Copyright 2004 - Ryan Anderson <[email protected]>  GPL v2
+#!/bin/sh
+# Print additional version information for non-release trees.
 
-use strict;
-use warnings;
-use Digest::MD5;
-require 5.006;
-
-if (@ARGV != 1) {
-	print <<EOT;
-Usage: setlocalversion <srctree>
-EOT
-	exit(1);
-}
-
-my ($srctree) = @ARGV;
-chdir($srctree);
-
-my @LOCALVERSIONS = ();
-
-# We are going to use the following commands to try and determine if this
-# repository is at a Version boundary (i.e, 2.6.10 vs 2.6.10 + some patches) We
-# currently assume that all meaningful version boundaries are marked by a tag.
-# We don't care what the tag is, just that something exists.
-
-# Git/Cogito store the top-of-tree "commit" in .git/HEAD
-# A list of known tags sits in .git/refs/tags/
-#
-# The simple trick here is to just compare the two of these, and if we get a
-# match, return nothing, otherwise, return a subset of the SHA-1 hash in
-# .git/HEAD
-
-sub do_git_checks {
-	open(H,"<.git/HEAD") or return;
-	my $head = <H>;
-	chomp $head;
-	close(H);
-
-	opendir(D,".git/refs/tags") or return;
-	foreach my $tagfile (grep !/^\.{1,2}$/, readdir(D)) {
-		open(F,"<.git/refs/tags/" . $tagfile) or return;
-		my $tag = <F>;
-		chomp $tag;
-		close(F);
-		return if ($tag eq $head);
-	}
-	closedir(D);
-
-	push @LOCALVERSIONS, "g" . substr($head,0,8);
+usage() {
+	echo "Usage: $0 [srctree]" >&2
+	exit 1
 }
 
-if ( -d ".git") {
-	do_git_checks();
-}
+cd "${1:-.}" || usage
 
-printf "-%s\n", join("-",@LOCALVERSIONS) if (scalar @LOCALVERSIONS > 0);
+# Check for git and a git repo.
+if head=`git rev-parse --verify HEAD 2>/dev/null`; then
+	# Do we have an untagged version?
+	if  [ "`git name-rev --tags HEAD`" = "HEAD undefined" ]; then
+		printf '%s%s' -g `echo "$head" | cut -c1-8`
+	fi
+
+	# Are there uncommitted changes?
+	if git diff-files | read dummy; then
+		printf '%s' -git_dirty
+	fi
+fi
#1 lore raw
Quoted 5 lines · Rene Scharfe

Currently scripts/setlocalversion is a Perl script that tries to figure out the current git commit ID of a repo without using git. It also imports Digest::MD5 without using it and generally is too big for the small task it does. :] And it always reports a git ID, even when the HEAD is tagged -- this is a bug.

Yes. I'm pretty sure I sent Sam a patch for that at one point ages ago, but I've been distracted and haven't updated it recently.

I think using git-name-rev --tags as this change does is a lot simpler than what I was trying to do.

So, Sam, if you'd prefer this version, feel free, or let me know and I'll resend the one or two patches I have hanging around to you.

Quoted 9 lines

This patch replaces it with a Bourne Shell script that uses git commands to do the same. I can't come up with a scenario where someone would use a git repo and refuse to install git core at the same time, so I think it's reasonable to assume git is available.

The new script also reports uncommitted changes by adding -git_dirty to the version string. Obviously you can't see from that _what_ has been changed from the last commit, so it's more of a reminder that you forgot to commit something.

And this is a decent feature, too. I like it.

The only reservation I have about converting from Perl to Bourne shell is that if adding support for, say, Mercurial (or maybe CVS, etc) wants to mangle it somehow, via say MD5, that becomes a little bit more difficult to do, or at worst, introduces an additional dependency on something like md5sum.

So, I like it:

Acked-by Ryan Anderson on v1 1/1
#2 lore raw
In reply to Rene Scharfe
Quoted 16 lines · Rene Scharfe

Currently scripts/setlocalversion is a Perl script that tries to figure out the current git commit ID of a repo without using git. It also imports Digest::MD5 without using it and generally is too big for the small task it does. :] And it always reports a git ID, even when the HEAD is tagged -- this is a bug.

This patch replaces it with a Bourne Shell script that uses git commands to do the same. I can't come up with a scenario where someone would use a git repo and refuse to install git core at the same time, so I think it's reasonable to assume git is available.

The new script also reports uncommitted changes by adding -git_dirty to the version string. Obviously you can't see from that _what_ has been changed from the last commit, so it's more of a reminder that you forgot to commit something.

Quoted 8 lines

The script is easily extensible: simply add a check for Mercurial (or whatever) below the git check.

Note: the script doesn't print a newline char anymore. That's only because it was easier to implement it that way, not a feature (or bug). 'make kernelrelease' doesn't care.

Thanks Rene.
Applied with an:

Sam

#3 lore raw

PATCH 1/1 setlocalversion: Change -git_dirty to just -dirty

When building Debian packages directly from the git tree, the appended "git_dirty" is a problem due to the underscore. In order to cause the least problems, change that just to "dirty".

scripts/setlocalversion +1 -1
@@ -17,6 +17,6 @@ if head=`git rev-parse --verify HEAD 2>/
 
 	# Are there uncommitted changes?
 	if git diff-files | read dummy; then
-		printf '%s' -git_dirty
+		printf '%s' -dirty
 	fi
 fi
Signature · 2 lines
Ryan Anderson
  sometimes Pug Majere
Applied
#4 lore raw

Re: [PATCH] setlocalversion: Change -git_dirty to just -dirty

Quoted 6 lines · Ryan Anderson

When building Debian packages directly from the git tree, the appended "git_dirty" is a problem due to the underscore. In order to cause the least problems, change that just to "dirty".

Applied,

Sam

#5 lore raw
In reply to Rene Scharfe

2006/1/5, Rene Scharfe <[email protected]>:

Quoted 30 lines

Currently scripts/setlocalversion is a Perl script that tries to figure out the current git commit ID of a repo without using git. It also imports Digest::MD5 without using it and generally is too big for the small task it does. :] And it always reports a git ID, even when the HEAD is tagged -- this is a bug.

This patch replaces it with a Bourne Shell script that uses git commands to do the same. I can't come up with a scenario where someone would use a git repo and refuse to install git core at the same time, so I think it's reasonable to assume git is available.

The new script also reports uncommitted changes by adding -git_dirty to the version string. Obviously you can't see from that _what_ has been changed from the last commit, so it's more of a reminder that you forgot to commit something.

The script is easily extensible: simply add a check for Mercurial (or whatever) below the git check.

Note: the script doesn't print a newline char anymore. That's only because it was easier to implement it that way, not a feature (or bug). 'make kernelrelease' doesn't care.

scripts/setlocalversion +0 -0
index 7c805c8..f54dac8 100644

scripts/setlocalversion line 1

Quoted 3 lines
scripts/setlocalversion +1 -2
@@ -1,56 +1,22 @@
-#!/usr/bin/perl
-# Copyright 2004 - Ryan Anderson <[email protected]>  GPL v2
+#!/bin/sh

You didn't update the caller in the top Makefile, but that's ok. --
Coywolf Qi Hunt

#6 lore raw
Quoted 7 lines · Coywolf Qi Hunt

2006/1/5, Rene Scharfe <[email protected]>:

Quoted 6 lines

Currently scripts/setlocalversion is a Perl script that tries to figure out the current git commit ID of a repo without using git. It also imports Digest::MD5 without using it and generally is too big for the small task it does. :] And it always reports a git ID, even when the HEAD is tagged -- this is a bug.

Quoted 6 lines
Quoted 4 lines

This patch replaces it with a Bourne Shell script that uses git commands to do the same. I can't come up with a scenario where someone would use a git repo and refuse to install git core at the same time, so I think it's reasonable to assume git is available.

You didn't update the caller in the top Makefile, but that's ok.

It's fixed in my tree.

Sam