git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Dirk Süsserott" <newsletter@dirk.my1.cc>
To: Mikko Rapeli <mikko.rapeli@iki.fi>
Cc: Jakub Narebski <jnareb@gmail.com>, git@vger.kernel.org
Subject: Re: How to embed a hash, tag or branch name?
Date: Sat, 01 Aug 2009 14:38:13 +0200	[thread overview]
Message-ID: <4A743735.9020806@dirk.my1.cc> (raw)
In-Reply-To: <20090731095238.GG29909@nalle>

Am 31.07.2009 11:52 schrieb Mikko Rapeli:
> On Fri, Jul 31, 2009 at 02:27:50AM -0700, Jakub Narebski wrote:
>> You can embed SHA-1 of a _file contents_ (blob) using '$Id: $' keyword
>> with `ident` attribute - see gitattributes manpage.
> 
> Great, thanks!
> 
>> The correct solution of embedding version number is to do it at 
>> _build time_, using e.g. script similar to GIT-VERSION-GEN used by
>> Git itself and by Linux kernel.  It helps if you tag your releases.
> 

Hi Mikko,

I don't know whether you want to use the "ident" command on your final
binary. With Git, that's pointless, as all source files will have the
same $Id$. So it's perfectly sufficient to have only ONE file enriched
with Git's SHA1.

Suggestion: During build time, compile (and link in) a file (e.g.
version.c) with "-DVERSION=\"$(git describe)\"". My version.c looks like
this:

----------------------------------
char const * version()
{
     return VERSION;
}
----------------------------------

The function then returns sth. like "foo12004-26-gc6c9273", which means
that you're 26 commits ahead of the annotated tag "foo12004" and your
commit has SHA1 "c6c9273". Then make your application somehow return
that version string when asked (or deliver a version.txt together with
it). This way you know that your binary was built using commit
"c6c9273". You can further refine the VERSION by adding a "-dirty" if
the working tree was dirty at build time. Then you'll know that your
binary was based on c6c9273 "with some changes".

Make sure that version.c is the ONLY file that compiles with that
-DVERSION switch. Otherwise all files get re-compiled when $(git
describe) changes. That's not what you want.

     HTH, Dirk

  reply	other threads:[~2009-08-01 12:42 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-07-31  8:17 How to embed a hash, tag or branch name? Mikko Rapeli
2009-07-31  9:27 ` Jakub Narebski
2009-07-31  9:52   ` Mikko Rapeli
2009-08-01 12:38     ` Dirk Süsserott [this message]
2009-08-01 13:13       ` Jakub Narebski
2009-08-01 16:04         ` Dirk Süsserott

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4A743735.9020806@dirk.my1.cc \
    --to=newsletter@dirk.my1.cc \
    --cc=git@vger.kernel.org \
    --cc=jnareb@gmail.com \
    --cc=mikko.rapeli@iki.fi \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).