[PATCH] build: check .git directory existence in srcdir (for out-of-tree builds)

[PATCH] build: check .git directory existence in srcdir (for out-of-tree builds)

[Tomi Ollila]

So that $(VERSION) and version.stamp uses the git-describe -based
version data instead of the content of `version' file.

For consistency also the git commands in Makefile[.local] target
`verify-no-dirty-code' uses the git --git-dir=$srcdir/.git ...
commands (inside ifeq($(IS_GIT),yes)). Attempting to make this
target outside of the tree will fail in any case.
---
 Makefile.local | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Makefile.local b/Makefile.local
index f0c4453574b8..a9a6df8bf0e0 100644
--- a/Makefile.local
+++ b/Makefile.local
@@ -10,10 +10,10 @@
 # repository), we let git append identification of the actual commit.
 PACKAGE=notmuch
 
-IS_GIT=$(shell if [ -d .git ] ; then echo yes ; else echo no; fi)
+IS_GIT=$(shell if [ -d ${srcdir}/.git ] ; then echo yes ; else echo no; fi)
 
 ifeq ($(IS_GIT),yes)
-DATE:=$(shell git log --date=short -1 --pretty=format:%cd)
+DATE:=$(shell git --git-dir=${srcdir}/.git log --date=short -1 --pretty=format:%cd)
 else
 DATE:=$(shell date +%F)
 endif
@@ -21,7 +21,7 @@ endif
 VERSION:=$(shell cat ${srcdir}/version)
 ifeq ($(filter release release-message pre-release update-versions,$(MAKECMDGOALS)),)
 ifeq ($(IS_GIT),yes)
-VERSION:=$(shell git describe --abbrev=7 --match '[0-9.]*'|sed -e s/_/~/ -e s/-/+/ -e s/-/~/)
+VERSION:=$(shell git --git-dir=${srcdir}/.git describe --abbrev=7 --match '[0-9.]*'|sed -e s/_/~/ -e s/-/+/ -e s/-/~/)
 # Write the file 'version.stamp' in case its contents differ from $(VERSION)
 FILE_VERSION:=$(shell test -f version.stamp && read vs < version.stamp || vs=; echo $$vs)
 ifneq ($(FILE_VERSION),$(VERSION))
@@ -200,11 +200,11 @@ verify-source-tree-and-version: verify-no-dirty-code
 verify-no-dirty-code: release-checks
 ifeq ($(IS_GIT),yes)
 	@printf "Checking that source tree is clean..."
-ifneq ($(shell git ls-files -m),)
+ifneq ($(shell git --git-dir=${srcdir}/.git ls-files -m),)
 	@echo "No"
 	@echo "The following files have been modified since the most recent git commit:"
 	@echo ""
-	@git ls-files -m
+	@git --git-dir=${srcdir}/.git ls-files -m
 	@echo ""
 	@echo "The release will be made from the committed state, but perhaps you meant"
 	@echo "to commit this code first? Please clean this up to make it more clear."
-- 
1.8.0

Re: [PATCH] build: check .git directory existence in srcdir (for out-of-tree builds)

[David Bremner]

Tomi Ollila <tomi.ollila@iki.fi> writes:

> So that $(VERSION) and version.stamp uses the git-describe -based
> version data instead of the content of `version' file.
>
> For consistency also the git commands in Makefile[.local] target
> `verify-no-dirty-code' uses the git --git-dir=$srcdir/.git ...
> commands (inside ifeq($(IS_GIT),yes)). Attempting to make this
> target outside of the tree will fail in any case.

This seems to work OK; I wondered if an alternate method of setting (and
exporting) GIT_DIR from the top level makefile would work as well, and
be less intrusive?

d

Re: [PATCH] build: check .git directory existence in srcdir (for out-of-tree builds)

[Tomi Ollila]

On Sat, Jul 05 2014, David Bremner <david@tethera.net> wrote:

> Tomi Ollila <tomi.ollila@iki.fi> writes:
>
>> So that $(VERSION) and version.stamp uses the git-describe -based
>> version data instead of the content of `version' file.
>>
>> For consistency also the git commands in Makefile[.local] target
>> `verify-no-dirty-code' uses the git --git-dir=$srcdir/.git ...
>> commands (inside ifeq($(IS_GIT),yes)). Attempting to make this
>> target outside of the tree will fail in any case.
>
> This seems to work OK; I wondered if an alternate method of setting (and
> exporting) GIT_DIR from the top level makefile would work as well, and
> be less intrusive?

This looked like a good idea, and I tested it. But -- lo and behold --
the environment variables set in Makefile do not probagate to the
commands executed with $(shell ...) -- see (*) (I wrapped git(1) in a shell
script (executes env then execs real git) to verify this is still the case).

I thoght now a bit whether we'd use variable in place of ${srcdir}/.git
but IMHO is better in this way:

   - make does not have option to warn/die in case variable undefined,
     it is then just empty string so no internal error checking there

   - any human observer notices from the ${srcdir}/.git that we're not
     using git from any nonstandard place -- if there were variable one
     would have needed to dereference that to figure out this is the case.

(*) http://www.cmcrossroads.com/article/basics-getting-environment-variables-gnu-make?page=0%2C1

>
> d


Tomi

Re: [PATCH] build: check .git directory existence in srcdir (for out-of-tree builds)

[David Bremner]

Tomi Ollila <tomi.ollila@iki.fi> writes:

> So that $(VERSION) and version.stamp uses the git-describe -based
> version data instead of the content of `version' file.

pushed.

d