Doc/components: Updare refresh.sh to show usage examples
Build Documentation / build-html (push) Has been cancelled

This commit makes it clear how to use the refresh.sh script to
update board configs showing differents usages cenarios.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
This commit is contained in:
Alan Carvalho de Assis
2025-07-05 09:52:11 -03:00
committed by Xiang Xiao
parent f0270eb349
commit 27e2f51d2e
+23 -1
View File
@@ -877,7 +877,7 @@ Help is also available::
$ tools/refresh.sh --help $ tools/refresh.sh --help
tools/refresh.sh is a tool for refreshing board configurations tools/refresh.sh is a tool for refreshing board configurations
USAGE: ``./refresh.sh [options] <board>/<config>+`` USAGE: ``./refresh.sh [options] <arch>|<chip>|<board>:<config>+``
Where [options] include:: Where [options] include::
@@ -930,6 +930,28 @@ The steps to refresh the file taken by refresh.sh are:
refresh.sh will prompt you first to avoid overwriting the refresh.sh will prompt you first to avoid overwriting the
defconfig file with changes that you may not want. defconfig file with changes that you may not want.
Usage examples:
Update all boards without verbose output::
$ ./tools/refresh.sh --silent --defaults all
Update all boards and configs from `arm` architecture::
$ ./tools/refresh.sh --silent arch:arm
Update all boards from `stm32f7` chip family::
$ ./tools/refresh.sh --silent chip:stm32f7
Update all configs from `stm32f103-minimum` board::
$ ./tools/refresh.sh --silent board:stm32f103-minimum
Update only the `nsh` config from stm32f103-minimum board::
$ ./tools/refresh.sh --silent stm32f103-minimum:nsh
rmcr.c rmcr.c
------ ------