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

miri64 · Dec 6, 2024 · 314b337 · 314b337
1 parent 1b86fe3
commit 314b337
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 25 deletions.
diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile
@@ -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 \

diff --git a/doc/doxygen/src/advanced-build-system-tricks.md b/doc/doxygen/src/advanced-build-system-tricks.md
@@ -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}
 ============================
 

diff --git a/doc/doxygen/src/comparing-build-sizes.md b/doc/doxygen/src/comparing-build-sizes.md