This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 27e2f51d2e Doc/components: Updare refresh.sh to show usage examples
27e2f51d2e is described below
commit 27e2f51d2e178f1893647003b5c44013b37b03bc
Author: Alan Carvalho de Assis <acas...@gmail.com>
AuthorDate: Sat Jul 5 09:52:11 2025 -0300
Doc/components: Updare refresh.sh to show usage examples
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 <acas...@gmail.com>
---
Documentation/components/tools/index.rst | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/Documentation/components/tools/index.rst
b/Documentation/components/tools/index.rst
index 5f4a5749e4..4f21d7f79c 100644
--- a/Documentation/components/tools/index.rst
+++ b/Documentation/components/tools/index.rst
@@ -877,7 +877,7 @@ Help is also available::
$ tools/refresh.sh --help
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::
@@ -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
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
------
