diff mbox

[v3,2/2] Makefile: Derive "PKGVERSION" from "git describe" by default

Message ID 1464774261-648-3-git-send-email-famz@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

Fam Zheng June 1, 2016, 9:44 a.m. UTC
Currently, if not specified in "./configure", QEMU_PKGVERSION will be
empty. Write a rule in Makefile to generate a value from "git describe"
combined with a possible git tree cleanness suffix, and write into a new
header.

    $ cat qemu-version.h
    #define QEMU_PKGVERSION "-v2.6.0-557-gd6550e9-dirty"

Include the header in .c files where the macro is referenced. It's not
necessary to include it in all files, otherwise each time the content of
the file changes, all sources have to be recompiled.

Signed-off-by: Fam Zheng <famz@redhat.com>
---
 Makefile              | 22 +++++++++++++++++++++-
 linux-user/main.c     |  1 +
 qemu-img.c            |  1 +
 qmp.c                 |  1 +
 scripts/create_config |  4 ----
 vl.c                  |  1 +
 6 files changed, 25 insertions(+), 5 deletions(-)

Comments

Daniel P. Berrangé June 1, 2016, 10:13 a.m. UTC | #1
On Wed, Jun 01, 2016 at 05:44:21PM +0800, Fam Zheng wrote:
> Currently, if not specified in "./configure", QEMU_PKGVERSION will be
> empty. Write a rule in Makefile to generate a value from "git describe"
> combined with a possible git tree cleanness suffix, and write into a new
> header.
> 
>     $ cat qemu-version.h
>     #define QEMU_PKGVERSION "-v2.6.0-557-gd6550e9-dirty"
> 
> Include the header in .c files where the macro is referenced. It's not
> necessary to include it in all files, otherwise each time the content of
> the file changes, all sources have to be recompiled.
> 
> Signed-off-by: Fam Zheng <famz@redhat.com>
> ---
>  Makefile              | 22 +++++++++++++++++++++-
>  linux-user/main.c     |  1 +
>  qemu-img.c            |  1 +
>  qmp.c                 |  1 +
>  scripts/create_config |  4 ----
>  vl.c                  |  1 +
>  6 files changed, 25 insertions(+), 5 deletions(-)

Reviewed-by: Daniel P. Berrange <berrange@redhat.com>

Regards,
Daniel
Gerd Hoffmann June 1, 2016, 10:40 a.m. UTC | #2
Hi,

> +				git describe 2>/dev/null | tr -d '\n'; \
> +				if ! git diff-index --quiet HEAD &>/dev/null; then \
> +					printf -- '-dirty'; \
> +				fi \

/me suggests "git describe --dirty --match 'v*'"

Saves the extra effort to check for a dirty tree manually.

Also greatly reduces the chance non-release tags are matched, so I don't
get results like "pull-vga-20160523-1-236-g9fd5eb7".

cheers,
  Gerd
Laszlo Ersek June 1, 2016, 11:13 a.m. UTC | #3
On 06/01/16 12:40, Gerd Hoffmann wrote:
>   Hi,
> 
>> +				git describe 2>/dev/null | tr -d '\n'; \
>> +				if ! git diff-index --quiet HEAD &>/dev/null; then \
>> +					printf -- '-dirty'; \
>> +				fi \
> 
> /me suggests "git describe --dirty --match 'v*'"
> 
> Saves the extra effort to check for a dirty tree manually.

We couldn't convince ourselves that support for "--dirty" is ubiquitous;
please see the sub-thread rooted at
<http://thread.gmane.org/gmane.comp.emulators.qemu/414824/focus=414828>.

> Also greatly reduces the chance non-release tags are matched, so I don't
> get results like "pull-vga-20160523-1-236-g9fd5eb7".

Since what version is "--match" supported? ;)

Thanks
Laszlo
diff mbox

Patch

