Better experience for shallow repository #534
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cloning the repository with the --depth option is useful when you do
not need the full git history, but it fails to build core/version.c
$ git clone --depth 1 git://git.ipxe.org/ipxe.git
$ cd ipxe/src
$ make
[snip]
[VERSION] bin/version.ipxe.dsk.o
In file included from include/ipxe/features.h:6,
from core/version.c:33:
<command-line>: error: unsigned conversion from ‘int’ to ‘unsigned char’ changes value from ‘9062’ to ‘102’ [-Werror=overflow]
include/ipxe/dhcp.h:529:58: note: in definition of macro ‘DHCP_OPTION’
529 | #define DHCP_OPTION( ... ) VA_ARG_COUNT ( __VA_ARGS__ ), __VA_ARGS__
| ^~~~~~~~~~~
...
A shallow-cloned repository may not have any tag at all, then it returns
only a commit hash.
$ git describe --tags --always --long --abbrev=1 --match "v*"
9062
In such a case, VERSION_MINOR becomes empty, causing the build error.
If 'git describe' does not find any tag, let the version macros fall
back to the default:
VERSION_MAJOR = 1
VERSION_MINOR = 0
VERSION_PATCH = 0
EXTRAVERSION = +
Setting sha1 to GITVERSION is still useful.
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
git-describe(3) says:
--abbrev=<n>
Instead of using the default 7 hexadecimal digits as the
abbreviated object name, use <n> digits, or as many digits
as needed to form a unique object name. An <n> of 0 will
suppress long format, only showing the closest tag.
The number of "digits needed to form a unique object name" depends
on your git repository, e.g. 1) how you cloned it, 2) how many local
branches you have, etc.
In the full cloned repository, --abbrev=1 for v1.21.1 gave me 5-digits
as of writing (but it may increase in the future):
$ git checkout v1.21.1
$ git describe --tags --always --long --abbrev=1 --match 'v*'
v1.21.1-0-g988d2
In the repository cloned with --depth 1000, it is 4-digits.
$ git clone --depth 1000 git://git.ipxe.org/ipxe.git
$ ipxe
$ git checkout v1.21.1
$ git describe --tags --always --long --abbrev=1 --match 'v*'
v1.21.1-0-g988d
To make the version string deterministic, use --abbrev=32 and then
take the first 7 characters, which is reasonable for this project.
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
This comment was marked as abuse.
This comment was marked as abuse.
|
Any feedback please? |
|
I agree that having a shallow clone just fail is not good, but on the other hand there is other configs in iPXE that fails builds without a clear reason as well. Guarding for everything is not possible. Do we really want to support these builds? What is the result (VERSION) with this patch using shallow and full clone? |
|
I also got hit by this today when building in GitLab CI, in a project where ipxe is a submodule. |
This comment was marked as abuse.
This comment was marked as abuse.
habetsm-xilinx
approved these changes
Nov 22, 2022
This comment was marked as abuse.
This comment was marked as abuse.
|
I was trying a build in Azure Devops CI and it failed with errors like in #974, which led me here (eventually) |
This comment was marked as abuse.
This comment was marked as abuse.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current assumption is that, if the .git directory exists, at least one tag must exist. Otherwise, builds fail and the reason of the failure is not clear.
From users' perspective, having the full git history is not necessary. In fact, shallow clone (git clone --depth=) is often used by umbrella projects since having the HEAD is enough for compilation.
This pull request fixes the broken build, and makes version string deterministic.