Makefile.include: remove RIOT_VERSION_OVERRIDE

[cladmi]

Contribution description

RIOT_VERSION is not used for building a specific RIOT version anymore
since #10543. The variable can now be used directly.

This now depends on #11881 which prevents calling git describe

When building with RIOT_CI_BUILD=1 this also now prevents calling
git describe and git rev-parse which saves around 0.1 seconds
per execution on my machine.

Testing procedure

No more usage in RIOT reported by git grep RIOT_VERSION_OVERRIDE

The buildtest version is correctly used for CI builds

RIOT_CI_BUILD=1 make --no-print-directory -C examples/hello-world/ info-debug-variable-RIOT_VERSION info-debug-variable-CFLAGS_WITH_MACROS
buildtest
-DDEVELHELP -Werror -Wall -Wextra -pedantic -std=gnu99 -m32 -fstack-protector-all -ffunction-sections -fdata-sections -DDEBUG_ASSERT_VERBOSE -DRIOT_APPLICATION="hello-world" -DBOARD_NATIVE="native" -DRIOT_BOARD=BOARD_NATIVE -DCPU_NATIVE="native" -DRIOT_CPU=CPU_NATIVE -DMCU_NATIVE="native" -DRIOT_MCU=MCU_NATIVE -fno-delete-null-pointer-checks -fdiagnostics-color -Wstrict-prototypes -Wold-style-definition -fno-common -Wall -Wextra -Wformat=2 -Wformat-overflow -Wformat-truncation -Wmissing-include-dirs -DMODULE_AUTO_INIT -DMODULE_BOARD -DMODULE_CORE -DMODULE_CORE_MSG -DMODULE_CPU -DMODULE_NATIVE_DRIVERS -DMODULE_PERIPH -DMODULE_PERIPH_COMMON -DMODULE_PERIPH_GPIO -DMODULE_PERIPH_PM -DMODULE_PERIPH_UART -DMODULE_SYS -DRIOT_VERSION="buildtest"

The version is used when given in the environment

RIOT_VERSION=beer make --no-print-directory -C examples/hello-world/ info-debug-variable-RIOT_VERSION info-debug-variable-CFLAGS_WITH_MACROS 
beer
-DDEVELHELP -Werror -Wall -Wextra -pedantic -std=gnu99 -m32 -fstack-protector-all -ffunction-sections -fdata-sections -DDEBUG_ASSERT_VERBOSE -DRIOT_APPLICATION="hello-world" -DBOARD_NATIVE="native" -DRIOT_BOARD=BOARD_NATIVE -DCPU_NATIVE="native" -DRIOT_CPU=CPU_NATIVE -DMCU_NATIVE="native" -DRIOT_MCU=MCU_NATIVE -fno-delete-null-pointer-checks -fdiagnostics-color -Wstrict-prototypes -Wold-style-definition -fno-common -Wall -Wextra -Wformat=2 -Wformat-overflow -Wformat-truncation -Wmissing-include-dirs -DMODULE_AUTO_INIT -DMODULE_BOARD -DMODULE_CORE -DMODULE_CORE_MSG -DMODULE_CPU -DMODULE_NATIVE_DRIVERS -DMODULE_PERIPH -DMODULE_PERIPH_COMMON -DMODULE_PERIPH_GPIO -DMODULE_PERIPH_PM -DMODULE_PERIPH_UART -DMODULE_SYS -DRIOT_VERSION="beer"

Speed update given by #11881 directly

Doing nothing is way faster for me, let's see the difference in CI, as in the RIOT_CI_BUILD=1 context, the value from git describe is completely unnecessary.

time for i in {0..100}; do make --no-print-directory -C examples/hello-world/ info-debug-variable-ABC >/dev/null 2>/dev/null; done

real    0m19.081s
user    0m17.045s
sys     0m2.721s

time for i in {0..100}; do RIOT_CI_BUILD=1 make --no-print-directory -C examples/hello-world/ info-debug-variable-ABC >/dev/null 2>/dev/null; done