diff --git a/Makefile b/Makefile
index 1e2d6f9..5124f54 100644
--- a/Makefile
+++ b/Makefile
@@ -49,7 +49,7 @@  ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fa
 endif
 endif
 
-GENERATED_HEADERS = config-host.h qemu-options.def
+GENERATED_HEADERS = qemu-version.h config-host.h qemu-options.def
 GENERATED_HEADERS += qmp-commands.h qapi-types.h qapi-visit.h qapi-event.h
 GENERATED_SOURCES += qmp-marshal.c qapi-types.c qapi-visit.c qapi-event.c
 GENERATED_HEADERS += qmp-introspect.h
@@ -166,6 +166,26 @@  endif
 
 all: $(DOCS) $(TOOLS) $(HELPERS-y) recurse-all modules
 
+qemu-version.h: FORCE
+	$(call quiet-command, \
+		(cd $(SRC_PATH); \
+		printf '#define QEMU_PKGVERSION '; \
+		if test -n "$(PKGVERSION)"; then \
+			printf '"$(PKGVERSION)"\n'; \
+		else \
+			printf '" ('; \
+			if ! git status &>/dev/null; then \
+				printf "no-git"; \
+			else \
+				git describe 2>/dev/null | tr -d '\n'; \
+				if ! git diff-index --quiet HEAD &>/dev/null; then \
+					printf -- '-dirty'; \
+				fi \
+			fi; \
+			printf ')"\n'; \
+		fi) > $@.tmp)
+	$(call quiet-command, cmp --quiet $@ $@.tmp || mv $@.tmp $@)
+
 config-host.h: config-host.h-timestamp
 config-host.h-timestamp: config-host.mak
 qemu-options.def: $(SRC_PATH)/qemu-options.hx
diff --git a/linux-user/main.c b/linux-user/main.c
index b2bc6ab..8a11d02 100644
--- a/linux-user/main.c
+++ b/linux-user/main.c
@@ -17,6 +17,7 @@ 
  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 #include "qemu/osdep.h"
+#include "qemu-version.h"
 #include <sys/mman.h>
 #include <sys/syscall.h>
 #include <sys/resource.h>
diff --git a/qemu-img.c b/qemu-img.c
index 4b56ad3..32e307c 100644
--- a/qemu-img.c
+++ b/qemu-img.c
@@ -22,6 +22,7 @@ 
  * THE SOFTWARE.
  */
 #include "qemu/osdep.h"
+#include "qemu-version.h"
 #include "qapi/error.h"
 #include "qapi-visit.h"
 #include "qapi/qmp-output-visitor.h"
diff --git a/qmp.c b/qmp.c
index 3165f87..7df6543 100644
--- a/qmp.c
+++ b/qmp.c
@@ -14,6 +14,7 @@ 
  */
 
 #include "qemu/osdep.h"
+#include "qemu-version.h"
 #include "qemu/cutils.h"
 #include "monitor/monitor.h"
 #include "sysemu/sysemu.h"
diff --git a/scripts/create_config b/scripts/create_config
index b2d2ebb..d47057b 100755
--- a/scripts/create_config
+++ b/scripts/create_config
@@ -9,10 +9,6 @@  case $line in
     version=${line#*=}
     echo "#define QEMU_VERSION \"$version\""
     ;;
- PKGVERSION=*) # configuration
-    pkgversion=${line#*=}
-    echo "#define QEMU_PKGVERSION \"$pkgversion\""
-    ;;
  qemu_*dir=*) # qemu-specific directory configuration
     name=${line%=*}
     value=${line#*=}
diff --git a/vl.c b/vl.c
index 18d1423..97cad71 100644
--- a/vl.c
+++ b/vl.c
@@ -22,6 +22,7 @@ 
  * THE SOFTWARE.
  */
 #include "qemu/osdep.h"
+#include "qemu-version.h"
 #include "qemu/cutils.h"
 #include "qemu/help_option.h"