next-checks: check cargo doc for all rf-a platforms
`cargo doc` is not a platform independent test in the case
of the rf-a repository..
For the rest of the crates, `cargo doc` should still be a platform
independent test.
* Run `cargo doc` on rf-a for all platforms. Remove rf-a's
`cargo doc` tests from the platform independent testing scripts
and add it to the next-checks (static checks) scripts.
Change-Id: Ib605d674bff2490f84837a1c565dbd333fa5657b
Signed-off-by: Tomás González <tomasagustin.gonzalezorlando@arm.com>
diff --git a/script/next-checks/next-checks-cargo-doc.sh b/script/next-checks/next-checks-cargo-doc.sh
new file mode 100755
index 0000000..073953f
--- /dev/null
+++ b/script/next-checks/next-checks-cargo-doc.sh
@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2025 Arm Limited. All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#
+
+this_dir="$(readlink -f "$(dirname "$0")")"
+. $this_dir/../static-checks/common.sh
+
+TF_ROOT="$1"
+TEST_CASE="Rust cargo doc checks"
+LOG_FILE=`mktemp -t common.XXXX`
+EXIT_VALUE=0
+
+echo "# ${TEST_CASE}"
+echo >> "$LOG_TEST_FILENAME"
+echo "****** $TEST_CASE ******" >> "$LOG_TEST_FILENAME"
+echo >> "$LOG_TEST_FILENAME"
+echo "Platforms:" >> "$LOG_TEST_FILENAME"
+
+available_platforms=$(make --silent -C ${TF_ROOT}/rust list_platforms)
+
+# Run cargo doc for all platforms
+for plat in $available_platforms
+do
+ echo >> $LOG_FILE
+ echo "############### ${TEST_CASE} - platform: ${plat}" >> "$LOG_FILE"
+ echo >> $LOG_FILE
+ make -C ${TF_ROOT}/rust PLAT=${plat} cargo-doc >> "$LOG_FILE" 2>&1
+
+ if [ "$?" -ne 0 ]; then
+ echo -e " ${plat}\t: FAIL" >> "$LOG_TEST_FILENAME"
+ EXIT_VALUE=1
+ else
+ echo -e " ${plat}\t: PASS" >> "$LOG_TEST_FILENAME"
+ fi
+done
+
+echo >> "$LOG_TEST_FILENAME"
+if [[ "$EXIT_VALUE" == 0 ]]; then
+ echo "Result : SUCCESS" >> "$LOG_TEST_FILENAME"
+else
+ echo "Result : FAILURE" >> "$LOG_TEST_FILENAME"
+fi
+echo >> "$LOG_TEST_FILENAME"
+cat "$LOG_FILE" >> "$LOG_TEST_FILENAME"
+
+rm "$LOG_FILE"
+
+exit "$EXIT_VALUE"
diff --git a/script/next-checks/next-checks-generic-tests.sh b/script/next-checks/next-checks-generic-tests.sh
index 85c1378..4774291 100755
--- a/script/next-checks/next-checks-generic-tests.sh
+++ b/script/next-checks/next-checks-generic-tests.sh
@@ -77,19 +77,21 @@
# Run cargo doc
-echo "cargo doc --no-deps" >> "$LOG_TEST_FILENAME" 2>&1
+if [ "$REPO_NAME" != "trusted-firmware-a" ]; then
+ echo "cargo doc --no-deps" >> "$LOG_TEST_FILENAME" 2>&1
-RUSTDOCFLAGS="-D warnings" cargo doc --no-deps >> "$LOG_TEST_FILENAME" 2>&1
+ RUSTDOCFLAGS="-D warnings" cargo doc --no-deps >> "$LOG_TEST_FILENAME" 2>&1
-if [ "$?" != 0 ]; then
- echo "cargo doc: FAILURE"
- ((ERROR_COUNT++))
-else
- echo "cargo doc: PASS"
+ if [ "$?" != 0 ]; then
+ echo "cargo doc: FAILURE"
+ ((ERROR_COUNT++))
+ else
+ echo "cargo doc: PASS"
+ fi
+
+ echo "-------------------------------------" >> "$LOG_TEST_FILENAME" 2>&1
fi
-echo "-------------------------------------" >> "$LOG_TEST_FILENAME" 2>&1
-
cd -
if [ "$ERROR_COUNT" != 0 ]; then
echo "Some cargo checks have failed."
diff --git a/script/next-checks/next-checks.sh b/script/next-checks/next-checks.sh
index 633a2f4..56bd41b 100755
--- a/script/next-checks/next-checks.sh
+++ b/script/next-checks/next-checks.sh
@@ -88,6 +88,18 @@
fi
echo
+# Check documentation with cargo doc
+
+"$CI_ROOT"/script/next-checks/next-checks-cargo-doc.sh .
+
+if [ "$?" != 0 ]; then
+ echo "cargo doc test: FAILURE"
+ ((ERROR_COUNT++))
+else
+ echo "cargo doc test: PASS"
+fi
+echo
+
# Check lints with clippy
"$CI_ROOT"/script/next-checks/next-checks-clippy.sh .