From 314b3374c67ad0dbfe7d389447c3e77d04fe69c2 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Fri, 6 Dec 2024 12:37:04 +0100 Subject: [PATCH] =?UTF-8?q?doc/compare-build-sizes:=20move=20to=20?= =?UTF-8?q?=E2=80=9CAdvanced=20build=20system=20tricks=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/doxygen/riot.doxyfile | 1 - .../src/advanced-build-system-tricks.md | 25 +++++++++++++++++++ doc/doxygen/src/comparing-build-sizes.md | 24 ------------------ 3 files changed, 25 insertions(+), 25 deletions(-) delete mode 100644 doc/doxygen/src/comparing-build-sizes.md diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 186917079dbc..b6febd4ba04c 100644 --- 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 index e794896bee29..386490c59525 100644 --- 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 deleted file mode 100644 index 3b0dc01fa889..000000000000 --- a/doc/doxygen/src/comparing-build-sizes.md +++ /dev/null @@ -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.)