applications: nrf5340_audio: Buildprog transport mandatory #20817

gWacey · 2025-03-10T08:45:02Z

OCT-3328

Now forces the -t/--transport option in buildprog as mandatory and documents the change.

NordicBuilder · 2025-03-10T08:48:18Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 14

Inputs:

Sources:

sdk-nrf: PR head: 73a7568b6fa6920725b6eceb8e651084a2d7b341

more details

sdk-nrf:

PR head: 73a7568b6fa6920725b6eceb8e651084a2d7b341
merge base: 52966b0147c678857851ab2a2ab4f3c81e7d150c
target head (main): 50ae83eba24c37fde286a5a601a2875f9e639cc2
Diff

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (9)

applications
│  ├── nrf5340_audio
│  │  ├── CMakeLists.txt
│  │  ├── broadcast_sink
│  │  │  │ overlay-broadcast_sink.conf
│  │  ├── broadcast_source
│  │  │  │ overlay-broadcast_source.conf
│  │  ├── doc
│  │  │  ├── building.rst
│  │  │  │ configuration.rst
│  │  ├── tools
│  │  │  ├── buildprog
│  │  │  │  │ buildprog.py
│  │  ├── unicast_client
│  │  │  │ overlay-unicast_client.conf
│  │  ├── unicast_server
│  │  │  │ overlay-unicast_server.conf
doc
│  ├── nrf
│  │  ├── releases_and_maturity
│  │  │  ├── migration
│  │  │  │  │ migration_guide_3.0.rst

Outputs:

Toolchain

Version: 4ffa2202d5
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:4ffa2202d5_e579f9fbe6

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain - Skipped: existing toolchain is used
✅ Build twister
- sdk-nrf test count: 34
✅ Integration tests
- ✅ test-sdk-audio

Disabled integration tests

- desktop52_verification
- doc-internal
- test-fw-nrfconnect-apps
- test-fw-nrfconnect-ble_mesh
- test-fw-nrfconnect-ble_samples
- test-fw-nrfconnect-boot
- test-fw-nrfconnect-chip
- test-fw-nrfconnect-fem
- test-fw-nrfconnect-nfc
- test-fw-nrfconnect-nrf-iot_cloud
- test-fw-nrfconnect-nrf-iot_libmodem-nrf
- test-fw-nrfconnect-nrf-iot_mosh
- test-fw-nrfconnect-nrf-iot_positioning
- test-fw-nrfconnect-nrf-iot_samples
- test-fw-nrfconnect-nrf-iot_serial_lte_modem
- test-fw-nrfconnect-nrf-iot_thingy91
- test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
- test-fw-nrfconnect-nrf_crypto
- test-fw-nrfconnect-proprietary_esb
- test-fw-nrfconnect-ps
- test-fw-nrfconnect-rpc
- test-fw-nrfconnect-rs
- test-fw-nrfconnect-tfm
- test-fw-nrfconnect-thread
- test-fw-nrfconnect-zigbee
- test-low-level
- test-sdk-dfu
- test-sdk-find-my
- test-sdk-mcuboot
- test-sdk-pmic-samples
- test-sdk-wifi
- test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

greg-fer · 2025-03-10T12:46:26Z

applications/nrf5340_audio/doc/building.rst

+   * - Transport type (``-t``)
+     - Specifies the transpoert type.
+     - ``broadcast``, ``unicast``
+     - :ref:`nrf53_audio_app_overview_broadcast_unicast`


This ref needs to be updated: this one does not exist, and I'm not sure where you want to link to.

greg-fer · 2025-03-10T12:46:32Z

applications/nrf5340_audio/doc/building.rst

@@ -98,6 +98,10 @@ The building command for running the script requires providing the following par
     - ``release``, ``debug``
     - | :ref:`nrf53_audio_app_configuration_files`
       | **Note:** For FOTA DFU, you must use :ref:`nrf53_audio_app_building_standard`.
+   * - Transport type (``-t``)
+     - Specifies the transpoert type.


Suggested change

- Specifies the transpoert type.

- Specifies the transport type.

greg-fer

Previous edits not yet applied. Found one more potential issue.

greg-fer · 2025-03-12T10:06:17Z

applications/nrf5340_audio/doc/configuration.rst

@@ -93,7 +80,7 @@ You can use one of the following options, depending on how you decide to build t

  .. code-block:: console

-     west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek
+     west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -CONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek


-D missing?

Suggested change

west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -CONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek

west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek

koffes

Approved. Just one question in the review.

koffes · 2025-03-18T13:06:33Z

applications/nrf5340_audio/CMakeLists.txt

@@ -12,6 +12,11 @@ add_compile_definitions(GATEWAY=2)

 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})

+# Test a configuration file option has been given
+if(NOT DEFINED EXTRA_CONF_FILE)
+    message(FATAL_ERROR "No configuration file specified, set -DEXTRA_CONF_FILE=<configuration file>")


Should this be:

Suggested change

message(FATAL_ERROR "No configuration file specified, set -DEXTRA_CONF_FILE=<configuration file>")

message(FATAL_ERROR "No configuration file specified, set -- -DEXTRA_CONF_FILE=<configuration file>")

``` ?

greg-fer

One more round of review, hopefully final.

greg-fer · 2025-03-18T14:07:24Z

doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst

+
+.. toggle::
+
+   * The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now requires the transport (-t/--transport) type to be included.


Suggested change

* The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now requires the transport (-t/--transport) type to be included.

* The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now requires the transport (``-t/--transport``) type to be included.

greg-fer · 2025-03-18T14:12:24Z

applications/nrf5340_audio/doc/building.rst

@@ -256,8 +260,10 @@ Complete the following steps to build the application:

   a. Choose the device type by using one of the following options:


Suggested change

a. Choose the device type by using one of the following options:

a. Choose the device type by using one of the following :ref:`CMake options for extra Kconfig fragments <cmake_options>`:

greg-fer · 2025-03-18T14:13:17Z

doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst

+.. toggle::
+
+   * The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now requires the transport (-t/--transport) type to be included.
+   * The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_standard` now requires a configuration overlay compile option to be included.


