simbit18 commented on code in PR #18495:
URL: https://github.com/apache/nuttx/pull/18495#discussion_r2889101282
##########
Documentation/components/tools/testbuild.rst:
##########
@@ -0,0 +1,73 @@
+================
+``testbuild.sh``
+================
+
+This script automates building of a set of configurations. The intent is
+simply to assure that the set of configurations build correctly. The -h
+option shows the usage:
+
+.. code:: console
+
+ $ ./testbuild.sh -h
+
+ USAGE: ./testbuild.sh [-l|m|c|g|n] [-d] [-e <extraflags>] [-x] [-j <ncpus>]
[-a <appsdir>] [-t <topdir>] [-p] [-G] <testlist-file>
+ ./testbuild.sh -h
+
+ Where:
+ -l|m|c|g|n selects Linux (l), macOS (m), Cygwin (c),
+ MSYS/MSYS2 (g) or Windows native (n). Default Linux
+ -d enables script debug output
+ -e pass extra c/c++ flags such as -Wno-cpp via make command line
+ -x exit on build failures
+ -j <ncpus> passed on to make. Default: No -j make option.
+ -a <appsdir> provides the relative path to the apps/ directory. Default
../apps
+ -t <topdir> provides the absolute path to top nuttx/ directory. Default
../nuttx
+ -p only print the list of configs without running any builds
+ -A store the build executable artifact in ARTIFACTDIR (defaults to
../buildartifacts
+ -C Skip tree cleanness check.
+ -G Use "git clean -xfdq" instead of "make distclean" to clean the tree.
+ This option may speed up the builds. However, note that:
+ * This assumes that your trees are git based.
+ * This assumes that only nuttx and apps repos need to be cleaned.
+ * If the tree has files not managed by git, they will be removed
+ as well.
+ -R execute "run" script in the config directories if exists.
Review Comment:
help not updated missing
-N Use CMake with Ninja as the backend."
and
-S Adds the nxtmpdir folder for third-party packages."
```
echo "USAGE: $progname -h [-l|m|c|g|n] [-d] [-e <extraflags>] [-x] [-j
<ncpus>] [-a <appsdir>] [-t <topdir>] [-p]"
echo " [-A] [-C] [-G] [-N] [-R] [-S] [--codechecker] <testlist-file>"
echo ""
echo "Where:"
echo " -h will show this help test and terminate"
echo " -l|m|c|g|n selects Linux (l), macOS (m), Cygwin (c),"
echo " MSYS/MSYS2 (g) or Windows native (n). Default Linux"
echo " -d enables script debug output"
echo " -e pass extra c/c++ flags such as -Wno-cpp via make command line"
echo " -x exit on build failures"
echo " -j <ncpus> passed on to make. Default: No -j make option."
echo " -a <appsdir> provides the relative path to the apps/ directory.
Default ../apps"
echo " -t <topdir> provides the absolute path to top nuttx/ directory.
Default ../nuttx"
echo " -p only print the list of configs without running any builds"
echo " -A store the build executable artifact in ARTIFACTDIR (defaults to
../buildartifacts"
echo " -C Skip tree cleanness check."
echo " -G Use \"git clean -xfdq\" instead of \"make distclean\" to clean
the tree."
echo " This option may speed up the builds. However, note that:"
echo " * This assumes that your trees are git based."
echo " * This assumes that only nuttx and apps repos need to be
cleaned."
echo " * If the tree has files not managed by git, they will be
removed"
echo " as well."
echo " -N Use CMake with Ninja as the backend."
echo " -R execute \"run\" script in the config directories if exists."
echo " -S Adds the nxtmpdir folder for third-party packages."
echo " --codechecker enables CodeChecker s
```
https://github.com/apache/nuttx/blob/master/tools/testbuild.sh#L66C1-L99C9
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