real    0m9.405s
user    0m7.987s
sys     0m2.092s

Issues/PRs references

Tracking: remove harmful use of export in make and immediate evaluation #10850
Depends on #11881
Makefile.include: remove functionality to build with another version. #10543

[cladmi]

Not sure if the value is accurate, but compared to #11478, that also did not change any source code:

The build time went down 4 hours

• total cpu runtime: 1d:16h:05m:53.7s https://ci.riot-os.org/RIOT-OS/RIOT/11478/fecc9c178d2300cd4bdca445be79c6faa40b4460/output.html
• total cpu runtime: 1d:12h:15m:20.6s https://ci.riot-os.org/RIOT-OS/RIOT/11771/4c69437fdbc0e3b012af60e592ed89b3d2f56acf/output.html

[cladmi]

EDIT: The whole case is now optimized by being based on #11881

This currently optimize the CI build and not cases where RIOT_VERSION is unused by a target. It is a different task that I plan to do now that #11664 is merged, tracked by #10850

Only evaluating when needed would not help murdock as it sets RIOT_CI_BUILD anyway.

[kaspar030]

I'm about to ACK. Should we add some kind of deprecation warning? I know my finger muscles will type RIOT_VERSION_OVERRIDE for a long time...

[miri64]

👍 for warning when RIOT_VERSION_OVERRIDE is set.

[cladmi]

I thought it was not needed for configuration changes, I will add it.

[cladmi]

I handled it with a warning and kept the old behavior when set.
Should I put a removal date ?

It will still evaluate git describe as I wanted to put the handling near original usage.

Testing procedure for the deprecation handling:

RIOT_VERSION_OVERRIDE=manually_set make --no-print-directory -C examples/hello-world/ info-debug-variable-RIOT_VERSION info-debug-variable-CFLAGS_WITH_MACROS 
/home/harter/work/git/worktree/riot_test/examples/hello-world/../../Makefile.include:723: 'RIOT_VERSION_OVERRIDE' is deprecated, it can now be set with 'RIOT_VERSION' directly.
manually_set
-DDEVELHELP -Werror -Wall -Wextra -pedantic -std=gnu99 -m32 -fstack-protector-all -ffunction-sections -fdata-sections -DDEBUG_ASSERT_VERBOSE -DRIOT_APPLICATION="hello-world" -DBOARD_NATIVE="native" -DRIOT_BOARD=BOARD_NATIVE -DCPU_NATIVE="native" -DRIOT_CPU=CPU_NATIVE -DMCU_NATIVE="native" -DRIOT_MCU=MCU_NATIVE -fno-delete-null-pointer-checks -fdiagnostics-color -Wstrict-prototypes -Wold-style-definition -fno-common -Wall -Wextra -Wformat=2 -Wformat-overflow -Wformat-truncation -Wmissing-include-dirs -DMODULE_AUTO_INIT -DMODULE_BOARD -DMODULE_CORE -DMODULE_CORE_MSG -DMODULE_CPU -DMODULE_NATIVE_DRIVERS -DMODULE_PERIPH -DMODULE_PERIPH_COMMON -DMODULE_PERIPH_GPIO -DMODULE_PERIPH_PM -DMODULE_PERIPH_UART -DMODULE_SYS -DRIOT_VERSION="manually_set"

[cladmi]

Rebased on #11881 to provide the speed boost also when not using RIOT_VERSION even without RIOT_CI_BUILD

[miri64]

I just merged #11881. Please rebase again (or close...? #11881 said it was an alternative to this so why is it included here? ❓ ).

[cladmi]

Indeed, I thought about rebasing this one after writing the other PR description so ended up being not consistent with the introduction sentence.

The speed improvement is now not provided by this PR anymore and it just replaces RIOT_VERSION_OVERRIDE with RIOT_VERSION.

[kaspar030]

LGTM. please squash

[cladmi]

Squashed.

[jcarrano]

Ok.

[cladmi]

Thank you for the review.