Skip to contentSkip to conversation

support/download/git: rename local refs to avoid confusing Git warning

PATCH New Thomas Petazzoni 2 participants 2 messages Dec 12, 2019 – Dec 29, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 support/download/git: rename local refs to avoid confusing Git warning

Running "git fetch origin ${cset}:${cset}" to create a local ref ${cset} from the remote ref ${cset} causes Git to issue a warning like the below, when the version is a full commit hash:

===

warning: refname '49eb4ecb1ef9879ebc6789a1bdb536ab2b1d9871' is ambiguous. Git normally never creates a ref that ends with 40 hex characters because it will be ignored when you just specify 40-hex. These refs may be created by mistake. For example,

  git switch -c $br $(git rev-parse ...)

where "$br" is somehow empty and a 40-hex ref is created. Please examine these refs and maybe delete them. Turn this message off by running "git config advice.objectNameWarning false"

===

This warning is very confusing for users, and is caused by the fact that Git doesn't like our local ref name to look like a commit hash.

So, this commit proposes to fix the issue by having the local ref named buildroot-${cset}, i.e buildroot-${version-specified-by-the-package}.

The generated tarballs are exactly identical, nothing changes, it is really just internally the local ref we are using to checkout the correct version that is different. And it avoids the confusing warning.

---
 support/download/git | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
support/download/git +3 -3
index 075f665bbf..c243b8aa9f 100755
@@ -122,14 +122,14 @@ _git fetch origin -t
 # below, if there is an issue anyway. Since most of the cset we're gonna
 # have to clone are not such special refs, consign the output to oblivion
 # so as not to alarm unsuspecting users, but still trace it as a warning.
-if ! _git fetch origin "'${cset}:${cset}'" >/dev/null 2>&1; then
+if ! _git fetch origin "'${cset}:buildroot-${cset}'" >/dev/null 2>&1; then
     printf "Could not fetch special ref '%s'; assuming it is not special.\n" "${cset}"
 fi
 
 # Check that the changeset does exist. If it does not, re-cloning from
 # scratch won't help, so we don't want to trash the repository for a
 # missing commit. We just exit without going through the ERR trap.
-if ! _git rev-parse --quiet --verify "'${cset}^{commit}'" >/dev/null 2>&1; then
+if ! _git rev-parse --quiet --verify "'buildroot-${cset}^{commit}'" >/dev/null 2>&1; then
     printf "Commit '%s' does not exist in this repository.\n" "${cset}"
     exit 1
 fi
@@ -162,7 +162,7 @@ _git submodule --quiet foreach "'${cmd}'"
 
 # Checkout the required changeset, so that we can update the required
 # submodules.
-_git checkout -f -q "'${cset}'"
+_git checkout -f -q "'buildroot-${cset}'"
 
 # Get rid of now-untracked directories (in case a git operation was
 # interrupted in a previous run, or to get rid of empty directories
Signature · 1 line
2.23.0
#1 lore raw

PATCH 1/1 support/download/git: rename local refs to avoid confusing Git warning

Thomas, All,

On 2019-12-12 15:43 +0100, Thomas Petazzoni spake thusly:

Quoted 17 lines

Running "git fetch origin ${cset}:${cset}" to create a local ref ${cset} from the remote ref ${cset} causes Git to issue a warning like the below, when the version is a full commit hash:

===

warning: refname '49eb4ecb1ef9879ebc6789a1bdb536ab2b1d9871' is ambiguous. Git normally never creates a ref that ends with 40 hex characters because it will be ignored when you just specify 40-hex. These refs may be created by mistake. For example,

  git switch -c $br $(git rev-parse ...)

where "$br" is somehow empty and a 40-hex ref is created. Please examine these refs and maybe delete them. Turn this message off by running "git config advice.objectNameWarning false"

Quoted 8 lines

===

This warning is very confusing for users, and is caused by the fact that Git doesn't like our local ref name to look like a commit hash.

So, this commit proposes to fix the issue by having the local ref named buildroot-${cset}, i.e buildroot-${version-specified-by-the-package}.

I was ready to push, when I remembered we had run-time tests for the git backend, so I ran them.

Sorry, but that does not pass muster:

    $ ./support/testing/run-tests -o $(pwd)/test-it -k tests.download.test_git
    22:05:07 TestGitRefs                              Starting
    22:05:57 TestGitRefs                              Cleaning up
    E22:05:57 TestGitHash                              Starting
    22:06:53 TestGitHash                              Cleaning up
    .
    ======================================================================
    ERROR: test_run (tests.download.test_git.TestGitRefs)
    ----------------------------------------------------------------------
    Traceback (most recent call last):
      File "/home/ymorin/dev/buildroot/buildroot/support/testing/tests/download/test_git.py", line 69, in test_run
        self.check_download("git-partial-sha1-branch-head")
      File "/home/ymorin/dev/buildroot/buildroot/support/testing/tests/download/test_git.py", line 48, in check_download
        env)
      File "/home/ymorin/dev/buildroot/buildroot/support/testing/infra/builder.py", line 75, in build
        raise SystemError("Build failed")
    SystemError: Build failed
    ----------------------------------------------------------------------
    Ran 2 tests in 106.080s

    FAILED (errors=1)

The same tests are passing on master, though.

I've marked your patch as changes requested, then.

Regards,
Yann E. MORIN.

Quoted 43 lines

The generated tarballs are exactly identical, nothing changes, it is really just internally the local ref we are using to checkout the correct version that is different. And it avoids the confusing warning.

---
 support/download/git | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
support/download/git +3 -3
index 075f665bbf..c243b8aa9f 100755
@@ -122,14 +122,14 @@ _git fetch origin -t
 # below, if there is an issue anyway. Since most of the cset we're gonna
 # have to clone are not such special refs, consign the output to oblivion
 # so as not to alarm unsuspecting users, but still trace it as a warning.
-if ! _git fetch origin "'${cset}:${cset}'" >/dev/null 2>&1; then
+if ! _git fetch origin "'${cset}:buildroot-${cset}'" >/dev/null 2>&1; then
     printf "Could not fetch special ref '%s'; assuming it is not special.\n" "${cset}"
 fi
 
 # Check that the changeset does exist. If it does not, re-cloning from
 # scratch won't help, so we don't want to trash the repository for a
 # missing commit. We just exit without going through the ERR trap.
-if ! _git rev-parse --quiet --verify "'${cset}^{commit}'" >/dev/null 2>&1; then
+if ! _git rev-parse --quiet --verify "'buildroot-${cset}^{commit}'" >/dev/null 2>&1; then
     printf "Commit '%s' does not exist in this repository.\n" "${cset}"
     exit 1
 fi
@@ -162,7 +162,7 @@ _git submodule --quiet foreach "'${cmd}'"
 
 # Checkout the required changeset, so that we can update the required
 # submodules.
-_git checkout -f -q "'${cset}'"
+_git checkout -f -q "'buildroot-${cset}'"
 
 # Get rid of now-untracked directories (in case a git operation was
 # interrupted in a previous run, or to get rid of empty directories
Signature · 1 line
2.23.0
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'