OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
sof/scripts/cmake/dist.cmake

36 lines
1.6 KiB
CMake
Raw Normal View History

cmake: add spdx license identifier Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-06-02 03:33:40 +08:00
# SPDX-License-Identifier: BSD-3-Clause
dist.cmake: add --prefix to git archive to stop creating a "tarbomb" A "tarbomb" is an archive file that has more than one directory at the top level, which is (fortunately) unusual for .tar files. By default, tar extracts archive members "as is" in the current directory. If the archive has many top level members then it becomes very hard to make the difference between what was just extracted versus what was already there. As extraction is recursive this gets much worse because the problem can repeat itself in subdirectories. As the last but not least nail in the coffin, tar silently overwrites existing files by default. This commit is admittedly an "incompatible build API change" meaning any higher level build or packaging script that was consuming source release tarballs (as opposed to git cloning the source) will require a small change. Consumers of release tarballs must be rare though because the output of "make dist" has already been broken by commit c00d39c71b45 ("Add rimage as a git submodule") anyway yet no one noticed yet. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-07-07 01:55:51 +08:00
# This creates a release tarball from a git checkout.
#
# Warning: a ".tarball-version" at the top of the source directory takes
# precedence; even for git checkouts it does! This can be used to make
# the build "more deterministic". See GIT_TAG in version.cmake.
cmake: add dist target Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-02-05 19:41:25 +08:00
dist.cmake: add --prefix to git archive to stop creating a "tarbomb" A "tarbomb" is an archive file that has more than one directory at the top level, which is (fortunately) unusual for .tar files. By default, tar extracts archive members "as is" in the current directory. If the archive has many top level members then it becomes very hard to make the difference between what was just extracted versus what was already there. As extraction is recursive this gets much worse because the problem can repeat itself in subdirectories. As the last but not least nail in the coffin, tar silently overwrites existing files by default. This commit is admittedly an "incompatible build API change" meaning any higher level build or packaging script that was consuming source release tarballs (as opposed to git cloning the source) will require a small change. Consumers of release tarballs must be rare though because the output of "make dist" has already been broken by commit c00d39c71b45 ("Add rimage as a git submodule") anyway yet no one noticed yet. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-07-07 01:55:51 +08:00
set(TAR_BASENAME sof-${GIT_TAG})
set(TARBALL_PATH_TMP "${PROJECT_BINARY_DIR}/${TAR_BASENAME}.tar")
set(TARBALL_PATH "${PROJECT_BINARY_DIR}/${TAR_BASENAME}.tgz")
cmake: add dist target Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-02-05 19:41:25 +08:00
set(TARBALL_VERSION_BINARY_PATH "${PROJECT_BINARY_DIR}/${TARBALL_VERSION_FILE_NAME}")
add_custom_target(dist
dist.cmake: add --prefix to git archive to stop creating a "tarbomb" A "tarbomb" is an archive file that has more than one directory at the top level, which is (fortunately) unusual for .tar files. By default, tar extracts archive members "as is" in the current directory. If the archive has many top level members then it becomes very hard to make the difference between what was just extracted versus what was already there. As extraction is recursive this gets much worse because the problem can repeat itself in subdirectories. As the last but not least nail in the coffin, tar silently overwrites existing files by default. This commit is admittedly an "incompatible build API change" meaning any higher level build or packaging script that was consuming source release tarballs (as opposed to git cloning the source) will require a small change. Consumers of release tarballs must be rare though because the output of "make dist" has already been broken by commit c00d39c71b45 ("Add rimage as a git submodule") anyway yet no one noticed yet. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-07-07 01:55:51 +08:00
COMMAND git archive --prefix=${TAR_BASENAME}/ -o "${TARBALL_PATH_TMP}" HEAD
# .tarball-version in the top build directory for git users' convenience
cmake: add dist target Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-02-05 19:41:25 +08:00
COMMAND ${CMAKE_COMMAND} -E echo "${GIT_TAG}" > "${TARBALL_VERSION_BINARY_PATH}"
COMMAND ${CMAKE_COMMAND} -E echo "${GIT_LOG_HASH}" >> "${TARBALL_VERSION_BINARY_PATH}"
dist.cmake: add --prefix to git archive to stop creating a "tarbomb" A "tarbomb" is an archive file that has more than one directory at the top level, which is (fortunately) unusual for .tar files. By default, tar extracts archive members "as is" in the current directory. If the archive has many top level members then it becomes very hard to make the difference between what was just extracted versus what was already there. As extraction is recursive this gets much worse because the problem can repeat itself in subdirectories. As the last but not least nail in the coffin, tar silently overwrites existing files by default. This commit is admittedly an "incompatible build API change" meaning any higher level build or packaging script that was consuming source release tarballs (as opposed to git cloning the source) will require a small change. Consumers of release tarballs must be rare though because the output of "make dist" has already been broken by commit c00d39c71b45 ("Add rimage as a git submodule") anyway yet no one noticed yet. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-07-07 01:55:51 +08:00
# ${TAR_BASENAME}/.tarball-version for the release tarball
COMMAND ${CMAKE_COMMAND} -E make_directory "${PROJECT_BINARY_DIR}/${TAR_BASENAME}"
COMMAND ${CMAKE_COMMAND} -E copy "${TARBALL_VERSION_BINARY_PATH}" "${PROJECT_BINARY_DIR}/${TAR_BASENAME}/${TARBALL_VERSION_FILE_NAME}"
COMMAND tar rf "${TARBALL_PATH_TMP}" -C "${PROJECT_BINARY_DIR}" "${TAR_BASENAME}/${TARBALL_VERSION_FILE_NAME}"
cmake: add dist target Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-02-05 19:41:25 +08:00
COMMAND gzip -9 < "${TARBALL_PATH_TMP}" > "${TARBALL_PATH}"
dist.cmake: add --prefix to git archive to stop creating a "tarbomb" A "tarbomb" is an archive file that has more than one directory at the top level, which is (fortunately) unusual for .tar files. By default, tar extracts archive members "as is" in the current directory. If the archive has many top level members then it becomes very hard to make the difference between what was just extracted versus what was already there. As extraction is recursive this gets much worse because the problem can repeat itself in subdirectories. As the last but not least nail in the coffin, tar silently overwrites existing files by default. This commit is admittedly an "incompatible build API change" meaning any higher level build or packaging script that was consuming source release tarballs (as opposed to git cloning the source) will require a small change. Consumers of release tarballs must be rare though because the output of "make dist" has already been broken by commit c00d39c71b45 ("Add rimage as a git submodule") anyway yet no one noticed yet. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-07-07 01:55:51 +08:00
cmake: add dist target Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-02-05 19:41:25 +08:00
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
dist.cmake: add 'rebuild_cache' warning. dist.cmake is (for now) the only .cmake file that uses GIT_TAG at _cmake configure time_. This means even "make clean" is not enough for dist.cmake to take into account some git tag or version change. It's very confusing because on the other hand "make check_version_h" and everything else always shows up-to-date git information. "make rebuild_cache" addresses this situation so mention it in a warning. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-07-10 03:27:57 +08:00
COMMENT "Creating tarball: ${TARBALL_PATH}
Warning: you must invoke make/ninja 'rebuild_cache' when the version changes, 'clean' is not enough.
"
cmake: add dist target Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2019-02-05 19:41:25 +08:00
BYPRODUCTS "$TARBALL_VERSION_BINARY_PATH" "${TARBALL_PATH_TMP}" "${TARBALL_PATH}"
VERBATIM
USES_TERMINAL
)