1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 06:23:53 +01:00

doc/compare-build-sizes: move to “Advanced build system tricks”

This commit is contained in:
Martine Lenders 2024-12-06 12:37:04 +01:00
parent 1b86fe3ea1
commit 314b3374c6
No known key found for this signature in database
GPG Key ID: 2134D77A5336DD80
3 changed files with 25 additions and 25 deletions

View File

@ -878,7 +878,6 @@ INPUT = ../../doc.txt \
src/build-in-docker.md \
../../tests/README.md \
src/dev-best-practices.md \
src/comparing-build-sizes.md \
src/static-vs-dynamic-memory.md \
src/build-system-basics.md \
src/feature_list.md \

View File

@ -175,6 +175,31 @@ By exporting the `BUILD_DIR` environment variable, a custom build / clone cache
directory can be created. This can be particularly useful when working with
multiple git work trees or clones of the RIOT repository.
Comparing Build Sizes {#comparing-build-sizes}
=====================
There is a make target for build size comparison. You can use it like that:
~~~~~~~~~~~~~~~~~~~
$ cd RIOT/test/test_something
$ git checkout master
$ BINDIRBASE=master-bin make buildtest
$ git checkout my-branch
$ BINDIRBASE=my-branch-bin make buildtest
$ OLDBIN=master-bin NEWBIN=my-branch-bin make info-buildsizes-diff
text data bss dec BOARD/BINDIRBASE
0 0 0 0 avsextrem **← this line contains the diff**
57356 1532 96769 155657 master-bin
57356 1532 96769 155657 my-branch-bin
...
~~~~~~~~~~~~~~~~~~~
Check it out, the output contains colors. ;)
RIOT-aware Completion in zsh {#zsh-completion-for-riot}
============================

View File

@ -1,24 +0,0 @@
There is a make target for build size comparison. You can use it like that:
```
$ cd RIOT/test/test_something
$ git checkout master
$ BINDIRBASE=master-bin make buildtest
$ git checkout my-branch
$ BINDIRBASE=my-branch-bin make buildtest
$ OLDBIN=master-bin NEWBIN=my-branch-bin make info-buildsizes-diff
text data bss dec BOARD/BINDIRBASE
0 0 0 0 avsextrem **← this line contains the diff**
57356 1532 96769 155657 master-bin
57356 1532 96769 155657 my-branch-bin
...
```
**Note:** make info-buildsizes-diff needs bash 4, so your system must not be older than 20-Feb-2009 …
Check it out, the output contains colors. ;)
(This page is mostly a copy of René Kijewski's explanation in https://github.com/RIOT-OS/RIOT/pull/1033.)