Suggested change

* The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_standard` now requires a configuration overlay compile option to be included.

* The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_standard` now requires an extra :ref:`CMake option to provide extra Kconfig fragments <cmake_options>` to select the device type.

greg-fer · 2025-03-18T14:13:31Z

doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst

+
+   * The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now requires the transport (-t/--transport) type to be included.
+   * The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_standard` now requires a configuration overlay compile option to be included.
+
 |no_changes_yet_note|


Suggested change

|no_changes_yet_note|

Remove

github-actions · 2025-03-19T11:50:43Z

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-20817/nrf/releases_and_maturity/migration/migration_guide_3.0.html
https://ncsdoc.z6.web.core.windows.net/PR-20817/nrf/applications/nrf5340_audio/doc/building.html
https://ncsdoc.z6.web.core.windows.net/PR-20817/nrf/applications/nrf5340_audio/doc/configuration.html

OCT-3328 Now forces the -t/--transport option in buildprog as mandatory Signed-off-by: Graham Wacey <graham.wacey@nordicsemi.no>

sonarqubecloud · 2025-03-20T12:51:29Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

gWacey requested review from a team as code owners March 10, 2025 08:45

gWacey requested review from koffes, rick1082 and alexsven March 10, 2025 08:45

github-actions bot added doc-required changelog-entry-required labels Mar 10, 2025

greg-fer approved these changes Mar 10, 2025

View reviewed changes

greg-fer requested changes Mar 10, 2025

View reviewed changes

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch from 90af422 to 953db45 Compare March 11, 2025 14:17

gWacey requested review from a team as code owners March 11, 2025 14:17

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch from 953db45 to e671e98 Compare March 11, 2025 14:19

greg-fer requested changes Mar 12, 2025

View reviewed changes

nordicjm approved these changes Mar 13, 2025

View reviewed changes

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch from e671e98 to 18f06a7 Compare March 17, 2025 08:07

koffes requested a review from buran-ci March 18, 2025 13:05

koffes approved these changes Mar 18, 2025

View reviewed changes

alexsven approved these changes Mar 18, 2025

View reviewed changes

greg-fer requested changes Mar 18, 2025

View reviewed changes

greg-fer mentioned this pull request Mar 18, 2025

applications: nrf5340_audio: Buildprog, pristine and flashing issue #20963

Open

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch from 18f06a7 to e6d8636 Compare March 19, 2025 10:27

gWacey requested review from greg-fer and koffes March 19, 2025 10:28

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch 2 times, most recently from eb2d1cd to 87f020d Compare March 19, 2025 11:30

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch 2 times, most recently from 5272b5a to 938ef6e Compare March 19, 2025 13:00

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch from 938ef6e to 60f6a24 Compare March 19, 2025 13:03

greg-fer approved these changes Mar 19, 2025

View reviewed changes

divipillai approved these changes Mar 19, 2025

View reviewed changes

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch 3 times, most recently from de64432 to 371bd5d Compare March 20, 2025 08:44

applications: nrf5340_audio: Buildprog transport mandatory

Loading
Loading status checks…

73a7568

OCT-3328 Now forces the -t/--transport option in buildprog as mandatory Signed-off-by: Graham Wacey <graham.wacey@nordicsemi.no>

gWacey force-pushed the OCT-3328-Buildprog-transport-mandatory branch from 371bd5d to 73a7568 Compare March 20, 2025 12:45

koffes merged commit d3df483 into nrfconnect:main Mar 20, 2025
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

applications: nrf5340_audio: Buildprog transport mandatory #20817

applications: nrf5340_audio: Buildprog transport mandatory #20817

gWacey commented Mar 10, 2025

NordicBuilder commented Mar 10, 2025 •

edited

Loading

greg-fer Mar 10, 2025

greg-fer Mar 10, 2025

greg-fer left a comment

greg-fer Mar 12, 2025

koffes left a comment

koffes Mar 18, 2025

greg-fer left a comment

greg-fer Mar 18, 2025

greg-fer Mar 18, 2025

greg-fer Mar 18, 2025

greg-fer Mar 18, 2025

github-actions bot commented Mar 19, 2025

sonarqubecloud bot commented Mar 20, 2025

	- Specifies the transpoert type.
	- Specifies the transport type.

	west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -CONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek
	west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek

	message(FATAL_ERROR "No configuration file specified, set -DEXTRA_CONF_FILE=<configuration file>")
	message(FATAL_ERROR "No configuration file specified, set -- -DEXTRA_CONF_FILE=<configuration file>")
	``` ?


		.. toggle::

		* The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now requires the transport (-t/--transport) type to be included.

		@@ -256,8 +260,10 @@ Complete the following steps to build the application:

		a. Choose the device type by using one of the following options:

applications: nrf5340_audio: Buildprog transport mandatory #20817

applications: nrf5340_audio: Buildprog transport mandatory #20817

Conversation

gWacey commented Mar 10, 2025

NordicBuilder commented Mar 10, 2025 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-fer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

koffes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-fer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 19, 2025

sonarqubecloud bot commented Mar 20, 2025

Quality Gate passed

NordicBuilder commented Mar 10, 2025 •

edited

Loading