src/common/Makefile.am

   1 # SPDX-License-Identifier: MIT
   2
   3 AM_CPPFLAGS += -DBABELTRACE_PLUGINS_DIR=\"$(BABELTRACE_PLUGINS_DIR)\"
   4
   5 noinst_LTLIBRARIES = libbabeltrace2-common.la
   6
   7 libbabeltrace2_common_la_SOURCES = \
   8         assert.c \
   9         assert.h \
  10         common.c \
  11         common.h \
  12         uuid.c \
  13         uuid.h
  14
  15 noinst_HEADERS = \
  16         align.h \
  17         list.h \
  18         macros.h \
  19         mmap-align.h \
  20         safe.h
  21
  22 # The following section is based on a similar feature in LTTng-tools.
  23
  24 ##
  25 ## This target generates an include file that contains the git version
  26 ## string of the current branch, it must be continuously updated when
  27 ## we build in the git repo and shipped in dist tarballs to reflect the
  28 ## status of the tree when it was generated. If the tree is clean and
  29 ## the current commit is tag a starting with "v", consider this a
  30 ## release version and set an empty git version.
  31 ##
  32 ## Here is what the inline script does:
  33 ##
  34 ## First, delete any stale "version.i.tmp" file.
  35 ##
  36 ## If "bootstrap" and ".git" exists in the top source directory and the git
  37 ## executable is available, get the current git version string in the form:
  38 ##
  39 ##  "latest_tag"(-"number_of_commits_on_top")(-g"latest_commit_hash")(-dirty)
  40 ##
  41 ## And store it in "version.i.tmp", if the current commit is tagged, the tag
  42 ## starts with "v" and the tree is clean, consider this a release version and
  43 ## overwrite the git version with an empty string in "version.i.tmp".
  44 ##
  45 ## If we don't have a "version.i.tmp" nor a "version.i", generate an empty
  46 ## string as a failover. If a "version.i" is present, for example when building
  47 ## from a distribution tarball, get the git_version using grep.
  48 ##
  49 ## Fetch the BT_VERSION_EXTRA_NAME define from "version/extra_version_name" and output it
  50 ## to "version.i.tmp".
  51 ##
  52 ## Fetch the BT_VERSION_EXTRA_DESCRIPTION define from "version/extra_version_description",
  53 ## sanitize and format it with a sed script to replace all non-alpha-numeric values
  54 ## with "-" and join all lines by replacing "\n" with litteral string c-style "\n" and
  55 ## output it to "version.i.tmp".
  56 ##
  57 ## Repeat the same logic for the "version/extra_patches" directory.
  58 ## Data fetched from "version/extra_patches" must be sanitized and
  59 ## formatted.
  60 ## The data is fetched using "ls" with an ignore pattern for the README.adoc file.
  61 ## The sanitize step uses sed with a script to replace all
  62 ## non-alpha-numeric values, except " " (space), to "-".
  63 ## The formatting step uses sed with a script to join all lines
  64 ## by replacing "\n" with litteral string c-style "\n".
  65 ##
  66 ## If we don't have a "version.i" or we have both files (version.i, version.i.tmp)
  67 ## and they are different, copy "version.i.tmp" over "version.i".
  68 ## This way the dependent targets are only rebuilt when the git version
  69 ## string or either one of extra version string change.
  70 ##
  71 version_verbose = $(version_verbose_@AM_V@)
  72 version_verbose_ = $(version_verbose_@AM_DEFAULT_V@)
  73 version_verbose_0 = @echo "  GEN       " $@;
  74
  75 version.i:
  76         $(version_verbose)rm -f version.i.tmp; \
  77         if (test ! -f version.i && test -f "$(top_srcdir)/include/version.i"); then \
  78                 cp "$(top_srcdir)/include/version.i" version.i; \
  79         fi; \
  80         if (test -r "$(top_srcdir)/bootstrap" && test -r "$(top_srcdir)/.git") && \
  81                         test -x "`which git 2>&1;true`"; then \
  82                 GIT_VERSION_STR="`cd "$(top_srcdir)" && git describe --tags --dirty`"; \
  83                 GIT_CURRENT_TAG="`cd "$(top_srcdir)" && git describe --tags --exact-match --match="v[0-9]*" HEAD 2> /dev/null`"; \
  84                 echo "#define BT_VERSION_GIT \"$$GIT_VERSION_STR\"" > version.i.tmp; \
  85                 if ! $(GREP) -- "-dirty" version.i.tmp > /dev/null && \
  86                                 test "x$$GIT_CURRENT_TAG" != "x"; then \
  87                         echo "#define BT_VERSION_GIT \"\"" > version.i.tmp; \
  88                 fi; \
  89         fi; \
  90         if test ! -f version.i.tmp; then \
  91                 if test -f version.i; then \
  92                         $(GREP) "^#define \bBT_VERSION_GIT\b.*" version.i > version.i.tmp; \
  93                 else \
  94                         echo '#define BT_VERSION_GIT ""' > version.i.tmp; \
  95                 fi; \
  96         fi; \
  97         echo "#define BT_VERSION_EXTRA_NAME \"`$(SED) -n '1p' "$(top_srcdir)/version/extra_version_name" 2> /dev/null`\"" >> version.i.tmp; \
  98         echo "#define BT_VERSION_EXTRA_DESCRIPTION \"`$(SED) -E ':a ; N ; $$!ba ; s/[^a-zA-Z0-9 \n\t\.,]/-/g ; s/\r{0,1}\n/\\\n/g' "$(top_srcdir)/version/extra_version_description" 2> /dev/null`\"" >> version.i.tmp; \
  99         echo "#define BT_VERSION_EXTRA_PATCHES \"`ls -1 "$(top_srcdir)/version/extra_patches" | $(GREP) -v '^README.adoc' | $(SED) -E ':a ; N ; $$!ba ; s/[^a-zA-Z0-9 \n\t\.]/-/g ; s/\r{0,1}\n/\\\n/g' 2> /dev/null`\"" >> version.i.tmp; \
 100         if test ! -f version.i || \
 101                         test x"`cat version.i.tmp`" != x"`cat version.i`"; then \
 102                 mv version.i.tmp version.i; \
 103         fi; \
 104         rm -f version.i.tmp; \
 105         true
 106
 107 ##
 108 ## version.i is defined as a .PHONY target even if it's a real file,
 109 ## we want the target to be re-run on every make.
 110 ##
 111 .PHONY: version.i
 112
 113 CLEANFILES = version.i.tmp
 114
 115 ##
 116 ## Only clean "version.i" on dist-clean, we need to keep it on regular
 117 ## clean when it's part of a dist tarball.
 118 ##
 119 DISTCLEANFILES = version.i
 120
 121 noinst_HEADERS += version.h version.i