XRT Version extraction scheme does not work when building from tagged releases

Open
#6,794 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, git
Domain
build-system

Research direction

Start by reproducing the build from the tagged archive 202210.2.13.466.tar.gz and trace how version.json and version.h are generated. Done means the archive builds without the Git repository errors and both generated files report version 2.13.466 rather than 2.13.0.

Written by the indexing model from the issue text.

Description

For instance if you try to build XRT from a tagged release such as:

https://github.com/Xilinx/XRT/archive/refs/tags/202210.2.13.466.tar.gz

You will see errors when building, such as:

fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
fatal: not a git repository (or any parent up to mount point /)
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).

And the generated / included version.json and version.h will have the incorrect release number.

In this case, it will state "2.13.0" instead of "2.13.466".

Dominant language
C++
Stars
686
Forks
549
Avg merge
2d 4h
Merged PRs (30d)
70

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Xilinx/XRT

All issues in Xilinx/XRT

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.