From 9a16b938689e7ec374422ba08da18499575e31ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Wed, 11 Sep 2024 22:26:10 +0200 Subject: [PATCH] samples: hello_world: use zephyr:code-sample directive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds missing code-sample directive to the Hello World sample in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé --- boards/96boards/aerocore2/doc/index.rst | 2 +- boards/96boards/argonkey/doc/index.rst | 2 +- boards/96boards/carbon/doc/stm32f401xe.rst | 2 +- boards/96boards/neonkey/doc/index.rst | 2 +- boards/96boards/nitrogen/doc/index.rst | 4 ++-- boards/96boards/stm32_sensor_mez/doc/index.rst | 6 +++--- boards/96boards/wistrio/doc/96b_wistrio.rst | 2 +- boards/adafruit/feather_m0_basic_proto/doc/index.rst | 2 +- boards/adafruit/feather_m0_lora/doc/index.rst | 2 +- boards/adafruit/grand_central_m4_express/doc/index.rst | 2 +- boards/adafruit/itsybitsy_m4_express/doc/index.rst | 2 +- boards/adafruit/nrf52_adafruit_feather/doc/index.rst | 4 ++-- boards/adafruit/trinket_m0/doc/index.rst | 2 +- boards/adi/eval_adin1110ebz/doc/index.rst | 4 ++-- boards/adi/eval_adin2111ebz/doc/index.rst | 4 ++-- boards/adi/max32690fthr/doc/index.rst | 4 ++-- boards/adi/sdp_k1/doc/index.rst | 2 +- boards/alientek/pandora_stm32l475/doc/index.rst | 4 ++-- boards/altr/max10/doc/index.rst | 2 +- boards/ambiq/apollo3_evb/doc/index.rst | 2 +- boards/ambiq/apollo3p_evb/doc/index.rst | 2 +- boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst | 2 +- boards/ambiq/apollo4p_evb/doc/index.rst | 2 +- boards/andestech/adp_xc7k_ae350/doc/index.rst | 2 +- boards/arduino/due/doc/index.rst | 2 +- boards/arduino/giga_r1/doc/index.rst | 2 +- boards/arduino/mkrzero/doc/index.rst | 2 +- boards/arduino/nano_33_iot/doc/index.rst | 2 +- boards/arduino/nicla_sense_me/doc/index.rst | 4 ++-- boards/arduino/nicla_vision/doc/index.rst | 2 +- boards/arduino/portenta_h7/doc/index.rst | 2 +- boards/arduino/zero/doc/index.rst | 2 +- boards/arm/mps2/doc/mps2_an385.rst | 2 +- boards/arm/mps2/doc/mps2_an521.rst | 2 +- boards/arm/mps3/doc/index.rst | 2 +- boards/arm/v2m_beetle/doc/index.rst | 2 +- boards/arm/v2m_musca_b1/doc/index.rst | 2 +- boards/arm/v2m_musca_s1/doc/index.rst | 4 ++-- boards/atmel/sam/sam4e_xpro/doc/index.rst | 6 +++--- boards/atmel/sam/sam4l_ek/doc/index.rst | 4 ++-- boards/atmel/sam/sam4s_xplained/doc/index.rst | 6 +++--- boards/atmel/sam/sam_e70_xplained/doc/index.rst | 4 ++-- boards/atmel/sam/sam_v71_xult/doc/index.rst | 4 ++-- boards/atmel/sam0/samd20_xpro/doc/index.rst | 2 +- boards/atmel/sam0/samr21_xpro/doc/index.rst | 2 +- boards/bbc/microbit/doc/index.rst | 2 +- boards/bbc/microbit_v2/doc/index.rst | 2 +- boards/blues/swan_r5/doc/index.rst | 2 +- boards/bytesatwork/bytesensi_l/doc/index.rst | 2 +- boards/circuitdojo/feather/doc/index.rst | 2 +- boards/contextualelectronics/abc/doc/index.rst | 2 +- boards/cypress/cy8ckit_062_ble/doc/index.rst | 4 ++-- boards/digilent/arty_a7/doc/index.rst | 4 ++-- boards/digilent/zybo/doc/index.rst | 6 +++--- boards/dragino/lsn50/doc/index.rst | 4 ++-- boards/dragino/nbsn95/doc/index.rst | 4 ++-- boards/electronut/nrf52840_blip/doc/index.rst | 2 +- boards/electronut/nrf52840_papyr/doc/nrf52840_papyr.rst | 2 +- boards/espressif/esp32_devkitc_wroom/doc/index.rst | 6 +++--- boards/espressif/esp32_devkitc_wrover/doc/index.rst | 6 +++--- boards/espressif/esp32_ethernet_kit/doc/index.rst | 6 +++--- boards/espressif/esp32c3_devkitc/doc/index.rst | 6 +++--- boards/espressif/esp32c3_devkitm/doc/index.rst | 6 +++--- boards/espressif/esp32c3_rust/doc/index.rst | 6 +++--- boards/espressif/esp32c6_devkitc/doc/index.rst | 6 +++--- boards/espressif/esp32s2_devkitc/doc/index.rst | 6 +++--- boards/espressif/esp32s2_saola/doc/index.rst | 6 +++--- boards/espressif/esp32s3_devkitc/doc/index.rst | 6 +++--- boards/espressif/esp32s3_devkitm/doc/index.rst | 6 +++--- boards/espressif/esp8684_devkitm/doc/index.rst | 6 +++--- boards/espressif/esp_wrover_kit/doc/index.rst | 6 +++--- boards/ezurio/bl5340_dvk/doc/index.rst | 2 +- boards/ezurio/bl652_dvk/doc/bl652_dvk.rst | 2 +- boards/ezurio/bl653_dvk/doc/bl653_dvk.rst | 2 +- boards/ezurio/bl654_dvk/doc/bl654_dvk.rst | 2 +- .../ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst | 2 +- boards/ezurio/bt510/doc/bt510.rst | 2 +- boards/ezurio/bt610/doc/bt610.rst | 2 +- boards/ezurio/mg100/doc/index.rst | 2 +- boards/ezurio/pinnacle_100_dvk/doc/index.rst | 2 +- boards/ezurio/rm1xx_dvk/doc/index.rst | 2 +- boards/fanke/fk7b0m1_vbt6/doc/index.rst | 2 +- boards/franzininho/esp32s2_franzininho/doc/index.rst | 2 +- boards/gd/gd32a503v_eval/doc/index.rst | 4 ++-- boards/gd/gd32e103v_eval/doc/index.rst | 4 ++-- boards/gd/gd32e507v_start/doc/index.rst | 2 +- boards/gd/gd32e507z_eval/doc/index.rst | 2 +- boards/gd/gd32f350r_eval/doc/index.rst | 2 +- boards/gd/gd32f403z_eval/doc/index.rst | 4 ++-- boards/gd/gd32f407v_start/doc/index.rst | 2 +- boards/gd/gd32f450i_eval/doc/index.rst | 2 +- boards/gd/gd32f450v_start/doc/index.rst | 2 +- boards/gd/gd32f450z_eval/doc/index.rst | 2 +- boards/gd/gd32f470i_eval/doc/index.rst | 2 +- boards/gd/gd32l233r_eval/doc/index.rst | 2 +- boards/gd/gd32vf103c_starter/doc/index.rst | 2 +- boards/gd/gd32vf103v_eval/doc/index.rst | 2 +- boards/hardkernel/odroid_go/doc/index.rst | 6 +++--- boards/heltec/heltec_wifi_lora32_v2/doc/index.rst | 6 +++--- boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst | 6 +++--- boards/infineon/xmc45_relax_kit/doc/index.rst | 4 ++-- boards/infineon/xmc47_relax_kit/doc/index.rst | 4 ++-- boards/innblue/innblue21/doc/index.rst | 2 +- boards/innblue/innblue22/doc/index.rst | 2 +- boards/intel/socfpga_std/cyclonev_socdk/doc/index.rst | 2 +- boards/ite/it82xx2_evb/doc/index.rst | 2 +- boards/ite/it8xxx2_evb/doc/index.rst | 2 +- boards/khadas/edgev/doc/index.rst | 2 +- boards/kincony/kincony_kc868_a32/doc/index.rst | 2 +- boards/lilygo/ttgo_lora32/doc/index.rst | 2 +- boards/lilygo/ttgo_t8c3/doc/index.rst | 2 +- boards/lowrisc/opentitan_earlgrey/doc/index.rst | 2 +- boards/luatos/esp32c3_luatos_core/doc/index.rst | 6 +++--- boards/luatos/esp32s3_luatos_core/doc/index.rst | 6 +++--- boards/m5stack/m5stack_atom_lite/doc/index.rst | 2 +- boards/m5stack/m5stack_atoms3/doc/index.rst | 2 +- boards/m5stack/m5stack_atoms3_lite/doc/index.rst | 2 +- boards/m5stack/m5stack_core2/doc/index.rst | 2 +- boards/m5stack/m5stack_stamps3/doc/index.rst | 2 +- boards/m5stack/m5stickc_plus/doc/index.rst | 2 +- boards/m5stack/stamp_c3/doc/index.rst | 6 +++--- boards/madmachine/mm_feather/doc/index.rst | 4 ++-- boards/madmachine/mm_swiftio/doc/index.rst | 2 +- boards/microchip/mec1501modular_assy6885/doc/index.rst | 2 +- boards/microchip/mec15xxevb_assy6853/doc/index.rst | 2 +- boards/microchip/mec172xevb_assy6906/doc/index.rst | 2 +- .../doc/mec172xmodular_assy6930.rst | 2 +- boards/mikroe/clicker_2/doc/mikroe_clicker_2.rst | 4 ++-- .../mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst | 4 ++-- boards/mxchip/az3166_iotdevkit/doc/index.rst | 2 +- boards/nordic/nrf21540dk/doc/index.rst | 2 +- boards/nordic/nrf51dk/doc/index.rst | 2 +- boards/nordic/nrf51dongle/doc/index.rst | 2 +- boards/nordic/nrf52833dk/doc/index.rst | 2 +- boards/nordic/nrf52840dk/doc/index.rst | 2 +- boards/nordic/nrf52dk/doc/index.rst | 2 +- boards/nordic/nrf5340dk/doc/index.rst | 2 +- boards/nordic/nrf54h20dk/doc/index.rst | 2 +- boards/nordic/nrf54l15dk/doc/index.rst | 2 +- boards/nordic/nrf54l15pdk/doc/index.rst | 2 +- boards/nordic/nrf54l20pdk/doc/index.rst | 2 +- boards/nordic/nrf7002dk/doc/index.rst | 2 +- boards/nordic/nrf9131ek/doc/index.rst | 2 +- boards/nordic/nrf9151dk/doc/index.rst | 2 +- boards/nordic/nrf9160dk/doc/index.rst | 4 ++-- boards/nordic/nrf9161dk/doc/index.rst | 2 +- boards/nordic/nrf9280pdk/doc/index.rst | 2 +- boards/nuvoton/npcm400_evb/doc/index.rst | 2 +- boards/nuvoton/numaker_m2l31ki/doc/index.rst | 4 ++-- boards/nuvoton/numaker_pfm_m467/doc/index.rst | 4 ++-- boards/nuvoton/numaker_pfm_m487/doc/index.rst | 4 ++-- boards/nxp/frdm_k22f/doc/index.rst | 4 ++-- boards/nxp/frdm_k64f/doc/index.rst | 4 ++-- boards/nxp/frdm_k82f/doc/index.rst | 4 ++-- boards/nxp/frdm_ke15z/doc/index.rst | 4 ++-- boards/nxp/frdm_ke17z/doc/index.rst | 4 ++-- boards/nxp/frdm_ke17z512/doc/index.rst | 4 ++-- boards/nxp/frdm_kl25z/doc/index.rst | 4 ++-- boards/nxp/frdm_kw41z/doc/index.rst | 4 ++-- boards/nxp/frdm_mcxa156/doc/index.rst | 4 ++-- boards/nxp/frdm_mcxc242/doc/index.rst | 4 ++-- boards/nxp/frdm_mcxn236/doc/index.rst | 4 ++-- boards/nxp/frdm_mcxn947/doc/index.rst | 6 +++--- boards/nxp/frdm_rw612/doc/index.rst | 4 ++-- boards/nxp/hexiwear/doc/index.rst | 8 ++++---- boards/nxp/imx8mm_evk/doc/index.rst | 2 +- boards/nxp/imx8mp_evk/doc/index.rst | 2 +- boards/nxp/imx8mq_evk/doc/index.rst | 2 +- boards/nxp/imx95_evk/doc/index.rst | 2 +- boards/nxp/lpcxpresso51u68/doc/index.rst | 4 ++-- boards/nxp/lpcxpresso54114/doc/index.rst | 4 ++-- boards/nxp/lpcxpresso55s06/doc/index.rst | 4 ++-- boards/nxp/lpcxpresso55s16/doc/index.rst | 4 ++-- boards/nxp/lpcxpresso55s28/doc/index.rst | 4 ++-- boards/nxp/lpcxpresso55s36/doc/index.rst | 4 ++-- boards/nxp/lpcxpresso55s69/doc/index.rst | 4 ++-- boards/nxp/mimxrt1010_evk/doc/index.rst | 2 +- boards/nxp/mimxrt1015_evk/doc/index.rst | 2 +- boards/nxp/mimxrt1020_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1024_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1040_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1050_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1060_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1062_fmurt6/doc/index.rst | 4 ++-- boards/nxp/mimxrt1064_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1160_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1170_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt1180_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt595_evk/doc/index.rst | 4 ++-- boards/nxp/mimxrt685_evk/doc/index.rst | 4 ++-- boards/nxp/rd_rw612_bga/doc/index.rst | 4 ++-- boards/nxp/rddrone_fmuk66/doc/index.rst | 4 ++-- boards/nxp/s32z2xxdc2/doc/index.rst | 4 ++-- boards/nxp/twr_ke18f/doc/index.rst | 4 ++-- boards/nxp/twr_kv58f220m/doc/index.rst | 4 ++-- boards/nxp/usb_kw24d512/doc/index.rst | 4 ++-- boards/nxp/vmu_rt1170/doc/index.rst | 4 ++-- boards/olimex/olimex_esp32_evb/doc/index.rst | 6 +++--- boards/olimex/stm32_e407/doc/index.rst | 4 ++-- boards/olimex/stm32_h103/doc/index.rst | 2 +- boards/olimex/stm32_h405/doc/index.rst | 4 ++-- boards/olimex/stm32_h407/doc/index.rst | 4 ++-- boards/olimex/stm32_p405/doc/index.rst | 4 ++-- boards/openisa/rv32m1_vega/doc/index.rst | 2 +- boards/others/black_f407ve/doc/index.rst | 2 +- boards/others/black_f407zg_pro/doc/index.rst | 2 +- boards/others/icev_wireless/doc/index.rst | 4 ++-- boards/others/neorv32/doc/index.rst | 4 ++-- boards/others/stm32_min_dev/doc/index.rst | 2 +- boards/particle/argon/doc/index.rst | 2 +- boards/particle/boron/doc/index.rst | 2 +- boards/particle/nrf51_blenano/doc/index.rst | 4 ++-- boards/particle/nrf52_blenano2/doc/index.rst | 4 ++-- boards/particle/xenon/doc/index.rst | 2 +- boards/phytec/mimx8mp_phyboard_pollux/doc/index.rst | 2 +- boards/phytec/phyboard_electra/doc/index.rst | 2 +- .../phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_a53.rst | 2 +- .../phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_m4.rst | 2 +- boards/phytec/reel_board/doc/index.rst | 4 ++-- boards/qorvo/decawave_dwm1001_dev/doc/index.rst | 2 +- boards/rak/rak11720/doc/index.rst | 2 +- boards/rak/rak4631/doc/index.rst | 4 ++-- boards/rak/rak5010/doc/index.rst | 4 ++-- boards/raspberrypi/rpi_5/doc/index.rst | 2 +- boards/raytac/mdbt50q_db_33/doc/index.rst | 2 +- boards/raytac/mdbt50q_db_40/doc/index.rst | 2 +- boards/raytac/mdbt53_db_40/doc/index.rst | 2 +- boards/raytac/mdbt53v_db_40/doc/index.rst | 2 +- boards/renesas/rcar_h3ulcb/doc/rcar_h3ulcb_r7.rst | 2 +- boards/renesas/rcar_salvator_x/doc/rcar_salvator_x.rst | 2 +- boards/renesas/rcar_spider_s4/doc/rcar_spider_a55.rst | 2 +- boards/renesas/rcar_spider_s4/doc/rcar_spider_r52.rst | 2 +- boards/sc/scobc_module1/doc/index.rst | 4 ++-- boards/seco/stm32f3_seco_d23/doc/index.rst | 2 +- boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst | 2 +- boards/seeed/lora_e5_mini/doc/index.rst | 2 +- boards/seeed/seeeduino_xiao/doc/index.rst | 2 +- boards/seeed/xiao_ble/doc/index.rst | 2 +- boards/seeed/xiao_esp32c3/doc/index.rst | 4 ++-- boards/seeed/xiao_esp32s3/doc/index.rst | 6 +++--- boards/silabs/dev_kits/sim3u1xx_dk/doc/index.rst | 2 +- boards/silabs/dev_kits/sltb004a/doc/index.rst | 2 +- boards/silabs/dev_kits/sltb009a/doc/index.rst | 2 +- boards/silabs/dev_kits/sltb010a/doc/index.rst | 2 +- boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst | 2 +- boards/silabs/dev_kits/xg27_dk2602a/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4104a/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4161a/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4170a/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4180a/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4250b/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4255a/doc/index.rst | 2 +- boards/silabs/radio_boards/slwrb4321a/doc/index.rst | 2 +- boards/silabs/radio_boards/xg24_rb4187c/doc/index.rst | 2 +- boards/silabs/starter_kits/efm32wg_stk3800/doc/index.rst | 2 +- boards/silabs/starter_kits/slstk3400a/doc/index.rst | 2 +- boards/silabs/starter_kits/slstk3401a/doc/index.rst | 2 +- boards/silabs/starter_kits/slstk3402a/doc/index.rst | 2 +- boards/silabs/starter_kits/slstk3701a/doc/index.rst | 2 +- boards/snps/em_starterkit/doc/index.rst | 4 ++-- boards/snps/emsdp/doc/index.rst | 4 ++-- boards/snps/hsdk/doc/index.rst | 4 ++-- boards/snps/hsdk4xd/doc/index.rst | 4 ++-- boards/snps/iotdk/doc/index.rst | 4 ++-- boards/sparkfun/micromod/doc/index.rst | 2 +- boards/sparkfun/thing_plus/doc/index.rst | 4 ++-- boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst | 2 +- boards/st/b_g474e_dpow1/doc/index.rst | 2 +- boards/st/b_l072z_lrwan1/doc/index.rst | 4 ++-- boards/st/b_l4s5i_iot01a/doc/index.rst | 4 ++-- boards/st/b_u585i_iot02a/doc/index.rst | 2 +- boards/st/disco_l475_iot1/doc/index.rst | 4 ++-- boards/st/nucleo_f070rb/doc/index.rst | 2 +- boards/st/nucleo_f091rc/doc/index.rst | 2 +- boards/st/nucleo_f401re/doc/index.rst | 4 ++-- boards/st/nucleo_f410rb/doc/index.rst | 4 ++-- boards/st/nucleo_f411re/doc/index.rst | 4 ++-- boards/st/nucleo_f446re/doc/index.rst | 4 ++-- boards/st/nucleo_f446ze/doc/index.rst | 4 ++-- boards/st/nucleo_f722ze/doc/index.rst | 2 +- boards/st/nucleo_f746zg/doc/index.rst | 4 ++-- boards/st/nucleo_f756zg/doc/index.rst | 4 ++-- boards/st/nucleo_f767zi/doc/index.rst | 4 ++-- boards/st/nucleo_g031k8/doc/index.rst | 2 +- boards/st/nucleo_g070rb/doc/index.rst | 2 +- boards/st/nucleo_g071rb/doc/index.rst | 2 +- boards/st/nucleo_g0b1re/doc/index.rst | 2 +- boards/st/nucleo_g431rb/doc/index.rst | 4 ++-- boards/st/nucleo_g474re/doc/index.rst | 4 ++-- boards/st/nucleo_h503rb/doc/index.rst | 2 +- boards/st/nucleo_h533re/doc/index.rst | 2 +- boards/st/nucleo_h563zi/doc/index.rst | 2 +- boards/st/nucleo_h723zg/doc/index.rst | 4 ++-- boards/st/nucleo_h743zi/doc/index.rst | 4 ++-- boards/st/nucleo_h745zi_q/doc/index.rst | 4 ++-- boards/st/nucleo_h753zi/doc/index.rst | 4 ++-- boards/st/nucleo_h755zi_q/doc/index.rst | 4 ++-- boards/st/nucleo_h7a3zi_q/doc/index.rst | 4 ++-- boards/st/nucleo_l011k4/doc/index.rst | 2 +- boards/st/nucleo_l031k6/doc/index.rst | 2 +- boards/st/nucleo_l053r8/doc/index.rst | 2 +- boards/st/nucleo_l073rz/doc/index.rst | 2 +- boards/st/nucleo_l152re/doc/index.rst | 2 +- boards/st/nucleo_l412rb_p/doc/index.rst | 4 ++-- boards/st/nucleo_l432kc/doc/index.rst | 4 ++-- boards/st/nucleo_l433rc_p/doc/index.rst | 4 ++-- boards/st/nucleo_l452re/doc/index.rst | 4 ++-- boards/st/nucleo_l476rg/doc/index.rst | 4 ++-- boards/st/nucleo_l496zg/doc/index.rst | 4 ++-- boards/st/nucleo_l4a6zg/doc/index.rst | 4 ++-- boards/st/nucleo_l4r5zi/doc/index.rst | 2 +- boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst | 4 ++-- boards/st/nucleo_u031r8/doc/index.rst | 2 +- boards/st/nucleo_u083rc/doc/index.rst | 2 +- boards/st/nucleo_u575zi_q/doc/index.rst | 2 +- boards/st/nucleo_u5a5zj_q/doc/index.rst | 2 +- boards/st/nucleo_wb05kz/doc/index.rst | 4 ++-- boards/st/nucleo_wb09ke/doc/index.rst | 4 ++-- boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst | 2 +- boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst | 2 +- boards/st/st25dv_mb1283_disco/docs/index.rst | 4 ++-- boards/st/steval_fcu001v1/doc/index.rst | 4 ++-- boards/st/stm3210c_eval/doc/index.rst | 2 +- boards/st/stm32c0116_dk/doc/index.rst | 2 +- boards/st/stm32f072b_disco/doc/index.rst | 4 ++-- boards/st/stm32f3_disco/doc/index.rst | 4 ++-- boards/st/stm32f412g_disco/doc/index.rst | 4 ++-- boards/st/stm32f429i_disc1/doc/index.rst | 4 ++-- boards/st/stm32f469i_disco/doc/index.rst | 4 ++-- boards/st/stm32f4_disco/doc/index.rst | 2 +- boards/st/stm32f723e_disco/doc/index.rst | 4 ++-- boards/st/stm32f746g_disco/doc/index.rst | 4 ++-- boards/st/stm32f7508_dk/doc/index.rst | 4 ++-- boards/st/stm32f769i_disco/doc/index.rst | 4 ++-- boards/st/stm32g0316_disco/doc/index.rst | 2 +- boards/st/stm32g071b_disco/doc/index.rst | 2 +- boards/st/stm32g081b_eval/doc/index.rst | 2 +- boards/st/stm32h573i_dk/doc/index.rst | 4 ++-- boards/st/stm32h735g_disco/doc/index.rst | 2 +- boards/st/stm32h745i_disco/doc/index.rst | 4 ++-- boards/st/stm32h747i_disco/doc/index.rst | 4 ++-- boards/st/stm32h750b_dk/doc/index.rst | 4 ++-- boards/st/stm32h7b3i_dk/doc/index.rst | 4 ++-- boards/st/stm32h7s78_dk/doc/index.rst | 4 ++-- boards/st/stm32l476g_disco/doc/index.rst | 4 ++-- boards/st/stm32l496g_disco/doc/index.rst | 4 ++-- boards/st/stm32l4r9i_disco/doc/index.rst | 4 ++-- boards/st/stm32l562e_dk/doc/index.rst | 4 ++-- boards/st/stm32u083c_dk/doc/index.rst | 2 +- boards/st/stm32u5a9j_dk/doc/index.rst | 2 +- boards/tdk/robokit1/doc/index.rst | 4 ++-- boards/ti/cc1352p1_launchxl/doc/index.rst | 4 ++-- boards/ti/cc1352p7_launchpad/doc/index.rst | 4 ++-- boards/ti/cc1352r1_launchxl/doc/index.rst | 4 ++-- boards/ti/cc1352r_sensortag/doc/index.rst | 4 ++-- boards/ti/cc26x2r1_launchxl/doc/index.rst | 4 ++-- boards/ti/msp_exp432p401r_launchxl/doc/index.rst | 2 +- boards/ti/sk_am62/doc/index.rst | 2 +- boards/toradex/verdin_imx8mp/doc/index.rst | 2 +- boards/u-blox/ubx_bmd300eval/doc/index.rst | 2 +- boards/u-blox/ubx_bmd330eval/doc/index.rst | 2 +- boards/u-blox/ubx_bmd340eval/doc/index.rst | 2 +- boards/u-blox/ubx_bmd345eval/doc/index.rst | 2 +- boards/u-blox/ubx_bmd360eval/doc/index.rst | 2 +- boards/u-blox/ubx_bmd380eval/doc/index.rst | 2 +- boards/u-blox/ubx_evkannab1/doc/index.rst | 2 +- boards/u-blox/ubx_evkninab1/doc/index.rst | 2 +- boards/u-blox/ubx_evkninab3/doc/index.rst | 2 +- boards/u-blox/ubx_evkninab4/doc/index.rst | 2 +- boards/vcc-gnd/yd_esp32/doc/index.rst | 6 +++--- boards/vcc-gnd/yd_stm32h750vb/doc/index.rst | 2 +- boards/vngiotlab/nrf51_vbluno51/doc/index.rst | 2 +- boards/vngiotlab/nrf52_vbluno52/doc/index.rst | 4 ++-- boards/waveshare/nrf51_ble400/doc/index.rst | 2 +- boards/waveshare/open103z/doc/index.rst | 4 ++-- boards/we/ophelia1ev/doc/index.rst | 2 +- boards/we/proteus2ev/doc/index.rst | 2 +- boards/we/proteus3ev/doc/index.rst | 2 +- boards/weact/mini_stm32h743/doc/index.rst | 2 +- boards/wemos/esp32s2_lolin_mini/doc/index.rst | 2 +- boards/witte/linum/doc/index.rst | 4 ++-- doc/build/dts/howtos.rst | 4 ++-- doc/build/dts/troubleshooting.rst | 4 ++-- doc/build/sysbuild/index.rst | 2 +- doc/develop/application/index.rst | 2 +- doc/develop/beyond-GSG.rst | 2 +- doc/develop/getting_started/index.rst | 2 +- doc/develop/west/build-flash-debug.rst | 6 +++--- doc/develop/west/sign.rst | 2 +- doc/hardware/peripherals/can/shell.rst | 2 +- doc/hardware/peripherals/eeprom/shell.rst | 2 +- samples/hello_world/README.rst | 5 ++++- samples/subsys/usb/dfu/README.rst | 2 +- 393 files changed, 600 insertions(+), 597 deletions(-) diff --git a/boards/96boards/aerocore2/doc/index.rst b/boards/96boards/aerocore2/doc/index.rst index ca12b694950..489433e09f3 100644 --- a/boards/96boards/aerocore2/doc/index.rst +++ b/boards/96boards/aerocore2/doc/index.rst @@ -311,7 +311,7 @@ You should see following confirmation on your Linux host: usb 1-2.1: SerialNumber: 3574364C3034 Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/96boards/argonkey/doc/index.rst b/boards/96boards/argonkey/doc/index.rst index 810ab2e5781..f5cc913f390 100644 --- a/boards/96boards/argonkey/doc/index.rst +++ b/boards/96boards/argonkey/doc/index.rst @@ -145,7 +145,7 @@ Programming and Debugging Building ======== -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/96boards/carbon/doc/stm32f401xe.rst b/boards/96boards/carbon/doc/stm32f401xe.rst index 8f0d38c8dc9..c493c0a7fd6 100644 --- a/boards/96boards/carbon/doc/stm32f401xe.rst +++ b/boards/96boards/carbon/doc/stm32f401xe.rst @@ -299,7 +299,7 @@ You should see following confirmation on your Linux host: usb 1-2.1: SerialNumber: 3574364C3034 Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/96boards/neonkey/doc/index.rst b/boards/96boards/neonkey/doc/index.rst index 96308784941..df9fb1619c1 100644 --- a/boards/96boards/neonkey/doc/index.rst +++ b/boards/96boards/neonkey/doc/index.rst @@ -135,7 +135,7 @@ Programming and Debugging Building ======== -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/96boards/nitrogen/doc/index.rst b/boards/96boards/nitrogen/doc/index.rst index 952f11237bf..df3d0236ca5 100644 --- a/boards/96boards/nitrogen/doc/index.rst +++ b/boards/96boards/nitrogen/doc/index.rst @@ -273,7 +273,7 @@ and install a more recent version of pyOCD. Flashing an Application to 96Boards Nitrogen ============================================ -Here is an example for the :ref:`hello_world` application. This +Here is an example for the :zephyr:code-sample:`hello_world` application. This requires installing the :ref:`pyocd-debug-host-tools`. .. zephyr-app-commands:: @@ -302,7 +302,7 @@ Debugging with GDB ================== You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. This also requires pyOCD. +:zephyr:code-sample:`hello_world` application. This also requires pyOCD. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/96boards/stm32_sensor_mez/doc/index.rst b/boards/96boards/stm32_sensor_mez/doc/index.rst index 350d4720a80..1539a8148a1 100644 --- a/boards/96boards/stm32_sensor_mez/doc/index.rst +++ b/boards/96boards/stm32_sensor_mez/doc/index.rst @@ -181,7 +181,7 @@ Programming and Debugging Building ======== -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -198,7 +198,7 @@ included in the Zephyr SDK. Flashing an application to 96Boards STM32 Sensor Mezzanine ---------------------------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your 96Boards STM32 Sensor Mezzanine board. @@ -224,7 +224,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/96boards/wistrio/doc/96b_wistrio.rst b/boards/96boards/wistrio/doc/96b_wistrio.rst index 14f93e6bae1..8db31fcf6cb 100644 --- a/boards/96boards/wistrio/doc/96b_wistrio.rst +++ b/boards/96boards/wistrio/doc/96b_wistrio.rst @@ -148,7 +148,7 @@ More detailed information on activating the ROM bootloader can be found in Chapter 29 of Application note `AN2606`_. The ROM bootloader supports flashing via UART, and I2C protocols. -Here is an example for building and flashing the :ref:`hello_world` application using `stm32flash`_ command line utility: +Here is an example for building and flashing the :zephyr:code-sample:`hello_world` application using `stm32flash`_ command line utility: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adafruit/feather_m0_basic_proto/doc/index.rst b/boards/adafruit/feather_m0_basic_proto/doc/index.rst index a9dc7f0c229..04206783b15 100644 --- a/boards/adafruit/feather_m0_basic_proto/doc/index.rst +++ b/boards/adafruit/feather_m0_basic_proto/doc/index.rst @@ -110,7 +110,7 @@ the reset button twice. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adafruit/feather_m0_lora/doc/index.rst b/boards/adafruit/feather_m0_lora/doc/index.rst index 3303c6e480c..b75f73d6fdc 100644 --- a/boards/adafruit/feather_m0_lora/doc/index.rst +++ b/boards/adafruit/feather_m0_lora/doc/index.rst @@ -119,7 +119,7 @@ the reset button twice. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adafruit/grand_central_m4_express/doc/index.rst b/boards/adafruit/grand_central_m4_express/doc/index.rst index ec8ab08afdf..e9cf733843a 100644 --- a/boards/adafruit/grand_central_m4_express/doc/index.rst +++ b/boards/adafruit/grand_central_m4_express/doc/index.rst @@ -111,7 +111,7 @@ The bootloader can be entered by quickly tapping the reset button twice. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adafruit/itsybitsy_m4_express/doc/index.rst b/boards/adafruit/itsybitsy_m4_express/doc/index.rst index a25df0bf2fa..ce3efb89b1f 100644 --- a/boards/adafruit/itsybitsy_m4_express/doc/index.rst +++ b/boards/adafruit/itsybitsy_m4_express/doc/index.rst @@ -122,7 +122,7 @@ will be entered automatically when you run :code:`west flash`. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adafruit/nrf52_adafruit_feather/doc/index.rst b/boards/adafruit/nrf52_adafruit_feather/doc/index.rst index 0e7680e70b8..1fff89aaeab 100644 --- a/boards/adafruit/nrf52_adafruit_feather/doc/index.rst +++ b/boards/adafruit/nrf52_adafruit_feather/doc/index.rst @@ -118,10 +118,10 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adafruit/trinket_m0/doc/index.rst b/boards/adafruit/trinket_m0/doc/index.rst index 4e23822b242..e02b829d7a0 100644 --- a/boards/adafruit/trinket_m0/doc/index.rst +++ b/boards/adafruit/trinket_m0/doc/index.rst @@ -114,7 +114,7 @@ will be entered automatically when you run :code:`west flash`. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adi/eval_adin1110ebz/doc/index.rst b/boards/adi/eval_adin1110ebz/doc/index.rst index 92b70f0c1c0..f39a04b7362 100644 --- a/boards/adi/eval_adin1110ebz/doc/index.rst +++ b/boards/adi/eval_adin1110ebz/doc/index.rst @@ -145,7 +145,7 @@ program to connect with your ADI board. For example: $ minicom -D /dev/serial/by-id/usb-ADI_EVAL-ADIN1110EBZ_AVAS_XXXXXX-if00-port0 where XXXXXX is the serial number of the connected device. -Then, build and flash in the usual way. Here is an example for the :ref:`hello_world` application. +Then, build and flash in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -161,7 +161,7 @@ You should see the following message on the console: Debugging ========= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/adi/eval_adin2111ebz/doc/index.rst b/boards/adi/eval_adin2111ebz/doc/index.rst index c88e6d520ed..ea0ce92be2a 100644 --- a/boards/adi/eval_adin2111ebz/doc/index.rst +++ b/boards/adi/eval_adin2111ebz/doc/index.rst @@ -146,7 +146,7 @@ program to connect with your ADI board. For example: $ minicom -D /dev/serial/by-id/usb-ADI_EVAL-ADIN2111EBZ_XXXXXX-12-if00-port0 where XXXXXX is the serial number of the connected device. -Then, build and flash in the usual way. Here is an example for the :ref:`hello_world` application. +Then, build and flash in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -162,7 +162,7 @@ You should see the following message on the console: Debugging ========= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/adi/max32690fthr/doc/index.rst b/boards/adi/max32690fthr/doc/index.rst index 714adb82dc4..edb480f3898 100644 --- a/boards/adi/max32690fthr/doc/index.rst +++ b/boards/adi/max32690fthr/doc/index.rst @@ -98,7 +98,7 @@ Logic levels are fixed to VDDIO (1.8V). Once the debug probe is connected to your host computer, then you can run the ``west flash`` command to write a firmware image into flash. Here is an example -for the :ref:`hello_world` application. +for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -118,7 +118,7 @@ Debugging Once the debug probe is connected to your host computer, then you can run the ``west debug`` command to write a firmware image into flash and start a debug -session. Here is an example for the :ref:`hello_world` application. +session. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/adi/sdp_k1/doc/index.rst b/boards/adi/sdp_k1/doc/index.rst index 1f6f918e0a6..0b23797da6b 100644 --- a/boards/adi/sdp_k1/doc/index.rst +++ b/boards/adi/sdp_k1/doc/index.rst @@ -151,7 +151,7 @@ Run a serial host program to connect with your board: $ minicom -D /dev/serial/by-id/usb-ARM_DAPLink_CMSIS-DAP_<...> -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/alientek/pandora_stm32l475/doc/index.rst b/boards/alientek/pandora_stm32l475/doc/index.rst index cee292e1e56..082c814914a 100644 --- a/boards/alientek/pandora_stm32l475/doc/index.rst +++ b/boards/alientek/pandora_stm32l475/doc/index.rst @@ -182,7 +182,7 @@ board. For example: $ minicom -D /dev/ttyACM0 Then, build and flash in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -199,7 +199,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/altr/max10/doc/index.rst b/boards/altr/max10/doc/index.rst index 6a35d05b009..0ff861b4f83 100644 --- a/boards/altr/max10/doc/index.rst +++ b/boards/altr/max10/doc/index.rst @@ -147,7 +147,7 @@ Flashing Kernel into UFM ------------------------ The usual ``flash`` target will work with the ``altera_max10`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/ambiq/apollo3_evb/doc/index.rst b/boards/ambiq/apollo3_evb/doc/index.rst index 1982236becf..570e1d54d45 100644 --- a/boards/ambiq/apollo3_evb/doc/index.rst +++ b/boards/ambiq/apollo3_evb/doc/index.rst @@ -60,7 +60,7 @@ Flashing an application ----------------------- Connect your device to your host computer using the JLINK USB port. -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application, then flash it to the device: .. zephyr-app-commands:: diff --git a/boards/ambiq/apollo3p_evb/doc/index.rst b/boards/ambiq/apollo3p_evb/doc/index.rst index 58b354288d2..c06f3b1e168 100644 --- a/boards/ambiq/apollo3p_evb/doc/index.rst +++ b/boards/ambiq/apollo3p_evb/doc/index.rst @@ -60,7 +60,7 @@ Flashing an application ----------------------- Connect your device to your host computer using the JLINK USB port. -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application, then flash it to the device: .. zephyr-app-commands:: diff --git a/boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst b/boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst index 33a68ce8875..3a1876297d2 100644 --- a/boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst +++ b/boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst @@ -68,7 +68,7 @@ Flashing an application ----------------------- Connect your device to your host computer using the JLINK USB port. -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application, then flash it to the device: .. zephyr-app-commands:: diff --git a/boards/ambiq/apollo4p_evb/doc/index.rst b/boards/ambiq/apollo4p_evb/doc/index.rst index 662b6c41515..fef698b0a1b 100644 --- a/boards/ambiq/apollo4p_evb/doc/index.rst +++ b/boards/ambiq/apollo4p_evb/doc/index.rst @@ -63,7 +63,7 @@ Flashing an application ----------------------- Connect your device to your host computer using the JLINK USB port. -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application, then flash it to the device: .. zephyr-app-commands:: diff --git a/boards/andestech/adp_xc7k_ae350/doc/index.rst b/boards/andestech/adp_xc7k_ae350/doc/index.rst index ee7dc40d355..3e290dd2f28 100644 --- a/boards/andestech/adp_xc7k_ae350/doc/index.rst +++ b/boards/andestech/adp_xc7k_ae350/doc/index.rst @@ -226,7 +226,7 @@ Building ======== You can build applications in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/due/doc/index.rst b/boards/arduino/due/doc/index.rst index 5d984027534..dfc6e007801 100644 --- a/boards/arduino/due/doc/index.rst +++ b/boards/arduino/due/doc/index.rst @@ -175,7 +175,7 @@ Applications for the ``arduino_due`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. After +Here is an example for the :zephyr:code-sample:`hello_world` application. After building the application, press the Reset button before running the flash command, so the board will boot into the SAM-BA bootloader and be prepared to receive the new program. diff --git a/boards/arduino/giga_r1/doc/index.rst b/boards/arduino/giga_r1/doc/index.rst index 0e95653edfa..696844a71fa 100644 --- a/boards/arduino/giga_r1/doc/index.rst +++ b/boards/arduino/giga_r1/doc/index.rst @@ -130,7 +130,7 @@ First, connect the Arduino GIGA R1 board to your host computer using the USB port to prepare it for flashing. Double click the ``RST`` button to put the board into the Arduino Bootloader mode. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/mkrzero/doc/index.rst b/boards/arduino/mkrzero/doc/index.rst index b6fe37ddd16..2ea120d9313 100644 --- a/boards/arduino/mkrzero/doc/index.rst +++ b/boards/arduino/mkrzero/doc/index.rst @@ -130,7 +130,7 @@ bootloader can be entered by quickly tapping the reset button twice. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/nano_33_iot/doc/index.rst b/boards/arduino/nano_33_iot/doc/index.rst index 5b87fb52c18..e6a51198b92 100644 --- a/boards/arduino/nano_33_iot/doc/index.rst +++ b/boards/arduino/nano_33_iot/doc/index.rst @@ -118,7 +118,7 @@ will be entered automatically when you run :code:`west flash`. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/nicla_sense_me/doc/index.rst b/boards/arduino/nicla_sense_me/doc/index.rst index 6a6eb3a0d1b..1bf984f23f4 100644 --- a/boards/arduino/nicla_sense_me/doc/index.rst +++ b/boards/arduino/nicla_sense_me/doc/index.rst @@ -95,7 +95,7 @@ Flashing First, connect the Arduino Nicla Sense ME board to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -118,7 +118,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/nicla_vision/doc/index.rst b/boards/arduino/nicla_vision/doc/index.rst index 3dacfc59763..fac12f25fac 100644 --- a/boards/arduino/nicla_vision/doc/index.rst +++ b/boards/arduino/nicla_vision/doc/index.rst @@ -137,7 +137,7 @@ First, connect the Arduino Nicla Vision board to your host computer using the US port to prepare it for flashing. Double click the ``RST`` button to put the board into the Arduino Bootloader mode. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/portenta_h7/doc/index.rst b/boards/arduino/portenta_h7/doc/index.rst index 241c0c4b25b..3ed69927f4f 100644 --- a/boards/arduino/portenta_h7/doc/index.rst +++ b/boards/arduino/portenta_h7/doc/index.rst @@ -114,7 +114,7 @@ First, connect the Arduino Portenta H7 board to your host computer using the USB port to prepare it for flashing. Double tap the button to put the board into the Arduino Bootloader mode. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arduino/zero/doc/index.rst b/boards/arduino/zero/doc/index.rst index 46eb837040c..3ec0a0fd82a 100644 --- a/boards/arduino/zero/doc/index.rst +++ b/boards/arduino/zero/doc/index.rst @@ -118,7 +118,7 @@ OpenOCD. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arm/mps2/doc/mps2_an385.rst b/boards/arm/mps2/doc/mps2_an385.rst index ffd8942dbfd..79f01dc9c53 100644 --- a/boards/arm/mps2/doc/mps2_an385.rst +++ b/boards/arm/mps2/doc/mps2_an385.rst @@ -253,7 +253,7 @@ V2M MPS2 provides: Flashing an application to V2M MPS2 ----------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arm/mps2/doc/mps2_an521.rst b/boards/arm/mps2/doc/mps2_an521.rst index 7149902b0db..33a4f4d7ca6 100644 --- a/boards/arm/mps2/doc/mps2_an521.rst +++ b/boards/arm/mps2/doc/mps2_an521.rst @@ -489,7 +489,7 @@ MPS2+ AN521 provides: - A Serial Port which is J10 on MPS2+ board Build applications as described above. -Here is an example for the :ref:`hello_world` application built as +Here is an example for the :zephyr:code-sample:`hello_world` application built as a secure-only application for CPU0. .. zephyr-app-commands:: diff --git a/boards/arm/mps3/doc/index.rst b/boards/arm/mps3/doc/index.rst index 530999206d4..e618b9a714c 100644 --- a/boards/arm/mps3/doc/index.rst +++ b/boards/arm/mps3/doc/index.rst @@ -142,7 +142,7 @@ Building an application ----------------------- You can build applications in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arm/v2m_beetle/doc/index.rst b/boards/arm/v2m_beetle/doc/index.rst index 7673e510ebf..49df438d3f9 100644 --- a/boards/arm/v2m_beetle/doc/index.rst +++ b/boards/arm/v2m_beetle/doc/index.rst @@ -229,7 +229,7 @@ Flashing an application to V2M Beetle ------------------------------------- You can build applications in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arm/v2m_musca_b1/doc/index.rst b/boards/arm/v2m_musca_b1/doc/index.rst index 0a7d41ac883..cb9aa61a0fd 100644 --- a/boards/arm/v2m_musca_b1/doc/index.rst +++ b/boards/arm/v2m_musca_b1/doc/index.rst @@ -308,7 +308,7 @@ Building a secure only application You can build applications in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/arm/v2m_musca_s1/doc/index.rst b/boards/arm/v2m_musca_s1/doc/index.rst index 7072ef7e219..86806891295 100644 --- a/boards/arm/v2m_musca_s1/doc/index.rst +++ b/boards/arm/v2m_musca_s1/doc/index.rst @@ -301,7 +301,7 @@ Building a secure only application ---------------------------------- You can build applications in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -318,7 +318,7 @@ Open a serial terminal (minicom, putty, etc.) with the following settings: Uploading an application to V2M Musca-S1 ---------------------------------------- -To upload the :ref:`hello_world` application to the board, no extra steps are +To upload the :zephyr:code-sample:`hello_world` application to the board, no extra steps are required. You can directly upload ``build/zephyr/zephyr.hex``, which is generated by Zephyr's build system. diff --git a/boards/atmel/sam/sam4e_xpro/doc/index.rst b/boards/atmel/sam/sam4e_xpro/doc/index.rst index 18d0836c6d6..b01e60cd56d 100644 --- a/boards/atmel/sam/sam4e_xpro/doc/index.rst +++ b/boards/atmel/sam/sam4e_xpro/doc/index.rst @@ -122,7 +122,7 @@ Using OpenOCD ------------- #. Connect the SAM4E Xplained Pro board to your host computer using the USB - debug port. Then build and flash the :ref:`hello_world` application. + debug port. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -138,7 +138,7 @@ Using SAM-BA bootloader #. Open the ``ERASE`` jumper. #. Connect the SAM4E Xplained Pro board to your host computer using the SoC - USB port. Then build and flash the :ref:`hello_world` application. + USB port. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -175,7 +175,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/atmel/sam/sam4l_ek/doc/index.rst b/boards/atmel/sam/sam4l_ek/doc/index.rst index a28b0728836..f3e4e27d376 100644 --- a/boards/atmel/sam/sam4l_ek/doc/index.rst +++ b/boards/atmel/sam/sam4l_ek/doc/index.rst @@ -140,7 +140,7 @@ Flashing - Stop bits: 1 #. Connect the SAM4L-EK board to your host computer using the USB debug port. - Then build and flash the :ref:`hello_world` application. + Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -153,7 +153,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/atmel/sam/sam4s_xplained/doc/index.rst b/boards/atmel/sam/sam4s_xplained/doc/index.rst index 9c1b999eca9..a5276bd6716 100644 --- a/boards/atmel/sam/sam4s_xplained/doc/index.rst +++ b/boards/atmel/sam/sam4s_xplained/doc/index.rst @@ -111,7 +111,7 @@ Using JLink accessible from your path. #. Connect the SAM4S Xplained board to your host computer using the USB debug - port. Then build and flash the :ref:`hello_world` application. + port. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -128,7 +128,7 @@ Using SAM-BA bootloader #. Open the ``J25`` jumper. #. Connect the SAM4S Xplained board to your host computer using the SoC USB - port. Then build and flash the :ref:`hello_world` application. + port. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -167,7 +167,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/atmel/sam/sam_e70_xplained/doc/index.rst b/boards/atmel/sam/sam_e70_xplained/doc/index.rst index bab33f538c4..67b90d42c59 100644 --- a/boards/atmel/sam/sam_e70_xplained/doc/index.rst +++ b/boards/atmel/sam/sam_e70_xplained/doc/index.rst @@ -141,7 +141,7 @@ Flashing - Stop bits: 1 #. Connect the SAM E70 Xplained board to your host computer using the - USB debug port. Then build and flash the :ref:`hello_world` + USB debug port. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -171,7 +171,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/atmel/sam/sam_v71_xult/doc/index.rst b/boards/atmel/sam/sam_v71_xult/doc/index.rst index e0b5fce6c04..7ce56d58a70 100644 --- a/boards/atmel/sam/sam_v71_xult/doc/index.rst +++ b/boards/atmel/sam/sam_v71_xult/doc/index.rst @@ -144,7 +144,7 @@ Flashing - Stop bits: 1 #. Connect the SAM V71 Xplained Ultra board to your host computer using the - USB debug port. Then build and flash the :ref:`hello_world` + USB debug port. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -174,7 +174,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/atmel/sam0/samd20_xpro/doc/index.rst b/boards/atmel/sam0/samd20_xpro/doc/index.rst index b0dbff28229..7b788cbbf73 100644 --- a/boards/atmel/sam0/samd20_xpro/doc/index.rst +++ b/boards/atmel/sam0/samd20_xpro/doc/index.rst @@ -110,7 +110,7 @@ OpenOCD. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/atmel/sam0/samr21_xpro/doc/index.rst b/boards/atmel/sam0/samr21_xpro/doc/index.rst index abb5cd9a21e..91a47615b9a 100644 --- a/boards/atmel/sam0/samr21_xpro/doc/index.rst +++ b/boards/atmel/sam0/samr21_xpro/doc/index.rst @@ -174,7 +174,7 @@ OpenOCD. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/bbc/microbit/doc/index.rst b/boards/bbc/microbit/doc/index.rst index aa36d3d662b..c4d11f7a671 100644 --- a/boards/bbc/microbit/doc/index.rst +++ b/boards/bbc/microbit/doc/index.rst @@ -77,7 +77,7 @@ Flashing Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/bbc/microbit_v2/doc/index.rst b/boards/bbc/microbit_v2/doc/index.rst index 7c94a3e5a4e..d906f13660b 100644 --- a/boards/bbc/microbit_v2/doc/index.rst +++ b/boards/bbc/microbit_v2/doc/index.rst @@ -71,7 +71,7 @@ Flashing Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/blues/swan_r5/doc/index.rst b/boards/blues/swan_r5/doc/index.rst index a5d9dd62436..6ee06251f30 100644 --- a/boards/blues/swan_r5/doc/index.rst +++ b/boards/blues/swan_r5/doc/index.rst @@ -198,7 +198,7 @@ Programming and Debugging Connect Swan to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Swan: diff --git a/boards/bytesatwork/bytesensi_l/doc/index.rst b/boards/bytesatwork/bytesensi_l/doc/index.rst index e50402fc0f1..9d16e74d21b 100644 --- a/boards/bytesatwork/bytesensi_l/doc/index.rst +++ b/boards/bytesatwork/bytesensi_l/doc/index.rst @@ -134,7 +134,7 @@ Flashing The byteSENSI-L board can be flashed with the SEGGER JLink programmer. You can build and flash applications in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/circuitdojo/feather/doc/index.rst b/boards/circuitdojo/feather/doc/index.rst index 998cfbcfdac..032b06d29d8 100644 --- a/boards/circuitdojo/feather/doc/index.rst +++ b/boards/circuitdojo/feather/doc/index.rst @@ -111,7 +111,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/contextualelectronics/abc/doc/index.rst b/boards/contextualelectronics/abc/doc/index.rst index 15f9e52bca8..dd8aa8acfb0 100644 --- a/boards/contextualelectronics/abc/doc/index.rst +++ b/boards/contextualelectronics/abc/doc/index.rst @@ -93,7 +93,7 @@ Flashing Flashing Zephyr onto the ``contextualelectronics_abc`` board requires an external programmer. The programmer is attached to the SWD header. -Build the Zephyr kernel and the :ref:`hello_world` sample application. +Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/cypress/cy8ckit_062_ble/doc/index.rst b/boards/cypress/cy8ckit_062_ble/doc/index.rst index 155f94f7b03..46940f0691a 100644 --- a/boards/cypress/cy8ckit_062_ble/doc/index.rst +++ b/boards/cypress/cy8ckit_062_ble/doc/index.rst @@ -154,7 +154,7 @@ and J12 that can be used with Segger J-Link [default]. A watchdog timer is enabled by default. To disable it call Cy_WDT_Unlock() and Cy_WDT_Disable(). -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -248,7 +248,7 @@ connections may not allow the correct use of shields. The default board revision (0.0.0) allows use of default connections. The use of Arduino headers are only possible after rework the board and using the revision 1.0.0. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application for +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application for board revision 1.0.0: .. zephyr-app-commands:: diff --git a/boards/digilent/arty_a7/doc/index.rst b/boards/digilent/arty_a7/doc/index.rst index 4284320d6de..c6cad8d9453 100644 --- a/boards/digilent/arty_a7/doc/index.rst +++ b/boards/digilent/arty_a7/doc/index.rst @@ -159,7 +159,7 @@ etc.): Flashing ======== -Here is an example for building and flashing the :ref:`hello_world` application +Here is an example for building and flashing the :zephyr:code-sample:`hello_world` application for the Cortex-M1 reference design: .. zephyr-app-commands:: @@ -191,7 +191,7 @@ dump :file:`zephyr.mem` file suitable for initialising the block RAM using Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/digilent/zybo/doc/index.rst b/boards/digilent/zybo/doc/index.rst index f8e3857227d..7b5bf386f03 100644 --- a/boards/digilent/zybo/doc/index.rst +++ b/boards/digilent/zybo/doc/index.rst @@ -77,7 +77,7 @@ Clone and build Das U-Boot for the Digilent Zybo: Flashing ======== -Here is an example for running the :ref:`hello_world` application via JTAG. +Here is an example for running the :zephyr:code-sample:`hello_world` application via JTAG. Ensure the board is configured for JTAG boot, open a serial terminal, turn on/reset the board (press the ``PS-SRST`` button), and initialize the Zynq-7000 series SoC by uploading and running the U-Boot @@ -97,7 +97,7 @@ You should see the following message in the terminal: *** Booting Zephyr OS vx.xx.x-xxx-gxxxxxxxxxxxx *** Hello World! zybo -Another option is to load and run the :ref:`hello_world` application via U-Boot. Copy +Another option is to load and run the :zephyr:code-sample:`hello_world` application via U-Boot. Copy ``u-boot/spl/boot.bin``, ``u-boot/u-boot.img``, and ``zephyr/zephyr.bin`` to a FAT32 formatted microSD card, insert the card in the ``SD MICRO`` slot on the Zybo board, ensure the board is configured for ``SD`` boot, and turn on the board. @@ -116,7 +116,7 @@ Once U-boot is done initializing, load an run the Zephyr application: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Ensure the board is configured for JTAG boot, open a serial terminal, turn on/reset the board (press the ``PS-SRST`` button), and initialize the Zynq-7000 series SoC by uploading and running the U-Boot diff --git a/boards/dragino/lsn50/doc/index.rst b/boards/dragino/lsn50/doc/index.rst index b3d14f92885..4a29c56af1d 100644 --- a/boards/dragino/lsn50/doc/index.rst +++ b/boards/dragino/lsn50/doc/index.rst @@ -149,7 +149,7 @@ Dragino LSN50 board requires an external debugger. Flashing an application to Dragino LSN50 ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Connect the Dragino LSN50 to a STLinkV2 to your host computer using the USB port, then run a serial host program to connect with your board. For example: @@ -175,7 +175,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/dragino/nbsn95/doc/index.rst b/boards/dragino/nbsn95/doc/index.rst index 09a8b91f6ce..27e32b7d06f 100644 --- a/boards/dragino/nbsn95/doc/index.rst +++ b/boards/dragino/nbsn95/doc/index.rst @@ -148,7 +148,7 @@ Dragino NBSN95 board requires an external debugger. Flashing an application to Dragino NBSN95 ----------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Connect the Dragino NBSN95 to a STLinkV2 to your host computer using the USB port, then run a serial host program to connect with your board. For example: @@ -174,7 +174,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/electronut/nrf52840_blip/doc/index.rst b/boards/electronut/nrf52840_blip/doc/index.rst index 9f78cee51ec..67a736bcd06 100644 --- a/boards/electronut/nrf52840_blip/doc/index.rst +++ b/boards/electronut/nrf52840_blip/doc/index.rst @@ -141,7 +141,7 @@ Flashing Applications are flashed and run as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/electronut/nrf52840_papyr/doc/nrf52840_papyr.rst b/boards/electronut/nrf52840_papyr/doc/nrf52840_papyr.rst index 7890cd108e4..814ef881360 100644 --- a/boards/electronut/nrf52840_papyr/doc/nrf52840_papyr.rst +++ b/boards/electronut/nrf52840_papyr/doc/nrf52840_papyr.rst @@ -151,7 +151,7 @@ debugger (see _Bumpy). Applications are flashed and run as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/espressif/esp32_devkitc_wroom/doc/index.rst b/boards/espressif/esp32_devkitc_wroom/doc/index.rst index f38470e09b2..68955f9c17c 100644 --- a/boards/espressif/esp32_devkitc_wroom/doc/index.rst +++ b/boards/espressif/esp32_devkitc_wroom/doc/index.rst @@ -213,7 +213,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32_devkitc_wroom`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -264,14 +264,14 @@ to the external programmer (e.g. a Flyswatter2): Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32_devkitc_wroom/esp32/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32_devkitc_wrover/doc/index.rst b/boards/espressif/esp32_devkitc_wrover/doc/index.rst index 24a2207ab1a..81c75c598ca 100644 --- a/boards/espressif/esp32_devkitc_wrover/doc/index.rst +++ b/boards/espressif/esp32_devkitc_wrover/doc/index.rst @@ -213,7 +213,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32_devkitc_wrover`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -264,14 +264,14 @@ to the external programmer (e.g. a Flyswatter2): Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32_devkitc_wrover/esp32/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32_ethernet_kit/doc/index.rst b/boards/espressif/esp32_ethernet_kit/doc/index.rst index a23d94daebb..4437e479bdf 100644 --- a/boards/espressif/esp32_ethernet_kit/doc/index.rst +++ b/boards/espressif/esp32_ethernet_kit/doc/index.rst @@ -530,7 +530,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32_ethernet_kit`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -563,7 +563,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -571,7 +571,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32c3_devkitc/doc/index.rst b/boards/espressif/esp32c3_devkitc/doc/index.rst index f000b959f1f..97ce7f181b5 100644 --- a/boards/espressif/esp32c3_devkitc/doc/index.rst +++ b/boards/espressif/esp32c3_devkitc/doc/index.rst @@ -195,7 +195,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32c3_devkitc`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -228,7 +228,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -236,7 +236,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32c3_devkitm/doc/index.rst b/boards/espressif/esp32c3_devkitm/doc/index.rst index 0100950ce9c..aed67104255 100644 --- a/boards/espressif/esp32c3_devkitm/doc/index.rst +++ b/boards/espressif/esp32c3_devkitm/doc/index.rst @@ -195,7 +195,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32c3_devkitm`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -228,7 +228,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -236,7 +236,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32c3_rust/doc/index.rst b/boards/espressif/esp32c3_rust/doc/index.rst index fc049ef6ea5..7b80d30ee5f 100644 --- a/boards/espressif/esp32c3_rust/doc/index.rst +++ b/boards/espressif/esp32c3_rust/doc/index.rst @@ -240,7 +240,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32c3_rust`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -273,7 +273,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -281,7 +281,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32c6_devkitc/doc/index.rst b/boards/espressif/esp32c6_devkitc/doc/index.rst index 9383ed6ba36..7b856912a9a 100644 --- a/boards/espressif/esp32c6_devkitc/doc/index.rst +++ b/boards/espressif/esp32c6_devkitc/doc/index.rst @@ -229,7 +229,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32c6_devkitc`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -262,7 +262,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -270,7 +270,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32s2_devkitc/doc/index.rst b/boards/espressif/esp32s2_devkitc/doc/index.rst index 4d7d400fe04..9e1bb15fd10 100644 --- a/boards/espressif/esp32s2_devkitc/doc/index.rst +++ b/boards/espressif/esp32s2_devkitc/doc/index.rst @@ -192,7 +192,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32s2_devkitc`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -235,14 +235,14 @@ The following table shows the pin mapping between ESP32-S2 board and JTAG interf Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S2`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32s2_devkitc :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32s2_saola/doc/index.rst b/boards/espressif/esp32s2_saola/doc/index.rst index 05db30be9a7..dba54f93cae 100644 --- a/boards/espressif/esp32s2_saola/doc/index.rst +++ b/boards/espressif/esp32s2_saola/doc/index.rst @@ -192,7 +192,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32s2_saola`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -235,14 +235,14 @@ The following table shows the pin mapping between ESP32-S2 board and JTAG interf Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S2`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32s2_saola :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32s3_devkitc/doc/index.rst b/boards/espressif/esp32s3_devkitc/doc/index.rst index f026ba34c4b..984a714d0f7 100644 --- a/boards/espressif/esp32s3_devkitc/doc/index.rst +++ b/boards/espressif/esp32s3_devkitc/doc/index.rst @@ -231,7 +231,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32s3_devkitc`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -262,14 +262,14 @@ ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additiona Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S3`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32s3_devkitc/esp32s3/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp32s3_devkitm/doc/index.rst b/boards/espressif/esp32s3_devkitm/doc/index.rst index 4cc05c4bfb8..b1e79766ed9 100644 --- a/boards/espressif/esp32s3_devkitm/doc/index.rst +++ b/boards/espressif/esp32s3_devkitm/doc/index.rst @@ -231,7 +231,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32s3_devkitm`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -262,14 +262,14 @@ ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additiona Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S3`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32s3_devkitm/esp32s3/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp8684_devkitm/doc/index.rst b/boards/espressif/esp8684_devkitm/doc/index.rst index e3d2b93d1df..5dd05ab7cec 100644 --- a/boards/espressif/esp8684_devkitm/doc/index.rst +++ b/boards/espressif/esp8684_devkitm/doc/index.rst @@ -187,7 +187,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp8684_devkitm`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -220,7 +220,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -228,7 +228,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/espressif/esp_wrover_kit/doc/index.rst b/boards/espressif/esp_wrover_kit/doc/index.rst index 67991e02019..0bef9a9ce4d 100644 --- a/boards/espressif/esp_wrover_kit/doc/index.rst +++ b/boards/espressif/esp_wrover_kit/doc/index.rst @@ -598,7 +598,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp_wrover_kit`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -634,7 +634,7 @@ headers are on the right side of the board as viewed from the power switch, next to similar headers for SPI and UART. See `ESP-WROVER-32 V3 Getting Started Guide`_ for details. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -642,7 +642,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ezurio/bl5340_dvk/doc/index.rst b/boards/ezurio/bl5340_dvk/doc/index.rst index 7ec697507c5..62a7de87f93 100644 --- a/boards/ezurio/bl5340_dvk/doc/index.rst +++ b/boards/ezurio/bl5340_dvk/doc/index.rst @@ -379,7 +379,7 @@ applications as usual (:ref:`build_an_application` and Further information on how to install the nRF Command Line Tools can be found in :ref:`nordic_segger_flashing`. -Here is an example for the :ref:`hello_world` application running on the +Here is an example for the :zephyr:code-sample:`hello_world` application running on the BL5340's application core. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst b/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst index c7ed935392c..aaae4b9071b 100644 --- a/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst +++ b/boards/ezurio/bl652_dvk/doc/bl652_dvk.rst @@ -214,7 +214,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst b/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst index 4011984a818..48c252b5ff9 100644 --- a/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst +++ b/boards/ezurio/bl653_dvk/doc/bl653_dvk.rst @@ -120,7 +120,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst b/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst index 2affaca8f5b..d262a9a5146 100644 --- a/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst +++ b/boards/ezurio/bl654_dvk/doc/bl654_dvk.rst @@ -131,7 +131,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst b/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst index bfea48d0f36..32036e38ada 100644 --- a/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst +++ b/boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst @@ -145,7 +145,7 @@ as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). If using a Ezurio USB-SWD Programmer Board, see the `pyOCD website`_ to find details about the software and how to install it. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output - note that an external UART is required to be connected to the BL654 sensor board's UART, if diff --git a/boards/ezurio/bt510/doc/bt510.rst b/boards/ezurio/bt510/doc/bt510.rst index ec0890c7480..bcdaf272265 100644 --- a/boards/ezurio/bt510/doc/bt510.rst +++ b/boards/ezurio/bt510/doc/bt510.rst @@ -187,7 +187,7 @@ Then build and flash applications as usual (see :ref:`build_an_application` and $ ninja flash -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/bt610/doc/bt610.rst b/boards/ezurio/bt610/doc/bt610.rst index 6c72804eb8e..528186ec880 100644 --- a/boards/ezurio/bt610/doc/bt610.rst +++ b/boards/ezurio/bt610/doc/bt610.rst @@ -545,7 +545,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/mg100/doc/index.rst b/boards/ezurio/mg100/doc/index.rst index 29274d98a04..86b92c52abf 100644 --- a/boards/ezurio/mg100/doc/index.rst +++ b/boards/ezurio/mg100/doc/index.rst @@ -174,7 +174,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/pinnacle_100_dvk/doc/index.rst b/boards/ezurio/pinnacle_100_dvk/doc/index.rst index de8735f3a60..7b63ada033b 100644 --- a/boards/ezurio/pinnacle_100_dvk/doc/index.rst +++ b/boards/ezurio/pinnacle_100_dvk/doc/index.rst @@ -144,7 +144,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/ezurio/rm1xx_dvk/doc/index.rst b/boards/ezurio/rm1xx_dvk/doc/index.rst index f530c9b791f..bd57e8f400d 100644 --- a/boards/ezurio/rm1xx_dvk/doc/index.rst +++ b/boards/ezurio/rm1xx_dvk/doc/index.rst @@ -143,7 +143,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/fanke/fk7b0m1_vbt6/doc/index.rst b/boards/fanke/fk7b0m1_vbt6/doc/index.rst index dfabfd54e88..19b346585be 100644 --- a/boards/fanke/fk7b0m1_vbt6/doc/index.rst +++ b/boards/fanke/fk7b0m1_vbt6/doc/index.rst @@ -145,7 +145,7 @@ To begin, connect the ST-Link Debug Programmer to the FK7B0M1-VBT6 board using t interface. Next, connect the ST-Link to your host computer via a USB port. Once this setup is complete, you can proceed to build and flash your application to the board -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/franzininho/esp32s2_franzininho/doc/index.rst b/boards/franzininho/esp32s2_franzininho/doc/index.rst index b2d1a8f6433..efa47c90719 100644 --- a/boards/franzininho/esp32s2_franzininho/doc/index.rst +++ b/boards/franzininho/esp32s2_franzininho/doc/index.rst @@ -148,7 +148,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32s2_franzininho`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/gd/gd32a503v_eval/doc/index.rst b/boards/gd/gd32a503v_eval/doc/index.rst index b926a265bb4..bd9170b16c4 100644 --- a/boards/gd/gd32a503v_eval/doc/index.rst +++ b/boards/gd/gd32a503v_eval/doc/index.rst @@ -119,7 +119,7 @@ The GD32A503V-EVAL includes an onboard programmer/debugger (GD-Link) which allow flash programming and debug over USB. There are also program and debug headers J2 and J100 that can be used with any ARM compatible tools. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -168,7 +168,7 @@ The GD32A503 MCU have a ROM bootloader which allow flash programming. User should install `GD32 ISP Console`_ software at some Linux path. The recommended is :code:`$HOME/.local/bin`. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32e103v_eval/doc/index.rst b/boards/gd/gd32e103v_eval/doc/index.rst index 3d9058793fe..f53d0b173d3 100644 --- a/boards/gd/gd32e103v_eval/doc/index.rst +++ b/boards/gd/gd32e103v_eval/doc/index.rst @@ -111,7 +111,7 @@ The GD32E103V-EVAL includes an onboard programmer/debugger (GD-Link) which allow flash programming and debug over USB. There are also program and debug headers J1 and J100 that can be used with any ARM compatible tools. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -160,7 +160,7 @@ The GD32E103 MCU have a ROM bootloader which allow flash programming. User should install `GD32 ISP Console`_ software at some Linux path. The recommended is :code:`$HOME/.local/bin`. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32e507v_start/doc/index.rst b/boards/gd/gd32e507v_start/doc/index.rst index 097c5a5c976..902b4a20766 100644 --- a/boards/gd/gd32e507v_start/doc/index.rst +++ b/boards/gd/gd32e507v_start/doc/index.rst @@ -94,7 +94,7 @@ provided you install the necessary CMSIS-Pack: J-Link can also be used to program the board using the SWD interface exposed in the JP1 header. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32e507z_eval/doc/index.rst b/boards/gd/gd32e507z_eval/doc/index.rst index c3484d8beec..edaac634410 100644 --- a/boards/gd/gd32e507z_eval/doc/index.rst +++ b/boards/gd/gd32e507z_eval/doc/index.rst @@ -102,7 +102,7 @@ provided you install the necessary CMSIS-Pack: J-Link can also be used to program the board using the JTAG interface exposed in the JP2 header. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f350r_eval/doc/index.rst b/boards/gd/gd32f350r_eval/doc/index.rst index 8a2317da68e..d5dc24f46c9 100644 --- a/boards/gd/gd32f350r_eval/doc/index.rst +++ b/boards/gd/gd32f350r_eval/doc/index.rst @@ -87,7 +87,7 @@ The GD32F350R-EVAL includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a SWD header (J3) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f403z_eval/doc/index.rst b/boards/gd/gd32f403z_eval/doc/index.rst index 4ea432c31d1..c5c97fd727c 100644 --- a/boards/gd/gd32f403z_eval/doc/index.rst +++ b/boards/gd/gd32f403z_eval/doc/index.rst @@ -114,7 +114,7 @@ The GD32F403Z-EVAL includes an onboard programmer/debugger (GD-Link) which allow flash programming and debug over USB. There are also program and debug headers J1 and J100 that can be used with any ARM compatible tools. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -163,7 +163,7 @@ The GD32F403 MCU have a ROM bootloader which allow flash programming. User should install `GD32 ISP Console`_ software at some Linux path. The recommended is :code:`$HOME/.local/bin`. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f407v_start/doc/index.rst b/boards/gd/gd32f407v_start/doc/index.rst index cd67921e59e..a59243db498 100644 --- a/boards/gd/gd32f407v_start/doc/index.rst +++ b/boards/gd/gd32f407v_start/doc/index.rst @@ -96,7 +96,7 @@ if not installed yet. Also, J-Link can be used to program the board via the SWD interface (PA13/SWDIO and PA14/SWCLK in the JP6 header). -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f450i_eval/doc/index.rst b/boards/gd/gd32f450i_eval/doc/index.rst index 59e9d258975..e01c3957652 100644 --- a/boards/gd/gd32f450i_eval/doc/index.rst +++ b/boards/gd/gd32f450i_eval/doc/index.rst @@ -112,7 +112,7 @@ The GD32F450I-EVAL includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a JTAG header (J1) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f450v_start/doc/index.rst b/boards/gd/gd32f450v_start/doc/index.rst index e45f05a58a6..0b1a781758b 100644 --- a/boards/gd/gd32f450v_start/doc/index.rst +++ b/boards/gd/gd32f450v_start/doc/index.rst @@ -89,7 +89,7 @@ The GD32F450V-START includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a SWD header (JP100) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f450z_eval/doc/index.rst b/boards/gd/gd32f450z_eval/doc/index.rst index 0e31f262db3..cdc4f8f42a7 100644 --- a/boards/gd/gd32f450z_eval/doc/index.rst +++ b/boards/gd/gd32f450z_eval/doc/index.rst @@ -107,7 +107,7 @@ The GD32F450Z-EVAL includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a JTAG header (J1) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32f470i_eval/doc/index.rst b/boards/gd/gd32f470i_eval/doc/index.rst index 627dc1fa9e9..75e33eaed2a 100644 --- a/boards/gd/gd32f470i_eval/doc/index.rst +++ b/boards/gd/gd32f470i_eval/doc/index.rst @@ -111,7 +111,7 @@ The GD32F470I-EVAL includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a JTAG header (J1) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32l233r_eval/doc/index.rst b/boards/gd/gd32l233r_eval/doc/index.rst index 8b5a08514e3..884978fd021 100644 --- a/boards/gd/gd32l233r_eval/doc/index.rst +++ b/boards/gd/gd32l233r_eval/doc/index.rst @@ -88,7 +88,7 @@ The GD32L233R-EVAL includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a SWD header which can be used with tools like Segger J-Link(latest version required). -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32vf103c_starter/doc/index.rst b/boards/gd/gd32vf103c_starter/doc/index.rst index aee1ea612e7..29a428c6c98 100644 --- a/boards/gd/gd32vf103c_starter/doc/index.rst +++ b/boards/gd/gd32vf103c_starter/doc/index.rst @@ -83,7 +83,7 @@ The GD32VF103C-STARTER includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a JTAG header (JP1) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/gd/gd32vf103v_eval/doc/index.rst b/boards/gd/gd32vf103v_eval/doc/index.rst index 42af6d765d6..5aa8e8327bd 100644 --- a/boards/gd/gd32vf103v_eval/doc/index.rst +++ b/boards/gd/gd32vf103v_eval/doc/index.rst @@ -93,7 +93,7 @@ The GD32VF103V-EVAL includes an onboard programmer/debugger (GD-Link) which allows flash programming and debugging over USB. There is also a JTAG header (JP1) which can be used with tools like Segger J-Link. -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/hardkernel/odroid_go/doc/index.rst b/boards/hardkernel/odroid_go/doc/index.rst index 86eb0afae26..62f38d4799d 100644 --- a/boards/hardkernel/odroid_go/doc/index.rst +++ b/boards/hardkernel/odroid_go/doc/index.rst @@ -192,7 +192,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``odroid_go`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -225,7 +225,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -233,7 +233,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst b/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst index b1c07130703..ee595e0a847 100644 --- a/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst +++ b/boards/heltec/heltec_wifi_lora32_v2/doc/index.rst @@ -136,7 +136,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``heltec_wifi_lora32_v2`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -169,7 +169,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -177,7 +177,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst b/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst index c2b141ae159..352d158fbac 100644 --- a/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst +++ b/boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst @@ -250,7 +250,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``heltec_wireless_stick_lite_v3`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -283,7 +283,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -291,7 +291,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/infineon/xmc45_relax_kit/doc/index.rst b/boards/infineon/xmc45_relax_kit/doc/index.rst index 89c9bcf04e3..621fc1cc83e 100644 --- a/boards/infineon/xmc45_relax_kit/doc/index.rst +++ b/boards/infineon/xmc45_relax_kit/doc/index.rst @@ -74,7 +74,7 @@ Building and Flashing Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -84,7 +84,7 @@ Here is an example for the :ref:`hello_world` application. Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/infineon/xmc47_relax_kit/doc/index.rst b/boards/infineon/xmc47_relax_kit/doc/index.rst index 35457f387df..57eb28efaed 100644 --- a/boards/infineon/xmc47_relax_kit/doc/index.rst +++ b/boards/infineon/xmc47_relax_kit/doc/index.rst @@ -77,7 +77,7 @@ Building and Flashing Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -87,7 +87,7 @@ Here is an example for the :ref:`hello_world` application. Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/innblue/innblue21/doc/index.rst b/boards/innblue/innblue21/doc/index.rst index 333db42bfd9..0990c395c62 100644 --- a/boards/innblue/innblue21/doc/index.rst +++ b/boards/innblue/innblue21/doc/index.rst @@ -119,7 +119,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/innblue/innblue22/doc/index.rst b/boards/innblue/innblue22/doc/index.rst index 862c42cdd22..3485ad4de77 100644 --- a/boards/innblue/innblue22/doc/index.rst +++ b/boards/innblue/innblue22/doc/index.rst @@ -119,7 +119,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/intel/socfpga_std/cyclonev_socdk/doc/index.rst b/boards/intel/socfpga_std/cyclonev_socdk/doc/index.rst index 752284a63b9..6183491690c 100644 --- a/boards/intel/socfpga_std/cyclonev_socdk/doc/index.rst +++ b/boards/intel/socfpga_std/cyclonev_socdk/doc/index.rst @@ -163,7 +163,7 @@ Flashing Kernel into the board ------------------------------ The usual ``flash`` target will work with the ``cyclonev_socdk`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. ``Important!!!`` : Before flashing the board a ``preloader`` is required, diff --git a/boards/ite/it82xx2_evb/doc/index.rst b/boards/ite/it82xx2_evb/doc/index.rst index 0080c4f3e13..d31b989f225 100644 --- a/boards/ite/it82xx2_evb/doc/index.rst +++ b/boards/ite/it82xx2_evb/doc/index.rst @@ -151,7 +151,7 @@ Wiring Building ======== -#. Build :ref:`hello_world` application as you would normally do +#. Build :zephyr:code-sample:`hello_world` application as you would normally do (see :`Zephyr Getting Started Guide`_):. .. zephyr-app-commands:: diff --git a/boards/ite/it8xxx2_evb/doc/index.rst b/boards/ite/it8xxx2_evb/doc/index.rst index 5fab9cc412c..0e215fddf7e 100644 --- a/boards/ite/it8xxx2_evb/doc/index.rst +++ b/boards/ite/it8xxx2_evb/doc/index.rst @@ -133,7 +133,7 @@ Wiring Building ======== -#. Build :ref:`hello_world` application as you would normally do +#. Build :zephyr:code-sample:`hello_world` application as you would normally do (see :`Zephyr Getting Started Guide`_):. .. zephyr-app-commands:: diff --git a/boards/khadas/edgev/doc/index.rst b/boards/khadas/edgev/doc/index.rst index 2c73d109b09..c6c3e44826a 100644 --- a/boards/khadas/edgev/doc/index.rst +++ b/boards/khadas/edgev/doc/index.rst @@ -41,7 +41,7 @@ Programming and Debugging ************************* Use the following configuration to run basic Zephyr applications and -kernel tests on Khadas Edge-V board. For example, with the :ref:`hello_world`: +kernel tests on Khadas Edge-V board. For example, with the :zephyr:code-sample:`hello_world`: 1. Non-SMP mode diff --git a/boards/kincony/kincony_kc868_a32/doc/index.rst b/boards/kincony/kincony_kc868_a32/doc/index.rst index a6117bec55e..ccc8676f512 100644 --- a/boards/kincony/kincony_kc868_a32/doc/index.rst +++ b/boards/kincony/kincony_kc868_a32/doc/index.rst @@ -58,7 +58,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``kincony_kc868_a32`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/lilygo/ttgo_lora32/doc/index.rst b/boards/lilygo/ttgo_lora32/doc/index.rst index 6814a66543f..c7a04423e90 100644 --- a/boards/lilygo/ttgo_lora32/doc/index.rst +++ b/boards/lilygo/ttgo_lora32/doc/index.rst @@ -179,7 +179,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``ttgo_lora32`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/lilygo/ttgo_t8c3/doc/index.rst b/boards/lilygo/ttgo_t8c3/doc/index.rst index e4ad3978cef..2b11dd90a0a 100644 --- a/boards/lilygo/ttgo_t8c3/doc/index.rst +++ b/boards/lilygo/ttgo_t8c3/doc/index.rst @@ -177,7 +177,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``ttgo_t8c3`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/lowrisc/opentitan_earlgrey/doc/index.rst b/boards/lowrisc/opentitan_earlgrey/doc/index.rst index f3edf95e44e..b91c0700def 100644 --- a/boards/lowrisc/opentitan_earlgrey/doc/index.rst +++ b/boards/lowrisc/opentitan_earlgrey/doc/index.rst @@ -57,7 +57,7 @@ Setup`_ guide . Building and Flashing ===================== -Here is an example for building the :ref:`hello_world` application. The +Here is an example for building the :zephyr:code-sample:`hello_world` application. The following steps were tested on OpenTitan master branch @ 6a3c2e98. .. zephyr-app-commands:: diff --git a/boards/luatos/esp32c3_luatos_core/doc/index.rst b/boards/luatos/esp32c3_luatos_core/doc/index.rst index 03a9ccc9d3b..2e0d5ed56b2 100644 --- a/boards/luatos/esp32c3_luatos_core/doc/index.rst +++ b/boards/luatos/esp32c3_luatos_core/doc/index.rst @@ -203,7 +203,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``esp32c3_luatos_core`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -236,7 +236,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -244,7 +244,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/luatos/esp32s3_luatos_core/doc/index.rst b/boards/luatos/esp32s3_luatos_core/doc/index.rst index 9a5bec48362..7aa43102069 100644 --- a/boards/luatos/esp32s3_luatos_core/doc/index.rst +++ b/boards/luatos/esp32s3_luatos_core/doc/index.rst @@ -237,7 +237,7 @@ If CH343 chip is disabled, You need use the following command to build: :goals: build The usual ``flash`` target will work with the ``esp32s3_luatos_core`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -268,14 +268,14 @@ ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additiona Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S3`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: esp32s3_luatos_core/esp32s3/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/m5stack/m5stack_atom_lite/doc/index.rst b/boards/m5stack/m5stack_atom_lite/doc/index.rst index 2e8c1fade47..6a47c4a7f32 100644 --- a/boards/m5stack/m5stack_atom_lite/doc/index.rst +++ b/boards/m5stack/m5stack_atom_lite/doc/index.rst @@ -96,7 +96,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``m5stack_atom_lite`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/m5stack/m5stack_atoms3/doc/index.rst b/boards/m5stack/m5stack_atoms3/doc/index.rst index c053f73c101..69bff1ee0cf 100644 --- a/boards/m5stack/m5stack_atoms3/doc/index.rst +++ b/boards/m5stack/m5stack_atoms3/doc/index.rst @@ -98,7 +98,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``m5stack_atoms3`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/m5stack/m5stack_atoms3_lite/doc/index.rst b/boards/m5stack/m5stack_atoms3_lite/doc/index.rst index 204d8e5bbec..ffbe8f1cb05 100644 --- a/boards/m5stack/m5stack_atoms3_lite/doc/index.rst +++ b/boards/m5stack/m5stack_atoms3_lite/doc/index.rst @@ -96,7 +96,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``m5stack_atoms3_lite`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/m5stack/m5stack_core2/doc/index.rst b/boards/m5stack/m5stack_core2/doc/index.rst index c7a907a3e34..02ba5fa7249 100644 --- a/boards/m5stack/m5stack_core2/doc/index.rst +++ b/boards/m5stack/m5stack_core2/doc/index.rst @@ -183,7 +183,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``m5stack_core2`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/m5stack/m5stack_stamps3/doc/index.rst b/boards/m5stack/m5stack_stamps3/doc/index.rst index 59e1d5145aa..36881121e8a 100644 --- a/boards/m5stack/m5stack_stamps3/doc/index.rst +++ b/boards/m5stack/m5stack_stamps3/doc/index.rst @@ -153,7 +153,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``m5stack_stamps3`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/m5stack/m5stickc_plus/doc/index.rst b/boards/m5stack/m5stickc_plus/doc/index.rst index e59da05f93b..4fe431fea84 100644 --- a/boards/m5stack/m5stickc_plus/doc/index.rst +++ b/boards/m5stack/m5stickc_plus/doc/index.rst @@ -181,7 +181,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``m5stickc_plus`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/m5stack/stamp_c3/doc/index.rst b/boards/m5stack/stamp_c3/doc/index.rst index 721c62eacc7..40869ee0166 100644 --- a/boards/m5stack/stamp_c3/doc/index.rst +++ b/boards/m5stack/stamp_c3/doc/index.rst @@ -150,7 +150,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``stamp_c3`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -183,7 +183,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -191,7 +191,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/madmachine/mm_feather/doc/index.rst b/boards/madmachine/mm_feather/doc/index.rst index 5b53ddfc586..0a556bc42b0 100644 --- a/boards/madmachine/mm_feather/doc/index.rst +++ b/boards/madmachine/mm_feather/doc/index.rst @@ -195,7 +195,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Connect a DAPLink debugger from your PC to corresponding SWD pins of SwiftIO Feather. @@ -215,7 +215,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/madmachine/mm_swiftio/doc/index.rst b/boards/madmachine/mm_swiftio/doc/index.rst index d9361404d57..5fb0837e1ea 100644 --- a/boards/madmachine/mm_swiftio/doc/index.rst +++ b/boards/madmachine/mm_swiftio/doc/index.rst @@ -206,7 +206,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Connect a USB cable from your PC to "Serial" port of SwiftIO. On Ubuntu, DAPLink debug probes appear on the host diff --git a/boards/microchip/mec1501modular_assy6885/doc/index.rst b/boards/microchip/mec1501modular_assy6885/doc/index.rst index a74f48163fb..a70c20ee961 100644 --- a/boards/microchip/mec1501modular_assy6885/doc/index.rst +++ b/boards/microchip/mec1501modular_assy6885/doc/index.rst @@ -260,7 +260,7 @@ Setup Building ========== -#. Build :ref:`hello_world` application as you would normally do. +#. Build :zephyr:code-sample:`hello_world` application as you would normally do. #. Once you have ``zephyr.bin``, use the `MEC152x SPI Image Gen`_ microchip tool to create the final binary. You need the output from this tool to flash diff --git a/boards/microchip/mec15xxevb_assy6853/doc/index.rst b/boards/microchip/mec15xxevb_assy6853/doc/index.rst index e3b29e99212..4eafd2e758c 100644 --- a/boards/microchip/mec15xxevb_assy6853/doc/index.rst +++ b/boards/microchip/mec15xxevb_assy6853/doc/index.rst @@ -352,7 +352,7 @@ Wiring Building ======== -#. Build :ref:`hello_world` application as you would normally do. +#. Build :zephyr:code-sample:`hello_world` application as you would normally do. #. The file :file:`spi_image.bin` will be created if the build system can find the image generation tool. This binary image can be used diff --git a/boards/microchip/mec172xevb_assy6906/doc/index.rst b/boards/microchip/mec172xevb_assy6906/doc/index.rst index a2100e5a2d6..4765d787d94 100644 --- a/boards/microchip/mec172xevb_assy6906/doc/index.rst +++ b/boards/microchip/mec172xevb_assy6906/doc/index.rst @@ -360,7 +360,7 @@ Wiring Building ======== -#. Build :ref:`hello_world` application as you would normally do. +#. Build :zephyr:code-sample:`hello_world` application as you would normally do. #. The file :file:`spi_image.bin` will be created if the build system can find the image generation tool. This binary image can be used diff --git a/boards/microchip/mec172xmodular_assy6930/doc/mec172xmodular_assy6930.rst b/boards/microchip/mec172xmodular_assy6930/doc/mec172xmodular_assy6930.rst index a3a85487342..a85226e87d0 100644 --- a/boards/microchip/mec172xmodular_assy6930/doc/mec172xmodular_assy6930.rst +++ b/boards/microchip/mec172xmodular_assy6930/doc/mec172xmodular_assy6930.rst @@ -241,7 +241,7 @@ Wiring Building ======== -#. Build :ref:`hello_world` application as you would normally do. +#. Build :zephyr:code-sample:`hello_world` application as you would normally do. #. The file :file:`spi_image.bin` will be created if the build system can find the image generation tool. This binary image can be used diff --git a/boards/mikroe/clicker_2/doc/mikroe_clicker_2.rst b/boards/mikroe/clicker_2/doc/mikroe_clicker_2.rst index 99cb9ce0c61..a1ef4aa09ec 100644 --- a/boards/mikroe/clicker_2/doc/mikroe_clicker_2.rst +++ b/boards/mikroe/clicker_2/doc/mikroe_clicker_2.rst @@ -91,7 +91,7 @@ Unlocking with openocd makes it possible to flash. -f /usr/share/openocd/scripts/target/stm32f4x.cfg -c init\ -c "reset halt" -c "stm32f4x unlock 0" -c "reset run" -c shutdown -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -109,7 +109,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/mikroe/mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst b/boards/mikroe/mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst index 7198f2da36e..6194953b1da 100644 --- a/boards/mikroe/mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst +++ b/boards/mikroe/mini_m4_for_stm32/doc/mikroe_mini_m4_for_stm32.rst @@ -118,7 +118,7 @@ Unlocking with openocd makes it possible to flash. -f /usr/share/openocd/scripts/target/stm32f4x.cfg -c init\ -c "reset halt" -c "stm32f4x unlock 0" -c "reset run" -c shutdown -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -135,7 +135,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/mxchip/az3166_iotdevkit/doc/index.rst b/boards/mxchip/az3166_iotdevkit/doc/index.rst index 2e44339bec2..694d53517a6 100644 --- a/boards/mxchip/az3166_iotdevkit/doc/index.rst +++ b/boards/mxchip/az3166_iotdevkit/doc/index.rst @@ -76,7 +76,7 @@ Flashing Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf21540dk/doc/index.rst b/boards/nordic/nrf21540dk/doc/index.rst index 8ea583edb1a..7ed102b2b61 100644 --- a/boards/nordic/nrf21540dk/doc/index.rst +++ b/boards/nordic/nrf21540dk/doc/index.rst @@ -135,7 +135,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf51dk/doc/index.rst b/boards/nordic/nrf51dk/doc/index.rst index c905dc0f476..f5a2acbbcde 100644 --- a/boards/nordic/nrf51dk/doc/index.rst +++ b/boards/nordic/nrf51dk/doc/index.rst @@ -110,7 +110,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf51dongle/doc/index.rst b/boards/nordic/nrf51dongle/doc/index.rst index d8183371654..63f288e23fc 100644 --- a/boards/nordic/nrf51dongle/doc/index.rst +++ b/boards/nordic/nrf51dongle/doc/index.rst @@ -105,7 +105,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf52833dk/doc/index.rst b/boards/nordic/nrf52833dk/doc/index.rst index 027f471586f..ed057bbc93c 100644 --- a/boards/nordic/nrf52833dk/doc/index.rst +++ b/boards/nordic/nrf52833dk/doc/index.rst @@ -119,7 +119,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf52840dk/doc/index.rst b/boards/nordic/nrf52840dk/doc/index.rst index faa7f07d5c9..7c948d7cffd 100644 --- a/boards/nordic/nrf52840dk/doc/index.rst +++ b/boards/nordic/nrf52840dk/doc/index.rst @@ -124,7 +124,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf52dk/doc/index.rst b/boards/nordic/nrf52dk/doc/index.rst index 4ebcac44e6c..61349e8d31c 100644 --- a/boards/nordic/nrf52dk/doc/index.rst +++ b/boards/nordic/nrf52dk/doc/index.rst @@ -357,7 +357,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf5340dk/doc/index.rst b/boards/nordic/nrf5340dk/doc/index.rst index e933f43bdb4..9aa3f79180b 100644 --- a/boards/nordic/nrf5340dk/doc/index.rst +++ b/boards/nordic/nrf5340dk/doc/index.rst @@ -278,7 +278,7 @@ applications as usual (:ref:`build_an_application` and information on how to install the nRF Command Line Tools can be found in :ref:`nordic_segger_flashing`. -Here is an example for the :ref:`hello_world` application running on the +Here is an example for the :zephyr:code-sample:`hello_world` application running on the nRF5340 application core. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf54h20dk/doc/index.rst b/boards/nordic/nrf54h20dk/doc/index.rst index 6aa59b7c735..41306357fe4 100644 --- a/boards/nordic/nrf54h20dk/doc/index.rst +++ b/boards/nordic/nrf54h20dk/doc/index.rst @@ -129,7 +129,7 @@ cores only, using :ref:`nordic_segger`. Flashing ======== -As an example, this section shows how to build and flash the :ref:`hello_world` +As an example, this section shows how to build and flash the :zephyr:code-sample:`hello_world` application. To build and program the sample to the nRF54H20 DK, complete the following steps: diff --git a/boards/nordic/nrf54l15dk/doc/index.rst b/boards/nordic/nrf54l15dk/doc/index.rst index d411032ff2c..7d450912661 100644 --- a/boards/nordic/nrf54l15dk/doc/index.rst +++ b/boards/nordic/nrf54l15dk/doc/index.rst @@ -103,7 +103,7 @@ Enter the following command to compile ``hello_world`` for the FLPR core:: Flashing ======== -As an example, this section shows how to build and flash the :ref:`hello_world` +As an example, this section shows how to build and flash the :zephyr:code-sample:`hello_world` application. .. warning:: diff --git a/boards/nordic/nrf54l15pdk/doc/index.rst b/boards/nordic/nrf54l15pdk/doc/index.rst index ccc6230dd7d..dc6e69b65e5 100644 --- a/boards/nordic/nrf54l15pdk/doc/index.rst +++ b/boards/nordic/nrf54l15pdk/doc/index.rst @@ -97,7 +97,7 @@ building and running. Flashing ======== -As an example, this section shows how to build and flash the :ref:`hello_world` +As an example, this section shows how to build and flash the :zephyr:code-sample:`hello_world` application. .. warning:: diff --git a/boards/nordic/nrf54l20pdk/doc/index.rst b/boards/nordic/nrf54l20pdk/doc/index.rst index 2297df5dd41..aaed616ecce 100644 --- a/boards/nordic/nrf54l20pdk/doc/index.rst +++ b/boards/nordic/nrf54l20pdk/doc/index.rst @@ -68,7 +68,7 @@ building and running. Flashing ======== -As an example, this section shows how to build and flash the :ref:`hello_world` +As an example, this section shows how to build and flash the :zephyr:code-sample:`hello_world` application. Follow the instructions in the :ref:`nordic_segger` page to install diff --git a/boards/nordic/nrf7002dk/doc/index.rst b/boards/nordic/nrf7002dk/doc/index.rst index 5b25a7aa28f..3e3153c376f 100644 --- a/boards/nordic/nrf7002dk/doc/index.rst +++ b/boards/nordic/nrf7002dk/doc/index.rst @@ -278,7 +278,7 @@ applications as usual (:ref:`build_an_application` and information on how to install the nRF Command Line Tools can be found in :ref:`nordic_segger_flashing`. -Here is an example for the :ref:`hello_world` application running on the +Here is an example for the :zephyr:code-sample:`hello_world` application running on the nRF5340 application core. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf9131ek/doc/index.rst b/boards/nordic/nrf9131ek/doc/index.rst index accd403a286..236f6b396fc 100644 --- a/boards/nordic/nrf9131ek/doc/index.rst +++ b/boards/nordic/nrf9131ek/doc/index.rst @@ -180,7 +180,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf9151dk/doc/index.rst b/boards/nordic/nrf9151dk/doc/index.rst index 4017347c4f8..2365de529f7 100644 --- a/boards/nordic/nrf9151dk/doc/index.rst +++ b/boards/nordic/nrf9151dk/doc/index.rst @@ -150,7 +150,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf9160dk/doc/index.rst b/boards/nordic/nrf9160dk/doc/index.rst index 70fd2c2fc46..a91cf76547b 100644 --- a/boards/nordic/nrf9160dk/doc/index.rst +++ b/boards/nordic/nrf9160dk/doc/index.rst @@ -214,7 +214,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -346,7 +346,7 @@ applications as usual (see :ref:`build_an_application` and Remember to set the PROG/DEBUG switch on the DK to nRF52. -See the following example for the :ref:`hello_world` application. +See the following example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf9161dk/doc/index.rst b/boards/nordic/nrf9161dk/doc/index.rst index 251c8467a21..bb9d4eebbe4 100644 --- a/boards/nordic/nrf9161dk/doc/index.rst +++ b/boards/nordic/nrf9161dk/doc/index.rst @@ -153,7 +153,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/nordic/nrf9280pdk/doc/index.rst b/boards/nordic/nrf9280pdk/doc/index.rst index 052d2e5218c..394229217f7 100644 --- a/boards/nordic/nrf9280pdk/doc/index.rst +++ b/boards/nordic/nrf9280pdk/doc/index.rst @@ -71,7 +71,7 @@ and :ref:`application_run` for more details on building and running. Flashing ======== -As an example, this section shows how to build and flash the :ref:`hello_world` +As an example, this section shows how to build and flash the :zephyr:code-sample:`hello_world` application. Follow the instructions in the :ref:`nordic_segger` page to install diff --git a/boards/nuvoton/npcm400_evb/doc/index.rst b/boards/nuvoton/npcm400_evb/doc/index.rst index 930ac3dfe3a..d5d9ee550c2 100644 --- a/boards/nuvoton/npcm400_evb/doc/index.rst +++ b/boards/nuvoton/npcm400_evb/doc/index.rst @@ -86,7 +86,7 @@ If the correct headers are installed, this board supports J-TAG. To flash with J-TAG, install the drivers for your programmer, for example: SEGGER J-link's drivers are at https://www.segger.com/downloads/jlink/ -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nuvoton/numaker_m2l31ki/doc/index.rst b/boards/nuvoton/numaker_m2l31ki/doc/index.rst index 3e2c8b9550b..8c2e8b8bf77 100644 --- a/boards/nuvoton/numaker_m2l31ki/doc/index.rst +++ b/boards/nuvoton/numaker_m2l31ki/doc/index.rst @@ -58,7 +58,7 @@ Building and Flashing Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. On board debugger Nu-link2 can emulate UART0 as a virtual COM port over usb, To enable this, set ISW1 DIP switch 1-3 (TXD RXD VOM) to ON. @@ -77,7 +77,7 @@ run a serial host program to connect with your board. For example: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nuvoton/numaker_pfm_m467/doc/index.rst b/boards/nuvoton/numaker_pfm_m467/doc/index.rst index 483ab34b623..6620acce559 100644 --- a/boards/nuvoton/numaker_pfm_m467/doc/index.rst +++ b/boards/nuvoton/numaker_pfm_m467/doc/index.rst @@ -62,7 +62,7 @@ Building and Flashing Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. On board debugger Nu-link2 can emulate UART0 as a virtual COM port over usb, To enable this, set ISW1 DIP switch 1-3 (TXD RXD VOM) to ON. @@ -81,7 +81,7 @@ run a serial host program to connect with your board. For example: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nuvoton/numaker_pfm_m487/doc/index.rst b/boards/nuvoton/numaker_pfm_m487/doc/index.rst index 323be5f5923..180ae3c5665 100644 --- a/boards/nuvoton/numaker_pfm_m487/doc/index.rst +++ b/boards/nuvoton/numaker_pfm_m487/doc/index.rst @@ -61,7 +61,7 @@ Building and Flashing Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. On board debugger Nu-link-Me can emulate UART0 as a virtual COM port over usb, To enable this, set ISW1 DIP switch 1-3 (TXD RXD VOM) to ON. @@ -80,7 +80,7 @@ run a serial host program to connect with your board. For example: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_k22f/doc/index.rst b/boards/nxp/frdm_k22f/doc/index.rst index b92fa508cd0..2e5ea18aab8 100644 --- a/boards/nxp/frdm_k22f/doc/index.rst +++ b/boards/nxp/frdm_k22f/doc/index.rst @@ -237,7 +237,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -255,7 +255,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_k64f/doc/index.rst b/boards/nxp/frdm_k64f/doc/index.rst index 1c240ef400f..17af8d4cf29 100644 --- a/boards/nxp/frdm_k64f/doc/index.rst +++ b/boards/nxp/frdm_k64f/doc/index.rst @@ -309,7 +309,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -327,7 +327,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_k82f/doc/index.rst b/boards/nxp/frdm_k82f/doc/index.rst index f306dc6dada..9903e1b4493 100644 --- a/boards/nxp/frdm_k82f/doc/index.rst +++ b/boards/nxp/frdm_k82f/doc/index.rst @@ -194,7 +194,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -212,7 +212,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_ke15z/doc/index.rst b/boards/nxp/frdm_ke15z/doc/index.rst index fd1dec9bc67..772de4f8678 100644 --- a/boards/nxp/frdm_ke15z/doc/index.rst +++ b/boards/nxp/frdm_ke15z/doc/index.rst @@ -129,7 +129,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -147,7 +147,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_ke17z/doc/index.rst b/boards/nxp/frdm_ke17z/doc/index.rst index 7fb9f29d84e..1f15fc99fb9 100644 --- a/boards/nxp/frdm_ke17z/doc/index.rst +++ b/boards/nxp/frdm_ke17z/doc/index.rst @@ -156,7 +156,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -174,7 +174,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_ke17z512/doc/index.rst b/boards/nxp/frdm_ke17z512/doc/index.rst index 3e5be805da6..ab4948307da 100644 --- a/boards/nxp/frdm_ke17z512/doc/index.rst +++ b/boards/nxp/frdm_ke17z512/doc/index.rst @@ -152,7 +152,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -170,7 +170,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_kl25z/doc/index.rst b/boards/nxp/frdm_kl25z/doc/index.rst index 6695974c29e..215c476df03 100644 --- a/boards/nxp/frdm_kl25z/doc/index.rst +++ b/boards/nxp/frdm_kl25z/doc/index.rst @@ -189,7 +189,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -207,7 +207,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_kw41z/doc/index.rst b/boards/nxp/frdm_kw41z/doc/index.rst index 4457b6d9b16..b1643939f8e 100644 --- a/boards/nxp/frdm_kw41z/doc/index.rst +++ b/boards/nxp/frdm_kw41z/doc/index.rst @@ -201,7 +201,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -219,7 +219,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_mcxa156/doc/index.rst b/boards/nxp/frdm_mcxa156/doc/index.rst index 96255473c2f..df622a40ddf 100644 --- a/boards/nxp/frdm_mcxa156/doc/index.rst +++ b/boards/nxp/frdm_mcxa156/doc/index.rst @@ -149,7 +149,7 @@ Connect a USB cable from your PC to J21, and use the serial terminal of your cho Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -167,7 +167,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_mcxc242/doc/index.rst b/boards/nxp/frdm_mcxc242/doc/index.rst index 4d5b0f89aaa..ecde1643da9 100644 --- a/boards/nxp/frdm_mcxc242/doc/index.rst +++ b/boards/nxp/frdm_mcxc242/doc/index.rst @@ -171,7 +171,7 @@ Connect a USB cable from your PC to J9, and use the serial terminal of your choi Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -189,7 +189,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_mcxn236/doc/index.rst b/boards/nxp/frdm_mcxn236/doc/index.rst index 0793d68e246..3ee20c5c1e8 100644 --- a/boards/nxp/frdm_mcxn236/doc/index.rst +++ b/boards/nxp/frdm_mcxn236/doc/index.rst @@ -156,7 +156,7 @@ Connect a USB cable from your PC to J10, and use the serial terminal of your cho Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -174,7 +174,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_mcxn947/doc/index.rst b/boards/nxp/frdm_mcxn947/doc/index.rst index 5febc07a861..1559dcea969 100644 --- a/boards/nxp/frdm_mcxn947/doc/index.rst +++ b/boards/nxp/frdm_mcxn947/doc/index.rst @@ -190,7 +190,7 @@ Connect a USB cable from your PC to J17, and use the serial terminal of your cho Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -208,7 +208,7 @@ see the following message in the terminal: Flashing to QSPI ================ -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :app: zephyr/samples/hello_world @@ -245,7 +245,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/frdm_rw612/doc/index.rst b/boards/nxp/frdm_rw612/doc/index.rst index f6aec208176..0044b09cb9c 100644 --- a/boards/nxp/frdm_rw612/doc/index.rst +++ b/boards/nxp/frdm_rw612/doc/index.rst @@ -102,7 +102,7 @@ Connect a USB cable from your PC to J10, and use the serial terminal of your cho Flashing ======== -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: @@ -121,7 +121,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: diff --git a/boards/nxp/hexiwear/doc/index.rst b/boards/nxp/hexiwear/doc/index.rst index bc4d58a70d4..6f47bddf00d 100644 --- a/boards/nxp/hexiwear/doc/index.rst +++ b/boards/nxp/hexiwear/doc/index.rst @@ -227,7 +227,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -245,7 +245,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -460,7 +460,7 @@ Once you have started a debug session, run telnet: Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -486,7 +486,7 @@ terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/imx8mm_evk/doc/index.rst b/boards/nxp/imx8mm_evk/doc/index.rst index e782798c159..d834726d0c1 100644 --- a/boards/nxp/imx8mm_evk/doc/index.rst +++ b/boards/nxp/imx8mm_evk/doc/index.rst @@ -222,7 +222,7 @@ MIMX8MM EVK board can be debugged by connecting an external JLink JTAG debugger to the J902 debug connector and to the PC. Then the application can be debugged using the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/imx8mp_evk/doc/index.rst b/boards/nxp/imx8mp_evk/doc/index.rst index 839288cf670..69a9b463b74 100644 --- a/boards/nxp/imx8mp_evk/doc/index.rst +++ b/boards/nxp/imx8mp_evk/doc/index.rst @@ -297,7 +297,7 @@ MIMX8MP EVK board can be debugged by connecting an external JLink JTAG debugger to the J24 debug connector and to the PC. Then the application can be debugged using the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/imx8mq_evk/doc/index.rst b/boards/nxp/imx8mq_evk/doc/index.rst index 40bd5ac5c50..8f21c6e9328 100644 --- a/boards/nxp/imx8mq_evk/doc/index.rst +++ b/boards/nxp/imx8mq_evk/doc/index.rst @@ -190,7 +190,7 @@ MIMX8MQ EVK board can be debugged by connecting an external JLink JTAG debugger to the J401 debug connector and to the PC. Then the application can be debugged using the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/imx95_evk/doc/index.rst b/boards/nxp/imx95_evk/doc/index.rst index e4664a282b7..3b7a69ceece 100644 --- a/boards/nxp/imx95_evk/doc/index.rst +++ b/boards/nxp/imx95_evk/doc/index.rst @@ -229,7 +229,7 @@ MCUXpresso SDK for IMX95LPD5EVK-19.pdf`` in i.MX95 `MCUX SDK release`_. See ``4.2 Run an example application``, just rename ``zephyr.bin`` to ``m7_image.bin`` to make flash.bin and program to SD/eMMC. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso51u68/doc/index.rst b/boards/nxp/lpcxpresso51u68/doc/index.rst index c1fff7e4d7b..491aa2beab1 100644 --- a/boards/nxp/lpcxpresso51u68/doc/index.rst +++ b/boards/nxp/lpcxpresso51u68/doc/index.rst @@ -133,7 +133,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -148,7 +148,7 @@ Here is an example for the :ref:`hello_world` application. Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso54114/doc/index.rst b/boards/nxp/lpcxpresso54114/doc/index.rst index 0402d19d239..df2e2aabf0d 100644 --- a/boards/nxp/lpcxpresso54114/doc/index.rst +++ b/boards/nxp/lpcxpresso54114/doc/index.rst @@ -166,7 +166,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -184,7 +184,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso55s06/doc/index.rst b/boards/nxp/lpcxpresso55s06/doc/index.rst index 01f7f6b539b..10a1b6728ca 100644 --- a/boards/nxp/lpcxpresso55s06/doc/index.rst +++ b/boards/nxp/lpcxpresso55s06/doc/index.rst @@ -156,7 +156,7 @@ settings: Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -174,7 +174,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso55s16/doc/index.rst b/boards/nxp/lpcxpresso55s16/doc/index.rst index f0d0c52bb00..8089e3de0ef 100644 --- a/boards/nxp/lpcxpresso55s16/doc/index.rst +++ b/boards/nxp/lpcxpresso55s16/doc/index.rst @@ -191,7 +191,7 @@ settings: Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -209,7 +209,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso55s28/doc/index.rst b/boards/nxp/lpcxpresso55s28/doc/index.rst index 1e97071456f..df40571a18b 100644 --- a/boards/nxp/lpcxpresso55s28/doc/index.rst +++ b/boards/nxp/lpcxpresso55s28/doc/index.rst @@ -164,7 +164,7 @@ choice (minicom, putty, etc.) with the following settings: Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -182,7 +182,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso55s36/doc/index.rst b/boards/nxp/lpcxpresso55s36/doc/index.rst index bff3ef5d36a..32c7993c3a3 100644 --- a/boards/nxp/lpcxpresso55s36/doc/index.rst +++ b/boards/nxp/lpcxpresso55s36/doc/index.rst @@ -195,7 +195,7 @@ settings: Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -213,7 +213,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/lpcxpresso55s69/doc/index.rst b/boards/nxp/lpcxpresso55s69/doc/index.rst index 4c157c9f5f0..85336fa2855 100644 --- a/boards/nxp/lpcxpresso55s69/doc/index.rst +++ b/boards/nxp/lpcxpresso55s69/doc/index.rst @@ -322,7 +322,7 @@ Connect a USB cable from your PC to P6, and use the serial terminal of your choi Flashing ======== -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: @@ -365,7 +365,7 @@ an example of building for both cores with sysbuild, see Debugging ========= -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: diff --git a/boards/nxp/mimxrt1010_evk/doc/index.rst b/boards/nxp/mimxrt1010_evk/doc/index.rst index c0d9670d06c..6422927371e 100644 --- a/boards/nxp/mimxrt1010_evk/doc/index.rst +++ b/boards/nxp/mimxrt1010_evk/doc/index.rst @@ -201,7 +201,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1015_evk/doc/index.rst b/boards/nxp/mimxrt1015_evk/doc/index.rst index fb81c2d8410..7e22bd4c554 100644 --- a/boards/nxp/mimxrt1015_evk/doc/index.rst +++ b/boards/nxp/mimxrt1015_evk/doc/index.rst @@ -203,7 +203,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1020_evk/doc/index.rst b/boards/nxp/mimxrt1020_evk/doc/index.rst index 5e3f240c70d..0057dcd58ab 100644 --- a/boards/nxp/mimxrt1020_evk/doc/index.rst +++ b/boards/nxp/mimxrt1020_evk/doc/index.rst @@ -261,7 +261,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -279,7 +279,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1024_evk/doc/index.rst b/boards/nxp/mimxrt1024_evk/doc/index.rst index 991c9c1ce6e..e451a027432 100644 --- a/boards/nxp/mimxrt1024_evk/doc/index.rst +++ b/boards/nxp/mimxrt1024_evk/doc/index.rst @@ -243,7 +243,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -261,7 +261,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1040_evk/doc/index.rst b/boards/nxp/mimxrt1040_evk/doc/index.rst index c6322960f24..fffd3873fa5 100644 --- a/boards/nxp/mimxrt1040_evk/doc/index.rst +++ b/boards/nxp/mimxrt1040_evk/doc/index.rst @@ -252,7 +252,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -270,7 +270,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1050_evk/doc/index.rst b/boards/nxp/mimxrt1050_evk/doc/index.rst index 8e283c0e0bf..19deec55f09 100644 --- a/boards/nxp/mimxrt1050_evk/doc/index.rst +++ b/boards/nxp/mimxrt1050_evk/doc/index.rst @@ -367,7 +367,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -385,7 +385,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1060_evk/doc/index.rst b/boards/nxp/mimxrt1060_evk/doc/index.rst index b7df78d597f..e17f57ee77f 100644 --- a/boards/nxp/mimxrt1060_evk/doc/index.rst +++ b/boards/nxp/mimxrt1060_evk/doc/index.rst @@ -378,7 +378,7 @@ SWO frequency of 7500KHz. Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -396,7 +396,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1062_fmurt6/doc/index.rst b/boards/nxp/mimxrt1062_fmurt6/doc/index.rst index edcd5bc5f11..e587a8c5087 100644 --- a/boards/nxp/mimxrt1062_fmurt6/doc/index.rst +++ b/boards/nxp/mimxrt1062_fmurt6/doc/index.rst @@ -303,7 +303,7 @@ SWO frequency of 7500KHz. Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -321,7 +321,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1064_evk/doc/index.rst b/boards/nxp/mimxrt1064_evk/doc/index.rst index fdd21841ca7..4f6fab6f0f6 100644 --- a/boards/nxp/mimxrt1064_evk/doc/index.rst +++ b/boards/nxp/mimxrt1064_evk/doc/index.rst @@ -373,7 +373,7 @@ SWO frequency of 7500KHz. Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -391,7 +391,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1160_evk/doc/index.rst b/boards/nxp/mimxrt1160_evk/doc/index.rst index 8cc8b7408de..5b8a110d1b0 100644 --- a/boards/nxp/mimxrt1160_evk/doc/index.rst +++ b/boards/nxp/mimxrt1160_evk/doc/index.rst @@ -314,7 +314,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Before power on the board, make sure SW1 is set to 0001b @@ -335,7 +335,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1170_evk/doc/index.rst b/boards/nxp/mimxrt1170_evk/doc/index.rst index c3de9f8fd3b..7500442bd1b 100644 --- a/boards/nxp/mimxrt1170_evk/doc/index.rst +++ b/boards/nxp/mimxrt1170_evk/doc/index.rst @@ -410,7 +410,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Before powering the board, make sure SW1 is set to 0001b @@ -431,7 +431,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt1180_evk/doc/index.rst b/boards/nxp/mimxrt1180_evk/doc/index.rst index 80926edc464..71066d77f3f 100644 --- a/boards/nxp/mimxrt1180_evk/doc/index.rst +++ b/boards/nxp/mimxrt1180_evk/doc/index.rst @@ -211,7 +211,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application on cm33 core. +Here is an example for the :zephyr:code-sample:`hello_world` application on cm33 core. Before power on the board, make sure SW5 is set to 0100b @@ -232,7 +232,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/mimxrt595_evk/doc/index.rst b/boards/nxp/mimxrt595_evk/doc/index.rst index 5be8e0da21c..5465a912e8b 100644 --- a/boards/nxp/mimxrt595_evk/doc/index.rst +++ b/boards/nxp/mimxrt595_evk/doc/index.rst @@ -244,7 +244,7 @@ Connect a USB cable from your PC to J40, and use the serial terminal of your cho Flashing ======== -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: @@ -263,7 +263,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: diff --git a/boards/nxp/mimxrt685_evk/doc/index.rst b/boards/nxp/mimxrt685_evk/doc/index.rst index 4e8f9d79f51..4f53d6435b5 100644 --- a/boards/nxp/mimxrt685_evk/doc/index.rst +++ b/boards/nxp/mimxrt685_evk/doc/index.rst @@ -285,7 +285,7 @@ Connect a USB cable from your PC to J16, and use the serial terminal of your cho Flashing ======== -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`linkserver-debug-host-tools` as default. .. zephyr-app-commands:: @@ -304,7 +304,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`linkserver-debug-host-tools` as default. .. zephyr-app-commands:: diff --git a/boards/nxp/rd_rw612_bga/doc/index.rst b/boards/nxp/rd_rw612_bga/doc/index.rst index 558effd60a3..e0215ececad 100644 --- a/boards/nxp/rd_rw612_bga/doc/index.rst +++ b/boards/nxp/rd_rw612_bga/doc/index.rst @@ -111,7 +111,7 @@ Connect a USB cable from your PC to J7, and use the serial terminal of your choi Flashing ======== -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: @@ -130,7 +130,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. This example uses the +Here is an example for the :zephyr:code-sample:`hello_world` application. This example uses the :ref:`jlink-debug-host-tools` as default. .. zephyr-app-commands:: diff --git a/boards/nxp/rddrone_fmuk66/doc/index.rst b/boards/nxp/rddrone_fmuk66/doc/index.rst index 69d862455ac..e938c685ba7 100644 --- a/boards/nxp/rddrone_fmuk66/doc/index.rst +++ b/boards/nxp/rddrone_fmuk66/doc/index.rst @@ -144,7 +144,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -162,7 +162,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/s32z2xxdc2/doc/index.rst b/boards/nxp/s32z2xxdc2/doc/index.rst index 58e5ea3660c..d864059de00 100644 --- a/boards/nxp/s32z2xxdc2/doc/index.rst +++ b/boards/nxp/s32z2xxdc2/doc/index.rst @@ -200,7 +200,7 @@ under Linux, ``/dev/ttyUSB0``. Debugging ========= -You can build and debug the :ref:`hello_world` sample for the board +You can build and debug the :zephyr:code-sample:`hello_world` sample for the board ``s32z2xxdc2/s32z270/rtu0`` with: .. zephyr-app-commands:: @@ -296,7 +296,7 @@ Where: - ```` is the zero-based core index relative to the RTU on which to run the Zephyr application (0, 1, 2 or 3) -For example, to build the :ref:`hello_world` sample for the board +For example, to build the :zephyr:code-sample:`hello_world` sample for the board ``s32z2xxdc2/s32z270/rtu0`` with split-lock core configuration: .. zephyr-app-commands:: diff --git a/boards/nxp/twr_ke18f/doc/index.rst b/boards/nxp/twr_ke18f/doc/index.rst index a72227beb67..4d91e6e3352 100644 --- a/boards/nxp/twr_ke18f/doc/index.rst +++ b/boards/nxp/twr_ke18f/doc/index.rst @@ -193,7 +193,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -211,7 +211,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/twr_kv58f220m/doc/index.rst b/boards/nxp/twr_kv58f220m/doc/index.rst index 98cc3a880af..f9adc60064a 100644 --- a/boards/nxp/twr_kv58f220m/doc/index.rst +++ b/boards/nxp/twr_kv58f220m/doc/index.rst @@ -148,7 +148,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -166,7 +166,7 @@ see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/usb_kw24d512/doc/index.rst b/boards/nxp/usb_kw24d512/doc/index.rst index b617edcf6d6..37bbb88726d 100644 --- a/boards/nxp/usb_kw24d512/doc/index.rst +++ b/boards/nxp/usb_kw24d512/doc/index.rst @@ -170,7 +170,7 @@ Once you have started a debug session, run telnet: Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -196,7 +196,7 @@ terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/nxp/vmu_rt1170/doc/index.rst b/boards/nxp/vmu_rt1170/doc/index.rst index fa0327c0a9f..4ad7bad0c17 100644 --- a/boards/nxp/vmu_rt1170/doc/index.rst +++ b/boards/nxp/vmu_rt1170/doc/index.rst @@ -507,7 +507,7 @@ etc.): Flashing ======== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -524,7 +524,7 @@ You should see the following message in the terminal: Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/olimex/olimex_esp32_evb/doc/index.rst b/boards/olimex/olimex_esp32_evb/doc/index.rst index f904861af22..5af913a1273 100644 --- a/boards/olimex/olimex_esp32_evb/doc/index.rst +++ b/boards/olimex/olimex_esp32_evb/doc/index.rst @@ -205,7 +205,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``olimex_esp32_evb`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -238,7 +238,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -246,7 +246,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/olimex/stm32_e407/doc/index.rst b/boards/olimex/stm32_e407/doc/index.rst index 6abdc3b564c..6af85cf75e0 100644 --- a/boards/olimex/stm32_e407/doc/index.rst +++ b/boards/olimex/stm32_e407/doc/index.rst @@ -336,7 +336,7 @@ Flashing an application to the Olimex-STM32-E407 Connect the ST-Link USB dongle to your host computer and to the JTAG port of the OLIMEX-STM32-E407 board. Then build and flash an application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -360,7 +360,7 @@ Debugging ========= Provided that you have a JTAG probe, you can debug an application in the usual -way. Here is an example for the :ref:`hello_world` application. +way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/olimex/stm32_h103/doc/index.rst b/boards/olimex/stm32_h103/doc/index.rst index 3abfb3b8885..291b34bfc34 100644 --- a/boards/olimex/stm32_h103/doc/index.rst +++ b/boards/olimex/stm32_h103/doc/index.rst @@ -219,7 +219,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/olimex/stm32_h405/doc/index.rst b/boards/olimex/stm32_h405/doc/index.rst index ab051345b9c..ff3c8b2bf46 100644 --- a/boards/olimex/stm32_h405/doc/index.rst +++ b/boards/olimex/stm32_h405/doc/index.rst @@ -171,7 +171,7 @@ In the following examples a ST-Link V2 USB dongle is used. Flashing an application to the Olimex-STM32-H405 ================================================ -The sample application :ref:`hello_world` is being used in this tutorial. +The sample application :zephyr:code-sample:`hello_world` is being used in this tutorial. Connect the ST-Link USB dongle to your host computer and to the JTAG port of the OLIMEX-STM32-H405 board. @@ -201,7 +201,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/olimex/stm32_h407/doc/index.rst b/boards/olimex/stm32_h407/doc/index.rst index 3555ed52a35..114543e27cf 100644 --- a/boards/olimex/stm32_h407/doc/index.rst +++ b/boards/olimex/stm32_h407/doc/index.rst @@ -332,7 +332,7 @@ Flashing an application to the Olimex-STM32-H407 Connect the ARM-USB-OCD-H debugger to your host computer and to the JTAG port of the OLIMEX-STM32-H407 board. Then build and flash an application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -357,7 +357,7 @@ Debugging ========= Provided that you have a JTAG probe, you can debug an application in the usual -way. Here is an example for the :ref:`hello_world` application. +way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/olimex/stm32_p405/doc/index.rst b/boards/olimex/stm32_p405/doc/index.rst index e68bcb589ca..c754213c954 100644 --- a/boards/olimex/stm32_p405/doc/index.rst +++ b/boards/olimex/stm32_p405/doc/index.rst @@ -216,7 +216,7 @@ In the following examples a ST-Link V2 USB dongle is used. Flashing an application to the Olimex-STM32-P405 ================================================ -The sample application :ref:`hello_world` is being used in this tutorial. +The sample application :zephyr:code-sample:`hello_world` is being used in this tutorial. Connect the ST-Link USB dongle to your host computer and to the JTAG port of the OLIMEX-STM32-P405 board. @@ -245,7 +245,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/openisa/rv32m1_vega/doc/index.rst b/boards/openisa/rv32m1_vega/doc/index.rst index 339b8dc5e0c..92d9e999752 100644 --- a/boards/openisa/rv32m1_vega/doc/index.rst +++ b/boards/openisa/rv32m1_vega/doc/index.rst @@ -577,7 +577,7 @@ toolchain and OpenOCD:: The above only sets these variables for your current shell session. You need to make sure this happens every time you use this board. -Now let's compile the :ref:`hello_world` application. (You can try +Now let's compile the :zephyr:code-sample:`hello_world` application. (You can try others as well; see :ref:`samples-and-demos` for more.) .. We can't use zephyr-app-commands to provide build instructions diff --git a/boards/others/black_f407ve/doc/index.rst b/boards/others/black_f407ve/doc/index.rst index a338e7ccf4b..cffdd4d41be 100644 --- a/boards/others/black_f407ve/doc/index.rst +++ b/boards/others/black_f407ve/doc/index.rst @@ -222,7 +222,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/others/black_f407zg_pro/doc/index.rst b/boards/others/black_f407zg_pro/doc/index.rst index 1ca764cdf1d..4857e8bb8da 100644 --- a/boards/others/black_f407zg_pro/doc/index.rst +++ b/boards/others/black_f407zg_pro/doc/index.rst @@ -204,7 +204,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/others/icev_wireless/doc/index.rst b/boards/others/icev_wireless/doc/index.rst index 32598b6e53f..5b56cd94c3d 100644 --- a/boards/others/icev_wireless/doc/index.rst +++ b/boards/others/icev_wireless/doc/index.rst @@ -224,7 +224,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -233,7 +233,7 @@ Here is an example for building the :ref:`hello_world` application. :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/others/neorv32/doc/index.rst b/boards/others/neorv32/doc/index.rst index 6626c24d0d0..a2dedba0a76 100644 --- a/boards/others/neorv32/doc/index.rst +++ b/boards/others/neorv32/doc/index.rst @@ -121,7 +121,7 @@ etc.): Flashing via JTAG ================= -Here is an example for building and flashing the :ref:`hello_world` application +Here is an example for building and flashing the :zephyr:code-sample:`hello_world` application for the NEORV32 via JTAG. Flashing via JTAG requires a NEORV32 SoC implementation with the On-Chip Debugger (OCD) and bootloader enabled. @@ -185,7 +185,7 @@ built-in bootloader as described in the NEORV32 user guide. Debugging via JTAG ================== -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/others/stm32_min_dev/doc/index.rst b/boards/others/stm32_min_dev/doc/index.rst index 61caf674f95..e27ea5c59f5 100644 --- a/boards/others/stm32_min_dev/doc/index.rst +++ b/boards/others/stm32_min_dev/doc/index.rst @@ -172,7 +172,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/particle/argon/doc/index.rst b/boards/particle/argon/doc/index.rst index 2bbb15a546f..0cfedf946db 100644 --- a/boards/particle/argon/doc/index.rst +++ b/boards/particle/argon/doc/index.rst @@ -145,7 +145,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/particle/boron/doc/index.rst b/boards/particle/boron/doc/index.rst index d5b7ce1f5d0..da87b144a0d 100644 --- a/boards/particle/boron/doc/index.rst +++ b/boards/particle/boron/doc/index.rst @@ -141,7 +141,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/particle/nrf51_blenano/doc/index.rst b/boards/particle/nrf51_blenano/doc/index.rst index 4caae408e21..1d6d2ea4a2a 100644 --- a/boards/particle/nrf51_blenano/doc/index.rst +++ b/boards/particle/nrf51_blenano/doc/index.rst @@ -79,7 +79,7 @@ DAPLink board, then attach that to your computer via USB. properly solder headers and assemble the DAPLink and BLE Nano boards. Now build and flash applications as usual. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -91,7 +91,7 @@ Debugging After mounting the BLE Nano on its DAPLink board as described above, you can debug an application in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/particle/nrf52_blenano2/doc/index.rst b/boards/particle/nrf52_blenano2/doc/index.rst index 6c32b4f3d77..b2d0824bfc1 100644 --- a/boards/particle/nrf52_blenano2/doc/index.rst +++ b/boards/particle/nrf52_blenano2/doc/index.rst @@ -77,7 +77,7 @@ DAPLink board, then attach that to your computer via USB. connector. Now build and flash applications as usual. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -89,7 +89,7 @@ Debugging After mounting the BLE Nano 2 on its DAPLink board as described above, you can debug an application in the usual way. Here is an example for -the :ref:`hello_world` application. +the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/particle/xenon/doc/index.rst b/boards/particle/xenon/doc/index.rst index cf18340943a..d28b8aac1c0 100644 --- a/boards/particle/xenon/doc/index.rst +++ b/boards/particle/xenon/doc/index.rst @@ -146,7 +146,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/phytec/mimx8mp_phyboard_pollux/doc/index.rst b/boards/phytec/mimx8mp_phyboard_pollux/doc/index.rst index b9643a359e3..6314b716513 100644 --- a/boards/phytec/mimx8mp_phyboard_pollux/doc/index.rst +++ b/boards/phytec/mimx8mp_phyboard_pollux/doc/index.rst @@ -215,7 +215,7 @@ the M7 core has to be switched on: u-boot=> bootaux 0x7e0000 -Here is an example for the :ref:`hello_world` application: +Here is an example for the :zephyr:code-sample:`hello_world` application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/phytec/phyboard_electra/doc/index.rst b/boards/phytec/phyboard_electra/doc/index.rst index 372f8d3cd73..9af3400555d 100644 --- a/boards/phytec/phyboard_electra/doc/index.rst +++ b/boards/phytec/phyboard_electra/doc/index.rst @@ -104,7 +104,7 @@ The Linux running on the A53 uses the remoteproc framework to manage the M4F co- Therefore, the testing requires the binary to be copied to the SD card to allow the A53 cores to load it while booting using remoteproc. -To test the M4F core, we build the :ref:`hello_world` sample with the following command. +To test the M4F core, we build the :zephyr:code-sample:`hello_world` sample with the following command. .. zephyr-app-commands:: :board: phyboard_electra/am6442/m4 diff --git a/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_a53.rst b/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_a53.rst index 410debfd9b7..9b6d2f42a3d 100644 --- a/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_a53.rst +++ b/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_a53.rst @@ -80,7 +80,7 @@ Building You can build an application in the usual way. Refer to :ref:`build_an_application` for more details. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :board: phyboard_lyra/am6234/a53 diff --git a/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_m4.rst b/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_m4.rst index 55d4939529f..d0f61264890 100644 --- a/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_m4.rst +++ b/boards/phytec/phyboard_lyra/doc/phyboard_lyra_am62xx_m4.rst @@ -96,7 +96,7 @@ The Linux running on the A53 uses the remoteproc framework to manage the M4F co- Therefore, the testing requires the binary to be copied to the SD card to allow the A53 cores to load it while booting using remoteproc. -To test the M4F core, we build the :ref:`hello_world` sample with the following command. +To test the M4F core, we build the :zephyr:code-sample:`hello_world` sample with the following command. .. code-block:: console diff --git a/boards/phytec/reel_board/doc/index.rst b/boards/phytec/reel_board/doc/index.rst index 79001a009e5..d468a6c559a 100644 --- a/boards/phytec/reel_board/doc/index.rst +++ b/boards/phytec/reel_board/doc/index.rst @@ -497,7 +497,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -528,7 +528,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/qorvo/decawave_dwm1001_dev/doc/index.rst b/boards/qorvo/decawave_dwm1001_dev/doc/index.rst index 4699de8c381..93966edb739 100644 --- a/boards/qorvo/decawave_dwm1001_dev/doc/index.rst +++ b/boards/qorvo/decawave_dwm1001_dev/doc/index.rst @@ -31,7 +31,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/rak/rak11720/doc/index.rst b/boards/rak/rak11720/doc/index.rst index ff8e90a962b..238ba6d8303 100644 --- a/boards/rak/rak11720/doc/index.rst +++ b/boards/rak/rak11720/doc/index.rst @@ -83,7 +83,7 @@ Flashing an application ----------------------- Connect your device to your host computer using the JLINK USB port. -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application, then flash it to the device: .. zephyr-app-commands:: diff --git a/boards/rak/rak4631/doc/index.rst b/boards/rak/rak4631/doc/index.rst index ffa39ca8265..14c6c912976 100644 --- a/boards/rak/rak4631/doc/index.rst +++ b/boards/rak/rak4631/doc/index.rst @@ -121,7 +121,7 @@ Flashing - Stop bits: 1 #. Connect the RAK4631 board to your host computer using the USB debug port. - Then build and flash the :ref:`hello_world` application. + Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -134,7 +134,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/rak/rak5010/doc/index.rst b/boards/rak/rak5010/doc/index.rst index fac00cf72df..851d8924842 100644 --- a/boards/rak/rak5010/doc/index.rst +++ b/boards/rak/rak5010/doc/index.rst @@ -126,7 +126,7 @@ Flashing - Stop bits: 1 #. Connect the RAK5010 board to your host computer using the USB debug port. - Then build and flash the :ref:`hello_world` application. + Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -139,7 +139,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/raspberrypi/rpi_5/doc/index.rst b/boards/raspberrypi/rpi_5/doc/index.rst index 1c63e5a94ad..fd0ad27df0a 100644 --- a/boards/raspberrypi/rpi_5/doc/index.rst +++ b/boards/raspberrypi/rpi_5/doc/index.rst @@ -126,7 +126,7 @@ config.txt zephyr.bin ---------- -Build an app, for example :ref:`hello_world`: +Build an app, for example :zephyr:code-sample:`hello_world`: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/raytac/mdbt50q_db_33/doc/index.rst b/boards/raytac/mdbt50q_db_33/doc/index.rst index b078dd2984e..8089b7b5e48 100644 --- a/boards/raytac/mdbt50q_db_33/doc/index.rst +++ b/boards/raytac/mdbt50q_db_33/doc/index.rst @@ -147,7 +147,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Use a USB to TTL converter to connect the computer and raytac_mdbt50q_db_33/nrf52833 J10 connector. Then run your favorite terminal program to listen for output. diff --git a/boards/raytac/mdbt50q_db_40/doc/index.rst b/boards/raytac/mdbt50q_db_40/doc/index.rst index f9d79818f6a..269b42bb9d5 100644 --- a/boards/raytac/mdbt50q_db_40/doc/index.rst +++ b/boards/raytac/mdbt50q_db_40/doc/index.rst @@ -149,7 +149,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Use a USB to TTL converter to connect the computer and raytac_mdbt50q_db_40/nrf52840 J10 connector. Then run your favorite terminal program to listen for output. diff --git a/boards/raytac/mdbt53_db_40/doc/index.rst b/boards/raytac/mdbt53_db_40/doc/index.rst index a57fc5225dc..9ddb5b77c5d 100644 --- a/boards/raytac/mdbt53_db_40/doc/index.rst +++ b/boards/raytac/mdbt53_db_40/doc/index.rst @@ -225,7 +225,7 @@ applications as usual (see :ref:`build_an_application` and If you are flashing with :ref:`west `, run this command for more details on the related ``--recover`` option: -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Use a USB to TTL converter to connect the computer and raytac_mdbt53_db_40_nrf5340 J10 connector. Then run your favorite terminal program to listen for output. diff --git a/boards/raytac/mdbt53v_db_40/doc/index.rst b/boards/raytac/mdbt53v_db_40/doc/index.rst index ca38f03a781..27a2aeee345 100644 --- a/boards/raytac/mdbt53v_db_40/doc/index.rst +++ b/boards/raytac/mdbt53v_db_40/doc/index.rst @@ -218,7 +218,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Use a USB to TTL converter to connect the computer and raytac_mdbt53v_db_40_nrf5340 J13 connector pin 8(RX), 9(TX) and GND. Then run your favorite terminal program to listen for output. diff --git a/boards/renesas/rcar_h3ulcb/doc/rcar_h3ulcb_r7.rst b/boards/renesas/rcar_h3ulcb/doc/rcar_h3ulcb_r7.rst index 5fcd4fa0909..f77c16196fa 100644 --- a/boards/renesas/rcar_h3ulcb/doc/rcar_h3ulcb_r7.rst +++ b/boards/renesas/rcar_h3ulcb/doc/rcar_h3ulcb_r7.rst @@ -224,7 +224,7 @@ Debugging First of all, open your serial terminal. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/renesas/rcar_salvator_x/doc/rcar_salvator_x.rst b/boards/renesas/rcar_salvator_x/doc/rcar_salvator_x.rst index e95049a42c4..3e7b5772944 100644 --- a/boards/renesas/rcar_salvator_x/doc/rcar_salvator_x.rst +++ b/boards/renesas/rcar_salvator_x/doc/rcar_salvator_x.rst @@ -147,7 +147,7 @@ Debugging First of all, open your serial terminal. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/renesas/rcar_spider_s4/doc/rcar_spider_a55.rst b/boards/renesas/rcar_spider_s4/doc/rcar_spider_a55.rst index 2f45cf1521e..b66975af164 100644 --- a/boards/renesas/rcar_spider_s4/doc/rcar_spider_a55.rst +++ b/boards/renesas/rcar_spider_s4/doc/rcar_spider_a55.rst @@ -63,7 +63,7 @@ One of the ways to load Zephyr is shown below. tftp 0x48000000 booti 0x48000000 -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/renesas/rcar_spider_s4/doc/rcar_spider_r52.rst b/boards/renesas/rcar_spider_s4/doc/rcar_spider_r52.rst index d7fec18e036..9c7be4d8f99 100644 --- a/boards/renesas/rcar_spider_s4/doc/rcar_spider_r52.rst +++ b/boards/renesas/rcar_spider_s4/doc/rcar_spider_r52.rst @@ -161,7 +161,7 @@ Debugging First of all, open your serial terminal. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/sc/scobc_module1/doc/index.rst b/boards/sc/scobc_module1/doc/index.rst index fd6f82e0b8e..260a062692f 100644 --- a/boards/sc/scobc_module1/doc/index.rst +++ b/boards/sc/scobc_module1/doc/index.rst @@ -73,7 +73,7 @@ Flashing Here is an example for building and flashing the \`hello\_world\` application for the board: -Here is an example for building and flashing the :ref:`hello_world` application +Here is an example for building and flashing the :zephyr:code-sample:`hello_world` application for the default design: .. zephyr-app-commands:: @@ -94,7 +94,7 @@ above steps. It was merely written to internal RAM in the FPGA. Debugging ========= -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/seco/stm32f3_seco_d23/doc/index.rst b/boards/seco/stm32f3_seco_d23/doc/index.rst index 17be6bcd6f8..bc2626767f0 100644 --- a/boards/seco/stm32f3_seco_d23/doc/index.rst +++ b/boards/seco/stm32f3_seco_d23/doc/index.rst @@ -208,7 +208,7 @@ The pinout is (1-8): Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst b/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst index 8d96f1e5347..ca234210734 100644 --- a/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst +++ b/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst @@ -242,7 +242,7 @@ Flashing an application to LoRa-E5 Dev board Connect the LoRa-E5 to your host computer using the external debug probe. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your board: Per default the console on ``usart1`` is available on the USB Type C connector diff --git a/boards/seeed/lora_e5_mini/doc/index.rst b/boards/seeed/lora_e5_mini/doc/index.rst index 7f36a92e7d6..78227fcb62b 100644 --- a/boards/seeed/lora_e5_mini/doc/index.rst +++ b/boards/seeed/lora_e5_mini/doc/index.rst @@ -178,7 +178,7 @@ Flashing an application to LoRa-E5 mini Connect the LoRa-E5 to your host computer using the external debug probe. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your board: Per default the console on ``usart1`` is available on the USB Type C connector diff --git a/boards/seeed/seeeduino_xiao/doc/index.rst b/boards/seeed/seeeduino_xiao/doc/index.rst index aa11b812c38..8f3614918f6 100644 --- a/boards/seeed/seeeduino_xiao/doc/index.rst +++ b/boards/seeed/seeeduino_xiao/doc/index.rst @@ -120,7 +120,7 @@ will be entered automatically when you run :code:`west flash`. Flashing ======== -#. Build the Zephyr kernel and the :ref:`hello_world` sample application: +#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/seeed/xiao_ble/doc/index.rst b/boards/seeed/xiao_ble/doc/index.rst index d91729dccd6..c33d786e024 100644 --- a/boards/seeed/xiao_ble/doc/index.rst +++ b/boards/seeed/xiao_ble/doc/index.rst @@ -117,7 +117,7 @@ BlackMagic Probe). Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/seeed/xiao_esp32c3/doc/index.rst b/boards/seeed/xiao_esp32c3/doc/index.rst index e8346632b96..48ce9ddae0d 100644 --- a/boards/seeed/xiao_esp32c3/doc/index.rst +++ b/boards/seeed/xiao_esp32c3/doc/index.rst @@ -198,7 +198,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t ``-DOPENOCD= -DOPENOCD_DEFAULT_PATH=`` parameter when building. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -206,7 +206,7 @@ Here is an example for building the :ref:`hello_world` application. :goals: build flash :gen-args: -DOPENOCD= -DOPENOCD_DEFAULT_PATH= -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/seeed/xiao_esp32s3/doc/index.rst b/boards/seeed/xiao_esp32s3/doc/index.rst index 7f830f65340..4c029bd5d64 100644 --- a/boards/seeed/xiao_esp32s3/doc/index.rst +++ b/boards/seeed/xiao_esp32s3/doc/index.rst @@ -189,7 +189,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``xiao_esp32s3`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -220,14 +220,14 @@ ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additiona Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S3`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: xiao_esp32s3/esp32/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/dev_kits/sim3u1xx_dk/doc/index.rst b/boards/silabs/dev_kits/sim3u1xx_dk/doc/index.rst index 14d176bd356..67284c4b782 100644 --- a/boards/silabs/dev_kits/sim3u1xx_dk/doc/index.rst +++ b/boards/silabs/dev_kits/sim3u1xx_dk/doc/index.rst @@ -98,7 +98,7 @@ Programming and Debugging Flashing ======== -The sample application :ref:`hello_world` is used for this example. Build the Zephyr kernel and +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/dev_kits/sltb004a/doc/index.rst b/boards/silabs/dev_kits/sltb004a/doc/index.rst index 8ee2b64604d..e11145365fb 100644 --- a/boards/silabs/dev_kits/sltb004a/doc/index.rst +++ b/boards/silabs/dev_kits/sltb004a/doc/index.rst @@ -165,7 +165,7 @@ board. The adaptor provides: Flashing an application to SLTB004A ----------------------------------- -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/dev_kits/sltb009a/doc/index.rst b/boards/silabs/dev_kits/sltb009a/doc/index.rst index 2ec7a83f325..9366a7d2649 100644 --- a/boards/silabs/dev_kits/sltb009a/doc/index.rst +++ b/boards/silabs/dev_kits/sltb009a/doc/index.rst @@ -126,7 +126,7 @@ Flashing an application to SLTB009A Connect the SLTB009A to your host computer using the USB port. -Here is an example to build and flash the :ref:`hello_world` application. +Here is an example to build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/dev_kits/sltb010a/doc/index.rst b/boards/silabs/dev_kits/sltb010a/doc/index.rst index bbca08c762c..a335924359f 100644 --- a/boards/silabs/dev_kits/sltb010a/doc/index.rst +++ b/boards/silabs/dev_kits/sltb010a/doc/index.rst @@ -131,7 +131,7 @@ Flashing an application ----------------------- Connect your device to your host computer using the USB port. -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application, then flash it to the device: BRD4184A: diff --git a/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst b/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst index c5ec0f6a683..069b1d8923f 100644 --- a/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst +++ b/boards/silabs/dev_kits/xg24_dk2601b/doc/index.rst @@ -124,7 +124,7 @@ Programming and Debugging Flashing ======== -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/dev_kits/xg27_dk2602a/doc/index.rst b/boards/silabs/dev_kits/xg27_dk2602a/doc/index.rst index abaafbf0d2a..273b78e60ba 100644 --- a/boards/silabs/dev_kits/xg27_dk2602a/doc/index.rst +++ b/boards/silabs/dev_kits/xg27_dk2602a/doc/index.rst @@ -105,7 +105,7 @@ Commander in unattended mode and passes all the necessary arguments to it. Programming and Debugging ========================= -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/radio_boards/slwrb4104a/doc/index.rst b/boards/silabs/radio_boards/slwrb4104a/doc/index.rst index 6522489e79a..3496421743c 100644 --- a/boards/silabs/radio_boards/slwrb4104a/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4104a/doc/index.rst @@ -128,7 +128,7 @@ Flashing Connect the BRD4001A board with a mounted BRD4104A radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/slwrb4161a/doc/index.rst b/boards/silabs/radio_boards/slwrb4161a/doc/index.rst index 1f09e7d551c..927e27c20ae 100644 --- a/boards/silabs/radio_boards/slwrb4161a/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4161a/doc/index.rst @@ -122,7 +122,7 @@ Flashing Connect the BRD4001A board with a mounted BRD4161A radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/slwrb4170a/doc/index.rst b/boards/silabs/radio_boards/slwrb4170a/doc/index.rst index b6a29d13ad1..ccc2b7248ea 100644 --- a/boards/silabs/radio_boards/slwrb4170a/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4170a/doc/index.rst @@ -122,7 +122,7 @@ Flashing Connect the BRD4001A board with a mounted BRD4170A radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/slwrb4180a/doc/index.rst b/boards/silabs/radio_boards/slwrb4180a/doc/index.rst index 01864a54b1b..057e8ec9b00 100644 --- a/boards/silabs/radio_boards/slwrb4180a/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4180a/doc/index.rst @@ -119,7 +119,7 @@ Flashing Connect the BRD4001A board with a mounted BRD4180A radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/slwrb4250b/doc/index.rst b/boards/silabs/radio_boards/slwrb4250b/doc/index.rst index 59a38cf26f8..7a865b5b573 100644 --- a/boards/silabs/radio_boards/slwrb4250b/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4250b/doc/index.rst @@ -126,7 +126,7 @@ Flashing Connect the BRD4001A board with a mounted BRD4250B radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/slwrb4255a/doc/index.rst b/boards/silabs/radio_boards/slwrb4255a/doc/index.rst index d7e303c1326..43dd6e65aad 100644 --- a/boards/silabs/radio_boards/slwrb4255a/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4255a/doc/index.rst @@ -122,7 +122,7 @@ Flashing Connect the BRD4001A board with a mounted BRD4255A radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/slwrb4321a/doc/index.rst b/boards/silabs/radio_boards/slwrb4321a/doc/index.rst index 1170205e1b8..50ec07b7f79 100644 --- a/boards/silabs/radio_boards/slwrb4321a/doc/index.rst +++ b/boards/silabs/radio_boards/slwrb4321a/doc/index.rst @@ -137,7 +137,7 @@ Flashing an application to SLWSTK6121A Connect the SLWSTK6121A to your host computer using the USB port. -Here is an example to build and flash the :ref:`hello_world` application. +Here is an example to build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/radio_boards/xg24_rb4187c/doc/index.rst b/boards/silabs/radio_boards/xg24_rb4187c/doc/index.rst index 5100a4bf045..82da55861ce 100644 --- a/boards/silabs/radio_boards/xg24_rb4187c/doc/index.rst +++ b/boards/silabs/radio_boards/xg24_rb4187c/doc/index.rst @@ -120,7 +120,7 @@ Flashing Connect the BRD4002A board with a mounted BRD4187C radio module to your host computer using the USB port. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/silabs/starter_kits/efm32wg_stk3800/doc/index.rst b/boards/silabs/starter_kits/efm32wg_stk3800/doc/index.rst index 139d89379b0..0c04b7b21de 100644 --- a/boards/silabs/starter_kits/efm32wg_stk3800/doc/index.rst +++ b/boards/silabs/starter_kits/efm32wg_stk3800/doc/index.rst @@ -125,7 +125,7 @@ board. The adaptor provides: Flashing an application to EFM32-STK3800 ---------------------------------------- -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/starter_kits/slstk3400a/doc/index.rst b/boards/silabs/starter_kits/slstk3400a/doc/index.rst index a48cc3f65fa..7f3f919643b 100644 --- a/boards/silabs/starter_kits/slstk3400a/doc/index.rst +++ b/boards/silabs/starter_kits/slstk3400a/doc/index.rst @@ -125,7 +125,7 @@ board. The adaptor provides: Flashing an application to EFM32-SLSTK3400A ------------------------------------------- -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/starter_kits/slstk3401a/doc/index.rst b/boards/silabs/starter_kits/slstk3401a/doc/index.rst index 2de4948e217..d1e41ade626 100644 --- a/boards/silabs/starter_kits/slstk3401a/doc/index.rst +++ b/boards/silabs/starter_kits/slstk3401a/doc/index.rst @@ -136,7 +136,7 @@ board. The adaptor provides: Flashing an application to SLSTK3401A ------------------------------------- -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/starter_kits/slstk3402a/doc/index.rst b/boards/silabs/starter_kits/slstk3402a/doc/index.rst index 8d6193e85cd..4e5293ee08f 100644 --- a/boards/silabs/starter_kits/slstk3402a/doc/index.rst +++ b/boards/silabs/starter_kits/slstk3402a/doc/index.rst @@ -159,7 +159,7 @@ board. The adaptor provides: Flashing an application to SLSTK3402A ------------------------------------- -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/silabs/starter_kits/slstk3701a/doc/index.rst b/boards/silabs/starter_kits/slstk3701a/doc/index.rst index d270bf346c2..6209984049e 100644 --- a/boards/silabs/starter_kits/slstk3701a/doc/index.rst +++ b/boards/silabs/starter_kits/slstk3701a/doc/index.rst @@ -148,7 +148,7 @@ board. The adaptor provides: Flashing an application to SLSTK3701A ------------------------------------- -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/snps/em_starterkit/doc/index.rst b/boards/snps/em_starterkit/doc/index.rst index 4390ab2e4c6..e569031e378 100644 --- a/boards/snps/em_starterkit/doc/index.rst +++ b/boards/snps/em_starterkit/doc/index.rst @@ -173,7 +173,7 @@ Building Sample Applications ============================== You can try many of the sample applications or tests, but let us discuss -the one called :ref:`hello_world`. +the one called :zephyr:code-sample:`hello_world`. It is found in :zephyr_file:`samples/hello_world`. Configuring @@ -201,7 +201,7 @@ Building You can build application in the usual way. Refer to :ref:`build_an_application` for more details. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :board: em_starterkit diff --git a/boards/snps/emsdp/doc/index.rst b/boards/snps/emsdp/doc/index.rst index fa4606d98f8..bad8a48e4bb 100644 --- a/boards/snps/emsdp/doc/index.rst +++ b/boards/snps/emsdp/doc/index.rst @@ -161,7 +161,7 @@ Building Sample Applications ============================== You can try many of the sample applications or tests, but let us discuss -the one called :ref:`hello_world`. +the one called :zephyr:code-sample:`hello_world`. It is found in :zephyr_file:`samples/hello_world`. Configuring @@ -184,7 +184,7 @@ Building You can build an application in the usual way. Refer to :ref:`build_an_application` for more details. Here is an example for -:ref:`hello_world` for the em4. +:zephyr:code-sample:`hello_world` for the em4. .. zephyr-app-commands:: :board: emsdp/emsdp_em4 diff --git a/boards/snps/hsdk/doc/index.rst b/boards/snps/hsdk/doc/index.rst index 5d5fb1aa521..a7165a27658 100644 --- a/boards/snps/hsdk/doc/index.rst +++ b/boards/snps/hsdk/doc/index.rst @@ -388,7 +388,7 @@ Building Sample Applications ============================== You can try many of the :ref:`sample applications and demos -`. We'll use :ref:`hello_world`, found in +`. We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an example. Configuring @@ -410,7 +410,7 @@ Building You can build an application in the usual way. Refer to :ref:`build_an_application` for more details. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :board: hsdk diff --git a/boards/snps/hsdk4xd/doc/index.rst b/boards/snps/hsdk4xd/doc/index.rst index b373f22cee3..a5cfd534c00 100644 --- a/boards/snps/hsdk4xd/doc/index.rst +++ b/boards/snps/hsdk4xd/doc/index.rst @@ -385,7 +385,7 @@ Building Sample Applications ============================== You can try many of the :ref:`sample applications and demos -`. We'll use :ref:`hello_world`, found in +`. We'll use :zephyr:code-sample:`hello_world`, found in :zephyr_file:`samples/hello_world` as an example. Configuring @@ -407,7 +407,7 @@ Building You can build an application in the usual way. Refer to :ref:`build_an_application` for more details. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :board: hsdk4xd diff --git a/boards/snps/iotdk/doc/index.rst b/boards/snps/iotdk/doc/index.rst index 8057e851b66..5482bed17d9 100644 --- a/boards/snps/iotdk/doc/index.rst +++ b/boards/snps/iotdk/doc/index.rst @@ -68,7 +68,7 @@ Building Sample Applications ============================== You can try many of the sample applications or tests, but let us discuss -the one called :ref:`hello_world`. +the one called :zephyr:code-sample:`hello_world`. It is found in :zephyr_file:`samples/hello_world`. Configuring @@ -90,7 +90,7 @@ Building You can build an application in the usual way. Refer to :ref:`build_an_application` for more details. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :board: iotdk diff --git a/boards/sparkfun/micromod/doc/index.rst b/boards/sparkfun/micromod/doc/index.rst index 294441f66d7..507ef52e426 100644 --- a/boards/sparkfun/micromod/doc/index.rst +++ b/boards/sparkfun/micromod/doc/index.rst @@ -142,7 +142,7 @@ The flashing tool will depend on the carrier used along with the board. In the case of `Sparkfun asset tracking carrier`_, it is possible to use the SWD interface along with a J-Link. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/sparkfun/thing_plus/doc/index.rst b/boards/sparkfun/thing_plus/doc/index.rst index 1e9994eb0ff..802c77ffb1a 100644 --- a/boards/sparkfun/thing_plus/doc/index.rst +++ b/boards/sparkfun/thing_plus/doc/index.rst @@ -92,7 +92,7 @@ In most cases you'll want to use the ``ns`` target with any of the Zephyr or Nordic based examples. Some of the examples do not use secure mode, so they do not required the ``ns`` suffix. -A great example of this is the :ref:`hello_world` below. +A great example of this is the :zephyr:code-sample:`hello_world` below. Flashing ======== @@ -103,7 +103,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst b/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst index f9ffd1f6202..cdaed771bd8 100644 --- a/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst +++ b/boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst @@ -105,7 +105,7 @@ Programming and Debugging Flashing ======== -The sample application :ref:`hello_world` is used for this example. +The sample application :zephyr:code-sample:`hello_world` is used for this example. Build the Zephyr kernel and application: .. zephyr-app-commands:: diff --git a/boards/st/b_g474e_dpow1/doc/index.rst b/boards/st/b_g474e_dpow1/doc/index.rst index 39f7bf045aa..7e1f584b522 100644 --- a/boards/st/b_g474e_dpow1/doc/index.rst +++ b/boards/st/b_g474e_dpow1/doc/index.rst @@ -137,7 +137,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/b_l072z_lrwan1/doc/index.rst b/boards/st/b_l072z_lrwan1/doc/index.rst index 87a98d67910..527461c24a4 100644 --- a/boards/st/b_l072z_lrwan1/doc/index.rst +++ b/boards/st/b_l072z_lrwan1/doc/index.rst @@ -214,7 +214,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to B-L072Z-LRWAN1 Discovery board --------------------------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Connect the B-L072Z-LRWAN1 Discovery board to a STLinkV2 to your host computer using the USB port, then run a serial host program to connect with your board. For example: @@ -240,7 +240,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/b_l4s5i_iot01a/doc/index.rst b/boards/st/b_l4s5i_iot01a/doc/index.rst index b66df638cd5..fb1620c672d 100644 --- a/boards/st/b_l4s5i_iot01a/doc/index.rst +++ b/boards/st/b_l4s5i_iot01a/doc/index.rst @@ -205,7 +205,7 @@ board. For example: $ minicom -D /dev/ttyACM0 Then, build and flash in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -222,7 +222,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/b_u585i_iot02a/doc/index.rst b/boards/st/b_u585i_iot02a/doc/index.rst index f09b6f3dc2e..2400f75e3d1 100644 --- a/boards/st/b_u585i_iot02a/doc/index.rst +++ b/boards/st/b_u585i_iot02a/doc/index.rst @@ -317,7 +317,7 @@ board. For example: $ minicom -D /dev/ttyACM0 Then, build and flash in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/disco_l475_iot1/doc/index.rst b/boards/st/disco_l475_iot1/doc/index.rst index a5ba3b59978..197881078a3 100644 --- a/boards/st/disco_l475_iot1/doc/index.rst +++ b/boards/st/disco_l475_iot1/doc/index.rst @@ -216,7 +216,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Disco L475 IoT ----------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Connect the Disco L475 IoT to your host computer using the USB port, then run a serial host program to connect with your Nucleo board. For example: @@ -242,7 +242,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f070rb/doc/index.rst b/boards/st/nucleo_f070rb/doc/index.rst index b017b218699..acecfb20979 100644 --- a/boards/st/nucleo_f070rb/doc/index.rst +++ b/boards/st/nucleo_f070rb/doc/index.rst @@ -169,7 +169,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f091rc/doc/index.rst b/boards/st/nucleo_f091rc/doc/index.rst index 38cb5e6c38b..2cce144c1fb 100644 --- a/boards/st/nucleo_f091rc/doc/index.rst +++ b/boards/st/nucleo_f091rc/doc/index.rst @@ -186,7 +186,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f401re/doc/index.rst b/boards/st/nucleo_f401re/doc/index.rst index ceb25368d57..123992ac18b 100644 --- a/boards/st/nucleo_f401re/doc/index.rst +++ b/boards/st/nucleo_f401re/doc/index.rst @@ -179,7 +179,7 @@ then run a serial host program to connect with your Nucleo board: $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -197,7 +197,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f410rb/doc/index.rst b/boards/st/nucleo_f410rb/doc/index.rst index f260608dafb..af87b501923 100644 --- a/boards/st/nucleo_f410rb/doc/index.rst +++ b/boards/st/nucleo_f410rb/doc/index.rst @@ -176,7 +176,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F410RB ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -201,7 +201,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f411re/doc/index.rst b/boards/st/nucleo_f411re/doc/index.rst index fb6cf4ecba9..e4c10085d9b 100644 --- a/boards/st/nucleo_f411re/doc/index.rst +++ b/boards/st/nucleo_f411re/doc/index.rst @@ -164,7 +164,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F411RE ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -189,7 +189,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f446re/doc/index.rst b/boards/st/nucleo_f446re/doc/index.rst index 49748acbde0..e111880ef32 100644 --- a/boards/st/nucleo_f446re/doc/index.rst +++ b/boards/st/nucleo_f446re/doc/index.rst @@ -187,7 +187,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F446RE ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -212,7 +212,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f446ze/doc/index.rst b/boards/st/nucleo_f446ze/doc/index.rst index 676da09ebb7..0029f016ccf 100644 --- a/boards/st/nucleo_f446ze/doc/index.rst +++ b/boards/st/nucleo_f446ze/doc/index.rst @@ -212,7 +212,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F446ZE ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -237,7 +237,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f722ze/doc/index.rst b/boards/st/nucleo_f722ze/doc/index.rst index 37d3237d260..fde339622a8 100644 --- a/boards/st/nucleo_f722ze/doc/index.rst +++ b/boards/st/nucleo_f722ze/doc/index.rst @@ -201,7 +201,7 @@ the ``--runner`` (or ``-r``) option: $ west flash --runner openocd $ west flash --runner jlink -Build the :ref:`hello_world` application and flash it using the on-board +Build the :zephyr:code-sample:`hello_world` application and flash it using the on-board ST-LINK interface: .. zephyr-app-commands:: diff --git a/boards/st/nucleo_f746zg/doc/index.rst b/boards/st/nucleo_f746zg/doc/index.rst index c4d4a0f9fc1..59566cf34c7 100644 --- a/boards/st/nucleo_f746zg/doc/index.rst +++ b/boards/st/nucleo_f746zg/doc/index.rst @@ -202,7 +202,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F746ZG ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -227,7 +227,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f756zg/doc/index.rst b/boards/st/nucleo_f756zg/doc/index.rst index 371464038d3..6d512dcca37 100644 --- a/boards/st/nucleo_f756zg/doc/index.rst +++ b/boards/st/nucleo_f756zg/doc/index.rst @@ -183,7 +183,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F756ZG ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -208,7 +208,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_f767zi/doc/index.rst b/boards/st/nucleo_f767zi/doc/index.rst index 87c08558518..e0b50050151 100644 --- a/boards/st/nucleo_f767zi/doc/index.rst +++ b/boards/st/nucleo_f767zi/doc/index.rst @@ -203,7 +203,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo F767ZI ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -228,7 +228,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_g031k8/doc/index.rst b/boards/st/nucleo_g031k8/doc/index.rst index 29ecc49cdff..c3776071ee2 100644 --- a/boards/st/nucleo_g031k8/doc/index.rst +++ b/boards/st/nucleo_g031k8/doc/index.rst @@ -146,7 +146,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_g070rb/doc/index.rst b/boards/st/nucleo_g070rb/doc/index.rst index 055b11b5c10..87b8cef25af 100644 --- a/boards/st/nucleo_g070rb/doc/index.rst +++ b/boards/st/nucleo_g070rb/doc/index.rst @@ -180,7 +180,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_g071rb/doc/index.rst b/boards/st/nucleo_g071rb/doc/index.rst index 0dc30a94049..2202157b6cd 100644 --- a/boards/st/nucleo_g071rb/doc/index.rst +++ b/boards/st/nucleo_g071rb/doc/index.rst @@ -186,7 +186,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_g0b1re/doc/index.rst b/boards/st/nucleo_g0b1re/doc/index.rst index ba5f8600558..3a32623a82e 100644 --- a/boards/st/nucleo_g0b1re/doc/index.rst +++ b/boards/st/nucleo_g0b1re/doc/index.rst @@ -192,7 +192,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_g431rb/doc/index.rst b/boards/st/nucleo_g431rb/doc/index.rst index 9d87f2f41d2..62805c011cd 100644 --- a/boards/st/nucleo_g431rb/doc/index.rst +++ b/boards/st/nucleo_g431rb/doc/index.rst @@ -222,7 +222,7 @@ then run a serial host program to connect with your Nucleo board. $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -240,7 +240,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_g474re/doc/index.rst b/boards/st/nucleo_g474re/doc/index.rst index e4dc198a9d4..8ef04ed8fa1 100644 --- a/boards/st/nucleo_g474re/doc/index.rst +++ b/boards/st/nucleo_g474re/doc/index.rst @@ -229,7 +229,7 @@ then run a serial host program to connect with your Nucleo board. $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -247,7 +247,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_h503rb/doc/index.rst b/boards/st/nucleo_h503rb/doc/index.rst index e8ab73b8cb5..ed7133cb5b1 100644 --- a/boards/st/nucleo_h503rb/doc/index.rst +++ b/boards/st/nucleo_h503rb/doc/index.rst @@ -242,7 +242,7 @@ Flashing an application to Nucleo-H503RB Connect the Nucleo-H503RB to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_h533re/doc/index.rst b/boards/st/nucleo_h533re/doc/index.rst index eec0ad90721..428f79b83c2 100644 --- a/boards/st/nucleo_h533re/doc/index.rst +++ b/boards/st/nucleo_h533re/doc/index.rst @@ -293,7 +293,7 @@ Flashing an application to Nucleo H533RE Connect the Nucleo H533RE to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_h563zi/doc/index.rst b/boards/st/nucleo_h563zi/doc/index.rst index f448483fb54..8bbb099147e 100644 --- a/boards/st/nucleo_h563zi/doc/index.rst +++ b/boards/st/nucleo_h563zi/doc/index.rst @@ -307,7 +307,7 @@ Flashing an application to Nucleo H563ZI Connect the Nucleo H563ZI to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_h723zg/doc/index.rst b/boards/st/nucleo_h723zg/doc/index.rst index 1e364d88263..5e97327386d 100644 --- a/boards/st/nucleo_h723zg/doc/index.rst +++ b/boards/st/nucleo_h723zg/doc/index.rst @@ -197,7 +197,7 @@ Flashing an application to Nucleo H723ZG First, connect the NUCLEO-H723ZG to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your NUCLEO-H723ZG board. @@ -235,7 +235,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_h743zi/doc/index.rst b/boards/st/nucleo_h743zi/doc/index.rst index 403f356b862..2a790927bfc 100644 --- a/boards/st/nucleo_h743zi/doc/index.rst +++ b/boards/st/nucleo_h743zi/doc/index.rst @@ -208,7 +208,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo H743ZI ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -233,7 +233,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_h745zi_q/doc/index.rst b/boards/st/nucleo_h745zi_q/doc/index.rst index 35e9dd2fbb1..c0e5d3db722 100644 --- a/boards/st/nucleo_h745zi_q/doc/index.rst +++ b/boards/st/nucleo_h745zi_q/doc/index.rst @@ -220,7 +220,7 @@ Flashing an application to STM32H745ZI M7 Core First, connect the NUCLEO-H745ZI-Q to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your NUCLEO-H745ZI-Q board. @@ -270,7 +270,7 @@ Debugging ========= You can debug an application on Cortex M7 side in the usual way. Here is an example -for the :ref:`hello_world` application. +for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_h753zi/doc/index.rst b/boards/st/nucleo_h753zi/doc/index.rst index d03b6c1b5e7..e9af66a3232 100644 --- a/boards/st/nucleo_h753zi/doc/index.rst +++ b/boards/st/nucleo_h753zi/doc/index.rst @@ -192,7 +192,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo H753ZI ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -217,7 +217,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_h755zi_q/doc/index.rst b/boards/st/nucleo_h755zi_q/doc/index.rst index d511cb1d7db..3d509cc90ba 100644 --- a/boards/st/nucleo_h755zi_q/doc/index.rst +++ b/boards/st/nucleo_h755zi_q/doc/index.rst @@ -209,7 +209,7 @@ Flashing an application to STM32H755ZI M7 Core First, connect the NUCLEO-H755ZI-Q to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your NUCLEO-H755ZI-Q board. @@ -259,7 +259,7 @@ Debugging ========= You can debug an application on the Cortex M7 core in the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_h7a3zi_q/doc/index.rst b/boards/st/nucleo_h7a3zi_q/doc/index.rst index 1683e04d87a..0de0ef109eb 100644 --- a/boards/st/nucleo_h7a3zi_q/doc/index.rst +++ b/boards/st/nucleo_h7a3zi_q/doc/index.rst @@ -171,7 +171,7 @@ the ``--runner`` (or ``-r``) option: Flashing an application to Nucleo H7A3ZI-Q ------------------------------------------ -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -196,7 +196,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l011k4/doc/index.rst b/boards/st/nucleo_l011k4/doc/index.rst index 7e13a9040a7..b1d9396f7ed 100644 --- a/boards/st/nucleo_l011k4/doc/index.rst +++ b/boards/st/nucleo_l011k4/doc/index.rst @@ -154,7 +154,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l031k6/doc/index.rst b/boards/st/nucleo_l031k6/doc/index.rst index 2b1a3232128..0845a046fc0 100644 --- a/boards/st/nucleo_l031k6/doc/index.rst +++ b/boards/st/nucleo_l031k6/doc/index.rst @@ -147,7 +147,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l053r8/doc/index.rst b/boards/st/nucleo_l053r8/doc/index.rst index 101d4c80d64..4fd63f57f43 100644 --- a/boards/st/nucleo_l053r8/doc/index.rst +++ b/boards/st/nucleo_l053r8/doc/index.rst @@ -163,7 +163,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l073rz/doc/index.rst b/boards/st/nucleo_l073rz/doc/index.rst index 70c49d66b71..6ea4076a98a 100644 --- a/boards/st/nucleo_l073rz/doc/index.rst +++ b/boards/st/nucleo_l073rz/doc/index.rst @@ -179,7 +179,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l152re/doc/index.rst b/boards/st/nucleo_l152re/doc/index.rst index 29a7cab6ac6..c4d18190a23 100644 --- a/boards/st/nucleo_l152re/doc/index.rst +++ b/boards/st/nucleo_l152re/doc/index.rst @@ -172,7 +172,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l412rb_p/doc/index.rst b/boards/st/nucleo_l412rb_p/doc/index.rst index 97d998d8454..11a12390782 100644 --- a/boards/st/nucleo_l412rb_p/doc/index.rst +++ b/boards/st/nucleo_l412rb_p/doc/index.rst @@ -239,7 +239,7 @@ then run a serial host program to connect with your Nucleo board. $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -257,7 +257,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l432kc/doc/index.rst b/boards/st/nucleo_l432kc/doc/index.rst index b54031aaa62..f312380a07c 100644 --- a/boards/st/nucleo_l432kc/doc/index.rst +++ b/boards/st/nucleo_l432kc/doc/index.rst @@ -199,7 +199,7 @@ then run a serial host program to connect with your Nucleo board. $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -217,7 +217,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l433rc_p/doc/index.rst b/boards/st/nucleo_l433rc_p/doc/index.rst index 9269652973b..75b3a8fe20e 100644 --- a/boards/st/nucleo_l433rc_p/doc/index.rst +++ b/boards/st/nucleo_l433rc_p/doc/index.rst @@ -204,7 +204,7 @@ then run a serial host program to connect with your Nucleo board. $ picocom /dev/ttyACM0 -b 115200 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -222,7 +222,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l452re/doc/index.rst b/boards/st/nucleo_l452re/doc/index.rst index 26ff761d06c..9587b9e6c02 100644 --- a/boards/st/nucleo_l452re/doc/index.rst +++ b/boards/st/nucleo_l452re/doc/index.rst @@ -223,7 +223,7 @@ then run a serial host program to connect with your Nucleo board. $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -248,7 +248,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l476rg/doc/index.rst b/boards/st/nucleo_l476rg/doc/index.rst index 2e1557e22ef..ac566003430 100644 --- a/boards/st/nucleo_l476rg/doc/index.rst +++ b/boards/st/nucleo_l476rg/doc/index.rst @@ -206,7 +206,7 @@ Flashing an application to Nucleo L476RG Connect the Nucleo L476RG to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -231,7 +231,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l496zg/doc/index.rst b/boards/st/nucleo_l496zg/doc/index.rst index cc95df28dd7..4abdc105c6a 100644 --- a/boards/st/nucleo_l496zg/doc/index.rst +++ b/boards/st/nucleo_l496zg/doc/index.rst @@ -209,7 +209,7 @@ Flashing an application to Nucleo L496ZG Connect the Nucleo L496ZG to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -234,7 +234,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l4a6zg/doc/index.rst b/boards/st/nucleo_l4a6zg/doc/index.rst index 428ece2b645..267d5f619b8 100644 --- a/boards/st/nucleo_l4a6zg/doc/index.rst +++ b/boards/st/nucleo_l4a6zg/doc/index.rst @@ -206,7 +206,7 @@ Flashing an application to Nucleo L4A6ZG Connect the Nucleo L4A6ZG to your host computer using the ST-LINK USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -231,7 +231,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_l4r5zi/doc/index.rst b/boards/st/nucleo_l4r5zi/doc/index.rst index 7de08708650..1a1302aa3e2 100644 --- a/boards/st/nucleo_l4r5zi/doc/index.rst +++ b/boards/st/nucleo_l4r5zi/doc/index.rst @@ -243,7 +243,7 @@ Flashing an application to Nucleo L4R4ZI Connect the Nucleo L4R5ZI to your host computer using the USB port. Then build and flash an application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst b/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst index 79a91fe5201..0d5aa6e0fd8 100644 --- a/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst +++ b/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst @@ -315,7 +315,7 @@ Flashing an application to Nucleo L552ZE Q Connect the Nucleo L552ZE Q to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -340,7 +340,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_u031r8/doc/index.rst b/boards/st/nucleo_u031r8/doc/index.rst index 869149fc067..9df168c0fad 100644 --- a/boards/st/nucleo_u031r8/doc/index.rst +++ b/boards/st/nucleo_u031r8/doc/index.rst @@ -211,7 +211,7 @@ Flashing an application to Nucleo U031R8 Connect the Nucleo U031R8 to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_u083rc/doc/index.rst b/boards/st/nucleo_u083rc/doc/index.rst index 467894ab724..dd6e3db0e83 100644 --- a/boards/st/nucleo_u083rc/doc/index.rst +++ b/boards/st/nucleo_u083rc/doc/index.rst @@ -227,7 +227,7 @@ Flashing an application to Nucleo U083RC Connect the Nucleo U083RC to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_u575zi_q/doc/index.rst b/boards/st/nucleo_u575zi_q/doc/index.rst index 1852246f069..080bd074c4f 100644 --- a/boards/st/nucleo_u575zi_q/doc/index.rst +++ b/boards/st/nucleo_u575zi_q/doc/index.rst @@ -273,7 +273,7 @@ Flashing an application to Nucleo U575ZI Q Connect the Nucleo U575ZI Q to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_u5a5zj_q/doc/index.rst b/boards/st/nucleo_u5a5zj_q/doc/index.rst index 47b36fce8ad..d3f90a178d4 100644 --- a/boards/st/nucleo_u5a5zj_q/doc/index.rst +++ b/boards/st/nucleo_u5a5zj_q/doc/index.rst @@ -305,7 +305,7 @@ Flashing an application to Nucleo U5A5ZJ Q Connect the Nucleo U5A5ZJ Q to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_wb05kz/doc/index.rst b/boards/st/nucleo_wb05kz/doc/index.rst index b7434039c72..7d242549ffe 100644 --- a/boards/st/nucleo_wb05kz/doc/index.rst +++ b/boards/st/nucleo_wb05kz/doc/index.rst @@ -110,7 +110,7 @@ then run a serial host program to connect with your Nucleo board: $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -128,7 +128,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_wb09ke/doc/index.rst b/boards/st/nucleo_wb09ke/doc/index.rst index af6a5f7d027..9e4ce9eb728 100644 --- a/boards/st/nucleo_wb09ke/doc/index.rst +++ b/boards/st/nucleo_wb09ke/doc/index.rst @@ -110,7 +110,7 @@ then run a serial host program to connect with your Nucleo board: $ minicom -D /dev/ttyACM0 Now build and flash an application. Here is an example for -:ref:`hello_world`. +:zephyr:code-sample:`hello_world`. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -128,7 +128,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst b/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst index 3a97a2bfc90..fb1b76e76ca 100644 --- a/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst +++ b/boards/st/nucleo_wb55rg/doc/nucleo_wb55rg.rst @@ -274,7 +274,7 @@ Flashing an application to Nucleo WB55RG Connect the Nucleo WB55RG to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst b/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst index ca0276ebb00..98ce41d5877 100644 --- a/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst +++ b/boards/st/nucleo_wl55jc/doc/nucleo_wl55jc.rst @@ -282,7 +282,7 @@ Flashing an application to Nucleo WL55JC Connect the Nucleo WL55JC to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/st25dv_mb1283_disco/docs/index.rst b/boards/st/st25dv_mb1283_disco/docs/index.rst index 03acec44fc5..1fef60ebf63 100644 --- a/boards/st/st25dv_mb1283_disco/docs/index.rst +++ b/boards/st/st25dv_mb1283_disco/docs/index.rst @@ -101,7 +101,7 @@ Flashing an application to ST25DV Discovery First, connect the ST25DV Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -124,7 +124,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/steval_fcu001v1/doc/index.rst b/boards/st/steval_fcu001v1/doc/index.rst index a76f99c6e01..f10c0300957 100644 --- a/boards/st/steval_fcu001v1/doc/index.rst +++ b/boards/st/steval_fcu001v1/doc/index.rst @@ -123,7 +123,7 @@ program to connect with your steval_fcu001v1 via the FT232 board: $ minicom -D /dev/ttyUSB0 -Now build and flash an application. Here is an example for :ref:`hello_world` +Now build and flash an application. Here is an example for :zephyr:code-sample:`hello_world` .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -140,7 +140,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm3210c_eval/doc/index.rst b/boards/st/stm3210c_eval/doc/index.rst index 383a0e2f5fb..117e378b659 100644 --- a/boards/st/stm3210c_eval/doc/index.rst +++ b/boards/st/stm3210c_eval/doc/index.rst @@ -145,7 +145,7 @@ example, on Linux: $ minicom -D /dev/ttyACM0 You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32c0116_dk/doc/index.rst b/boards/st/stm32c0116_dk/doc/index.rst index 98276b34946..52e3c24ef20 100644 --- a/boards/st/stm32c0116_dk/doc/index.rst +++ b/boards/st/stm32c0116_dk/doc/index.rst @@ -131,7 +131,7 @@ Flashing an application to STM32C0116-DK First, connect the STM32C0116 Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f072b_disco/doc/index.rst b/boards/st/stm32f072b_disco/doc/index.rst index 6ce491e3621..6f97341d2b3 100644 --- a/boards/st/stm32f072b_disco/doc/index.rst +++ b/boards/st/stm32f072b_disco/doc/index.rst @@ -170,7 +170,7 @@ Flashing an application to STM32F072B-DISCO First, connect the STM32F072B-DISCO Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -198,7 +198,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f3_disco/doc/index.rst b/boards/st/stm32f3_disco/doc/index.rst index 4ad79931ba9..e557eb013c7 100644 --- a/boards/st/stm32f3_disco/doc/index.rst +++ b/boards/st/stm32f3_disco/doc/index.rst @@ -228,7 +228,7 @@ Flashing an application to STM32F3DISCOVERY First, connect the STM32F3DISCOVERY Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -266,7 +266,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f412g_disco/doc/index.rst b/boards/st/stm32f412g_disco/doc/index.rst index 28a5499d878..ae84de7cea7 100644 --- a/boards/st/stm32f412g_disco/doc/index.rst +++ b/boards/st/stm32f412g_disco/doc/index.rst @@ -172,7 +172,7 @@ board: $ minicom -D /dev/ttyACM0 Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -190,7 +190,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f429i_disc1/doc/index.rst b/boards/st/stm32f429i_disc1/doc/index.rst index c61cfcaa739..28a79e9ac2a 100644 --- a/boards/st/stm32f429i_disc1/doc/index.rst +++ b/boards/st/stm32f429i_disc1/doc/index.rst @@ -182,7 +182,7 @@ Alternatively, you can use `STM32CubeProgrammer`_ (after installing it) using th First, connect the STM32F429I-DISC1 Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -206,7 +206,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f469i_disco/doc/index.rst b/boards/st/stm32f469i_disco/doc/index.rst index 85ebec3778f..549ffd4c67e 100644 --- a/boards/st/stm32f469i_disco/doc/index.rst +++ b/boards/st/stm32f469i_disco/doc/index.rst @@ -162,7 +162,7 @@ Flashing an application to STM32F469I-DISCO First, connect the STM32F469I-DISCO Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -186,7 +186,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f4_disco/doc/index.rst b/boards/st/stm32f4_disco/doc/index.rst index 128b84f3168..e590250741a 100644 --- a/boards/st/stm32f4_disco/doc/index.rst +++ b/boards/st/stm32f4_disco/doc/index.rst @@ -199,7 +199,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f723e_disco/doc/index.rst b/boards/st/stm32f723e_disco/doc/index.rst index df201519219..755e87d4a12 100644 --- a/boards/st/stm32f723e_disco/doc/index.rst +++ b/boards/st/stm32f723e_disco/doc/index.rst @@ -158,7 +158,7 @@ Flashing an application to STM32F723E-DISCO First, connect the STM32F723E Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -181,7 +181,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f746g_disco/doc/index.rst b/boards/st/stm32f746g_disco/doc/index.rst index 7900c49436a..7bd37aa2652 100644 --- a/boards/st/stm32f746g_disco/doc/index.rst +++ b/boards/st/stm32f746g_disco/doc/index.rst @@ -209,7 +209,7 @@ Flashing an application to STM32F746G First, connect the STM32F746G Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -232,7 +232,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f7508_dk/doc/index.rst b/boards/st/stm32f7508_dk/doc/index.rst index 0ebde3c4fdc..7a3c1c96c22 100644 --- a/boards/st/stm32f7508_dk/doc/index.rst +++ b/boards/st/stm32f7508_dk/doc/index.rst @@ -204,7 +204,7 @@ Flashing an application to STM32F7508-DK First, connect the STM32F746G Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -227,7 +227,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32f769i_disco/doc/index.rst b/boards/st/stm32f769i_disco/doc/index.rst index 60edc99273f..210eb840ff0 100644 --- a/boards/st/stm32f769i_disco/doc/index.rst +++ b/boards/st/stm32f769i_disco/doc/index.rst @@ -191,7 +191,7 @@ Flashing an application to STM32F769I First, connect the STM32F769I Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -214,7 +214,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32g0316_disco/doc/index.rst b/boards/st/stm32g0316_disco/doc/index.rst index 40161376333..de6c2d91e55 100644 --- a/boards/st/stm32g0316_disco/doc/index.rst +++ b/boards/st/stm32g0316_disco/doc/index.rst @@ -116,7 +116,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32g071b_disco/doc/index.rst b/boards/st/stm32g071b_disco/doc/index.rst index 9b1b3c23041..e64a06d1213 100644 --- a/boards/st/stm32g071b_disco/doc/index.rst +++ b/boards/st/stm32g071b_disco/doc/index.rst @@ -147,7 +147,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32g081b_eval/doc/index.rst b/boards/st/stm32g081b_eval/doc/index.rst index 1bae82739c6..1f737c8daa1 100644 --- a/boards/st/stm32g081b_eval/doc/index.rst +++ b/boards/st/stm32g081b_eval/doc/index.rst @@ -185,7 +185,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h573i_dk/doc/index.rst b/boards/st/stm32h573i_dk/doc/index.rst index 5fad2280266..86190a77ded 100644 --- a/boards/st/stm32h573i_dk/doc/index.rst +++ b/boards/st/stm32h573i_dk/doc/index.rst @@ -298,7 +298,7 @@ Flashing an application to STM32H573I-DK Discovery Connect the STM32H573I-DK Discovery to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -331,7 +331,7 @@ requires to enable "pack" support with the following pyOCD command: $ pyocd pack --install stm32h5 Once installed, you can debug an application in the usual way. Here is an -example for the :ref:`hello_world` application. +example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h735g_disco/doc/index.rst b/boards/st/stm32h735g_disco/doc/index.rst index ae14832ea21..3ec250bb4e8 100644 --- a/boards/st/stm32h735g_disco/doc/index.rst +++ b/boards/st/stm32h735g_disco/doc/index.rst @@ -140,7 +140,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h745i_disco/doc/index.rst b/boards/st/stm32h745i_disco/doc/index.rst index 2c5fc70dd34..c5b0ef79276 100644 --- a/boards/st/stm32h745i_disco/doc/index.rst +++ b/boards/st/stm32h745i_disco/doc/index.rst @@ -195,7 +195,7 @@ Flashing an application to STM32H745XI M7 Core First, connect the STM32H745I-DISCO to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your STM32H745I-DISCO board. @@ -245,7 +245,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h747i_disco/doc/index.rst b/boards/st/stm32h747i_disco/doc/index.rst index 3af51370885..4f7a345ccc4 100644 --- a/boards/st/stm32h747i_disco/doc/index.rst +++ b/boards/st/stm32h747i_disco/doc/index.rst @@ -260,7 +260,7 @@ Flashing an application to STM32H747I M7 Core First, connect the STM32H747I Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -297,7 +297,7 @@ Debugging ========= You can debug an application on Cortex M7 side in the usual way. Here is an example -for the :ref:`hello_world` application. +for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h750b_dk/doc/index.rst b/boards/st/stm32h750b_dk/doc/index.rst index e450488ed4d..3e2cd3d009e 100644 --- a/boards/st/stm32h750b_dk/doc/index.rst +++ b/boards/st/stm32h750b_dk/doc/index.rst @@ -110,7 +110,7 @@ USB port, then run a serial host program to connect with the board. For example: $ minicom -b 115200 -D /dev/ttyACM0 You can then build and flash applications in the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -128,7 +128,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h7b3i_dk/doc/index.rst b/boards/st/stm32h7b3i_dk/doc/index.rst index ff6f833fa8c..954f4342d56 100644 --- a/boards/st/stm32h7b3i_dk/doc/index.rst +++ b/boards/st/stm32h7b3i_dk/doc/index.rst @@ -225,7 +225,7 @@ Flashing an application to STM32H7B3I First, connect the STM32H7B3I Discovery kit to your host computer using the USB port to prepare it for flashing. Then build and flash your application. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -248,7 +248,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32h7s78_dk/doc/index.rst b/boards/st/stm32h7s78_dk/doc/index.rst index 62c059cf0ec..2352fde0fc9 100644 --- a/boards/st/stm32h7s78_dk/doc/index.rst +++ b/boards/st/stm32h7s78_dk/doc/index.rst @@ -257,7 +257,7 @@ Flashing an application to STM32H7S78-DK Discovery Connect the STM32H7S78-DK Discovery to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -282,7 +282,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32l476g_disco/doc/index.rst b/boards/st/stm32l476g_disco/doc/index.rst index 91695acae20..94a6e9ce24f 100644 --- a/boards/st/stm32l476g_disco/doc/index.rst +++ b/boards/st/stm32l476g_disco/doc/index.rst @@ -190,7 +190,7 @@ board. For example: $ minicom -D /dev/ttyACM0 Then, build and flash in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -207,7 +207,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32l496g_disco/doc/index.rst b/boards/st/stm32l496g_disco/doc/index.rst index 22e575e4b11..15461fb1a71 100644 --- a/boards/st/stm32l496g_disco/doc/index.rst +++ b/boards/st/stm32l496g_disco/doc/index.rst @@ -230,7 +230,7 @@ board. For example: $ minicom -D /dev/ttyACM0 Then, build and flash in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -247,7 +247,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32l4r9i_disco/doc/index.rst b/boards/st/stm32l4r9i_disco/doc/index.rst index 5d71a40633a..6fadc331d45 100644 --- a/boards/st/stm32l4r9i_disco/doc/index.rst +++ b/boards/st/stm32l4r9i_disco/doc/index.rst @@ -122,7 +122,7 @@ USB port, then run a serial host program to connect with the board. For example: $ minicom -b 115200 -D /dev/ttyACM0 You can then build and flash applications in the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -140,7 +140,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32l562e_dk/doc/index.rst b/boards/st/stm32l562e_dk/doc/index.rst index 922c03cbebd..55fd91a34fa 100644 --- a/boards/st/stm32l562e_dk/doc/index.rst +++ b/boards/st/stm32l562e_dk/doc/index.rst @@ -316,7 +316,7 @@ Flashing an application to STM32L562E-DK Discovery Connect the STM32L562E-DK Discovery to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: @@ -341,7 +341,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/st/stm32u083c_dk/doc/index.rst b/boards/st/stm32u083c_dk/doc/index.rst index ed6717a63ad..d2f098b6b60 100644 --- a/boards/st/stm32u083c_dk/doc/index.rst +++ b/boards/st/stm32u083c_dk/doc/index.rst @@ -240,7 +240,7 @@ Flashing an application to STM32U083C_DK Connect the STM32U083C_DK to your host computer using the USB port. Then build and flash an application. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board: diff --git a/boards/st/stm32u5a9j_dk/doc/index.rst b/boards/st/stm32u5a9j_dk/doc/index.rst index 7e3d638fa3e..571ee80f334 100644 --- a/boards/st/stm32u5a9j_dk/doc/index.rst +++ b/boards/st/stm32u5a9j_dk/doc/index.rst @@ -154,7 +154,7 @@ board. For example: $ minicom -D /dev/ttyACM0 -b 115200 Then, build and flash in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/tdk/robokit1/doc/index.rst b/boards/tdk/robokit1/doc/index.rst index ef65431b7e5..abc90a0a611 100644 --- a/boards/tdk/robokit1/doc/index.rst +++ b/boards/tdk/robokit1/doc/index.rst @@ -153,7 +153,7 @@ Flashing #. Connect the TDK RoboKit1 board to your host computer using the USB debug port (USB1), USB2 for a serial console, and remaining micro USB for - power. Then build and flash the :ref:`hello_world` application. + power. Then build and flash the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -166,7 +166,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ti/cc1352p1_launchxl/doc/index.rst b/boards/ti/cc1352p1_launchxl/doc/index.rst index a5f88cc19ff..b751b357307 100644 --- a/boards/ti/cc1352p1_launchxl/doc/index.rst +++ b/boards/ti/cc1352p1_launchxl/doc/index.rst @@ -168,7 +168,7 @@ Applications for the ``CC1352P LaunchPad`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -190,7 +190,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ti/cc1352p7_launchpad/doc/index.rst b/boards/ti/cc1352p7_launchpad/doc/index.rst index 8deae6e3104..2b7fbc12a2c 100644 --- a/boards/ti/cc1352p7_launchpad/doc/index.rst +++ b/boards/ti/cc1352p7_launchpad/doc/index.rst @@ -168,7 +168,7 @@ Applications for the ``CC1352P7 LaunchPad`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -190,7 +190,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ti/cc1352r1_launchxl/doc/index.rst b/boards/ti/cc1352r1_launchxl/doc/index.rst index 0002b1e1c6f..2e7ed0ae2ff 100644 --- a/boards/ti/cc1352r1_launchxl/doc/index.rst +++ b/boards/ti/cc1352r1_launchxl/doc/index.rst @@ -167,7 +167,7 @@ Applications for the ``CC1352R LaunchPad`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -189,7 +189,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ti/cc1352r_sensortag/doc/index.rst b/boards/ti/cc1352r_sensortag/doc/index.rst index c270e85fd57..4120f4934df 100644 --- a/boards/ti/cc1352r_sensortag/doc/index.rst +++ b/boards/ti/cc1352r_sensortag/doc/index.rst @@ -188,7 +188,7 @@ Applications for the ``CC1352R SensorTag`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -214,7 +214,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ti/cc26x2r1_launchxl/doc/index.rst b/boards/ti/cc26x2r1_launchxl/doc/index.rst index 8177df13ae3..1f6a02d92dd 100644 --- a/boards/ti/cc26x2r1_launchxl/doc/index.rst +++ b/boards/ti/cc26x2r1_launchxl/doc/index.rst @@ -173,7 +173,7 @@ Applications for the ``CC26x2R LaunchPad`` board configuration can be built and flashed in the usual way (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. @@ -195,7 +195,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/ti/msp_exp432p401r_launchxl/doc/index.rst b/boards/ti/msp_exp432p401r_launchxl/doc/index.rst index 78662d6b7ba..e59942416f9 100644 --- a/boards/ti/msp_exp432p401r_launchxl/doc/index.rst +++ b/boards/ti/msp_exp432p401r_launchxl/doc/index.rst @@ -100,7 +100,7 @@ Flashing Follow the :ref:`getting_started` instructions for Zephyr application development. -For example, to build and flash the :ref:`hello_world` application for the +For example, to build and flash the :zephyr:code-sample:`hello_world` application for the MSP-EXP432P401R LaunchXL: .. zephyr-app-commands:: diff --git a/boards/ti/sk_am62/doc/index.rst b/boards/ti/sk_am62/doc/index.rst index 98f03bf7dff..60252c236eb 100644 --- a/boards/ti/sk_am62/doc/index.rst +++ b/boards/ti/sk_am62/doc/index.rst @@ -94,7 +94,7 @@ The board can using remoteproc, and uses the OpenAMP resource table to accomplis The testing requires the binary to be copied to the SD card to allow the A53 cores to load it while booting using remoteproc. -To test the M4F core, we build the :ref:`hello_world` sample with the following command. +To test the M4F core, we build the :zephyr:code-sample:`hello_world` sample with the following command. .. code-block:: console diff --git a/boards/toradex/verdin_imx8mp/doc/index.rst b/boards/toradex/verdin_imx8mp/doc/index.rst index de7751ff0e6..e59101fa212 100644 --- a/boards/toradex/verdin_imx8mp/doc/index.rst +++ b/boards/toradex/verdin_imx8mp/doc/index.rst @@ -251,7 +251,7 @@ Toradex Verdin iMX8M Plus SoM can be debugged by connecting an external JLink JT X56 debug connector and to the PC, or simply connecting a USB-C to X66 on the Verdin Development Board. Then, the application can be debugged using the usual way. -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/u-blox/ubx_bmd300eval/doc/index.rst b/boards/u-blox/ubx_bmd300eval/doc/index.rst index d1aea13208f..d7043adf19e 100644 --- a/boards/u-blox/ubx_bmd300eval/doc/index.rst +++ b/boards/u-blox/ubx_bmd300eval/doc/index.rst @@ -348,7 +348,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_bmd330eval/doc/index.rst b/boards/u-blox/ubx_bmd330eval/doc/index.rst index 3f065cfc6d2..63c1755edfd 100644 --- a/boards/u-blox/ubx_bmd330eval/doc/index.rst +++ b/boards/u-blox/ubx_bmd330eval/doc/index.rst @@ -339,7 +339,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_bmd340eval/doc/index.rst b/boards/u-blox/ubx_bmd340eval/doc/index.rst index 4e1fed4e8a1..8129bf36d4d 100644 --- a/boards/u-blox/ubx_bmd340eval/doc/index.rst +++ b/boards/u-blox/ubx_bmd340eval/doc/index.rst @@ -408,7 +408,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_bmd345eval/doc/index.rst b/boards/u-blox/ubx_bmd345eval/doc/index.rst index 0bcb1d201da..907370fb8a0 100644 --- a/boards/u-blox/ubx_bmd345eval/doc/index.rst +++ b/boards/u-blox/ubx_bmd345eval/doc/index.rst @@ -421,7 +421,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_bmd360eval/doc/index.rst b/boards/u-blox/ubx_bmd360eval/doc/index.rst index 556620a1764..f0fbf264f01 100644 --- a/boards/u-blox/ubx_bmd360eval/doc/index.rst +++ b/boards/u-blox/ubx_bmd360eval/doc/index.rst @@ -337,7 +337,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_bmd380eval/doc/index.rst b/boards/u-blox/ubx_bmd380eval/doc/index.rst index 1547cfc301e..e903b1ec125 100644 --- a/boards/u-blox/ubx_bmd380eval/doc/index.rst +++ b/boards/u-blox/ubx_bmd380eval/doc/index.rst @@ -407,7 +407,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_evkannab1/doc/index.rst b/boards/u-blox/ubx_evkannab1/doc/index.rst index f464ab5265b..79606e292ae 100644 --- a/boards/u-blox/ubx_evkannab1/doc/index.rst +++ b/boards/u-blox/ubx_evkannab1/doc/index.rst @@ -116,7 +116,7 @@ Flashing Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Open a terminal program to the USB Serial Port installed when connecting the board and listen for output. diff --git a/boards/u-blox/ubx_evkninab1/doc/index.rst b/boards/u-blox/ubx_evkninab1/doc/index.rst index 9073c223585..33dcecb2f00 100644 --- a/boards/u-blox/ubx_evkninab1/doc/index.rst +++ b/boards/u-blox/ubx_evkninab1/doc/index.rst @@ -124,7 +124,7 @@ Flashing Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Open a terminal program to the USB Serial Port installed when connecting the board and listen for output. diff --git a/boards/u-blox/ubx_evkninab3/doc/index.rst b/boards/u-blox/ubx_evkninab3/doc/index.rst index fb8b0159b34..d19f49ca704 100644 --- a/boards/u-blox/ubx_evkninab3/doc/index.rst +++ b/boards/u-blox/ubx_evkninab3/doc/index.rst @@ -223,7 +223,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/u-blox/ubx_evkninab4/doc/index.rst b/boards/u-blox/ubx_evkninab4/doc/index.rst index 5ad6289b590..ebb3ee05918 100644 --- a/boards/u-blox/ubx_evkninab4/doc/index.rst +++ b/boards/u-blox/ubx_evkninab4/doc/index.rst @@ -119,7 +119,7 @@ Flashing Build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details) -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Open a terminal program to the USB Serial Port installed when connecting the board and listen for output. diff --git a/boards/vcc-gnd/yd_esp32/doc/index.rst b/boards/vcc-gnd/yd_esp32/doc/index.rst index d847f45505d..20201b3a347 100644 --- a/boards/vcc-gnd/yd_esp32/doc/index.rst +++ b/boards/vcc-gnd/yd_esp32/doc/index.rst @@ -213,7 +213,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and :goals: build The usual ``flash`` target will work with the ``yd_esp32`` board -configuration. Here is an example for the :ref:`hello_world` +configuration. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: @@ -278,14 +278,14 @@ to the external programmer (e.g. a Flyswatter2): Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_. -Here is an example for building the :ref:`hello_world` application. +Here is an example for building the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: yd_esp32/esp32/procpu :goals: build flash -You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application. +You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/vcc-gnd/yd_stm32h750vb/doc/index.rst b/boards/vcc-gnd/yd_stm32h750vb/doc/index.rst index 5a5775cae1f..2b5e1794bd2 100644 --- a/boards/vcc-gnd/yd_stm32h750vb/doc/index.rst +++ b/boards/vcc-gnd/yd_stm32h750vb/doc/index.rst @@ -105,7 +105,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/vngiotlab/nrf51_vbluno51/doc/index.rst b/boards/vngiotlab/nrf51_vbluno51/doc/index.rst index 92d74c00c99..b56bcdd093d 100644 --- a/boards/vngiotlab/nrf51_vbluno51/doc/index.rst +++ b/boards/vngiotlab/nrf51_vbluno51/doc/index.rst @@ -135,7 +135,7 @@ Testing the VBLUno51 with Zephyr: buttons, LEDs, UART, BLE Here are some sample applications that you can use to test different components on the VBLUno51 board: - * :ref:`hello_world` + * :zephyr:code-sample:`hello_world` * :zephyr:code-sample:`blinky` * :zephyr:code-sample:`button` * :zephyr:code-sample:`bluetooth_beacon` diff --git a/boards/vngiotlab/nrf52_vbluno52/doc/index.rst b/boards/vngiotlab/nrf52_vbluno52/doc/index.rst index f534ae37205..68a7c1b97c6 100644 --- a/boards/vngiotlab/nrf52_vbluno52/doc/index.rst +++ b/boards/vngiotlab/nrf52_vbluno52/doc/index.rst @@ -87,7 +87,7 @@ See the :ref:`getting_started` for general information on setting up your development environment. You can build and flash applications in the usual way. Here is an -example for the :ref:`hello_world` application. +example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -100,7 +100,7 @@ Testing the VBLUno52 with Zephyr: buttons, LEDs, UART, BLE Here are some sample applications that you can use to test different components on the VBLUno52 board: -* :ref:`hello_world` +* :zephyr:code-sample:`hello_world` * :zephyr:code-sample:`blinky` * :zephyr:code-sample:`button` * :zephyr:code-sample:`bluetooth_beacon` diff --git a/boards/waveshare/nrf51_ble400/doc/index.rst b/boards/waveshare/nrf51_ble400/doc/index.rst index 3bfe06aa204..3d34f2f27f0 100644 --- a/boards/waveshare/nrf51_ble400/doc/index.rst +++ b/boards/waveshare/nrf51_ble400/doc/index.rst @@ -168,7 +168,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/waveshare/open103z/doc/index.rst b/boards/waveshare/open103z/doc/index.rst index 2cd9c7a6ac0..773b60f202f 100644 --- a/boards/waveshare/open103z/doc/index.rst +++ b/boards/waveshare/open103z/doc/index.rst @@ -55,7 +55,7 @@ Flashing ======== Build and flash applications as usual. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world @@ -66,7 +66,7 @@ Debugging ========= Debug applications as usual. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/boards/we/ophelia1ev/doc/index.rst b/boards/we/ophelia1ev/doc/index.rst index d64c32579a5..908b0ce6889 100644 --- a/boards/we/ophelia1ev/doc/index.rst +++ b/boards/we/ophelia1ev/doc/index.rst @@ -82,7 +82,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/we/proteus2ev/doc/index.rst b/boards/we/proteus2ev/doc/index.rst index 5492b4159fe..19a7df8fbac 100644 --- a/boards/we/proteus2ev/doc/index.rst +++ b/boards/we/proteus2ev/doc/index.rst @@ -112,7 +112,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/we/proteus3ev/doc/index.rst b/boards/we/proteus3ev/doc/index.rst index dd6c5f47d6c..87180a801b4 100644 --- a/boards/we/proteus3ev/doc/index.rst +++ b/boards/we/proteus3ev/doc/index.rst @@ -114,7 +114,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash applications as usual (see :ref:`build_an_application` and :ref:`application_run` for more details). -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, run your favorite terminal program to listen for output. diff --git a/boards/weact/mini_stm32h743/doc/index.rst b/boards/weact/mini_stm32h743/doc/index.rst index 4a96538ac1b..9b63292ad57 100644 --- a/boards/weact/mini_stm32h743/doc/index.rst +++ b/boards/weact/mini_stm32h743/doc/index.rst @@ -168,7 +168,7 @@ the device using the west tool or the STM32CubeProgrammer. Flashing an application to MiniSTM32H743 ---------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. First, put the board in bootloader mode as described above. Then build and flash the application in the usual way. Just add ``CONFIG_BOOT_DELAY=5000`` to the diff --git a/boards/wemos/esp32s2_lolin_mini/doc/index.rst b/boards/wemos/esp32s2_lolin_mini/doc/index.rst index 70682657f8a..d09dec2b5f9 100644 --- a/boards/wemos/esp32s2_lolin_mini/doc/index.rst +++ b/boards/wemos/esp32s2_lolin_mini/doc/index.rst @@ -66,7 +66,7 @@ The usual ``flash`` target will work with the ``esp32s2_lolin_mini`` board configuration after putting the board into bootloader mode by holding the '0' button then pressing 'RST' and releasing the 'RST' button. -Here is an example for the :ref:`hello_world` +Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: diff --git a/boards/witte/linum/doc/index.rst b/boards/witte/linum/doc/index.rst index 86fbbeafbdd..a7998afe261 100644 --- a/boards/witte/linum/doc/index.rst +++ b/boards/witte/linum/doc/index.rst @@ -369,7 +369,7 @@ Flashing Flashing an application to the Linum board ------------------------------------------- -Here is an example for the :ref:`hello_world` application. +Here is an example for the :zephyr:code-sample:`hello_world` application. Run a serial host program to connect with your Nucleo board. @@ -394,7 +394,7 @@ Debugging ========= You can debug an application in the usual way. Here is an example for the -:ref:`hello_world` application. +:zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/doc/build/dts/howtos.rst b/doc/build/dts/howtos.rst index 8875e9cfc42..5bd4df9fcbe 100644 --- a/doc/build/dts/howtos.rst +++ b/doc/build/dts/howtos.rst @@ -23,10 +23,10 @@ application and open the :file:`zephyr.dts` file in the build directory. .. tip:: - You can build :ref:`hello_world` to see the "base" devicetree for your board + You can build :zephyr:code-sample:`hello_world` to see the "base" devicetree for your board without any additional changes from :ref:`overlay files `. -For example, using the :ref:`qemu_cortex_m3` board to build :ref:`hello_world`: +For example, using the :ref:`qemu_cortex_m3` board to build :zephyr:code-sample:`hello_world`: .. code-block:: sh diff --git a/doc/build/dts/troubleshooting.rst b/doc/build/dts/troubleshooting.rst index 71521a3026b..3cb360dd11b 100644 --- a/doc/build/dts/troubleshooting.rst +++ b/doc/build/dts/troubleshooting.rst @@ -261,7 +261,7 @@ Look at the preprocessor output To save preprocessor output files, enable the :kconfig:option:`CONFIG_COMPILER_SAVE_TEMPS` option. For example, to build -:ref:`hello_world` with west with this option set, use: +:zephyr:code-sample:`hello_world` with west with this option set, use: .. code-block:: sh @@ -300,7 +300,7 @@ To prevent the compiler from doing this, you can disable the :kconfig:option:`CONFIG_COMPILER_TRACK_MACRO_EXPANSION` option. This typically reduces the output to one message per error. -For example, to build :ref:`hello_world` with west and this option disabled, +For example, to build :zephyr:code-sample:`hello_world` with west and this option disabled, use: .. code-block:: sh diff --git a/doc/build/sysbuild/index.rst b/doc/build/sysbuild/index.rst index dae7c6ab30d..80c11ce2191 100644 --- a/doc/build/sysbuild/index.rst +++ b/doc/build/sysbuild/index.rst @@ -157,7 +157,7 @@ To handle this, sysbuild has namespaces for configuration variables. You can use namespaces to direct settings either to sysbuild itself or to a specific Zephyr application managed by sysbuild using the information in these sections. -The following example shows how to build :ref:`hello_world` with MCUboot enabled, +The following example shows how to build :zephyr:code-sample:`hello_world` with MCUboot enabled, applying to both images debug optimizations: .. tabs:: diff --git a/doc/develop/application/index.rst b/doc/develop/application/index.rst index fff35bb5e83..64d99dc0bcc 100644 --- a/doc/develop/application/index.rst +++ b/doc/develop/application/index.rst @@ -131,7 +131,7 @@ Zephyr repository application An application located within the ``zephyr`` source code repository in a Zephyr :ref:`west workspace ` is referred to as a Zephyr repository -application. In the following example, the :ref:`hello_world sample +application. In the following example, the :zephyr:code-sample:`hello_world sample ` is a Zephyr repository application: .. code-block:: none diff --git a/doc/develop/beyond-GSG.rst b/doc/develop/beyond-GSG.rst index cc5e770cd6a..42f1f6c5f38 100644 --- a/doc/develop/beyond-GSG.rst +++ b/doc/develop/beyond-GSG.rst @@ -286,7 +286,7 @@ To enable QEMU in Test Runner (Twister) on Windows, :ref:`set the environment variable ` ``QEMU_BIN_PATH`` to the path of QEMU installation folder. -For example, you can build and run the :ref:`hello_world` sample using +For example, you can build and run the :zephyr:code-sample:`hello_world` sample using the x86 emulation board configuration (``qemu_x86``), with: .. zephyr-app-commands:: diff --git a/doc/develop/getting_started/index.rst b/doc/develop/getting_started/index.rst index 0332c9879ec..34f21e427cd 100644 --- a/doc/develop/getting_started/index.rst +++ b/doc/develop/getting_started/index.rst @@ -402,7 +402,7 @@ Build the Blinky Sample :zephyr:code-sample:`blinky` is compatible with most, but not all, :ref:`boards`. If your board does not meet Blinky's :ref:`blinky-sample-requirements`, then - :ref:`hello_world` is a good alternative. + :zephyr:code-sample:`hello_world` is a good alternative. If you are unsure what name west uses for your board, ``west boards`` can be used to obtain a list of all boards Zephyr supports. diff --git a/doc/develop/west/build-flash-debug.rst b/doc/develop/west/build-flash-debug.rst index a7c19857dd3..36a4d5ddc51 100644 --- a/doc/develop/west/build-flash-debug.rst +++ b/doc/develop/west/build-flash-debug.rst @@ -145,7 +145,7 @@ Setting the Build System Target To specify the build system target to run, use ``--target`` (or ``-t``). For example, on host platforms with QEMU, you can use the ``run`` target to -build and run the :ref:`hello_world` sample for the emulated :ref:`qemu_x86 +build and run the :zephyr:code-sample:`hello_world` sample for the emulated :ref:`qemu_x86 ` board in one command:: west build -b qemu_x86 -t run samples/hello_world @@ -349,7 +349,7 @@ The ``-o`` option is described further in the previous section. Build a single domain --------------------- -In a multi-domain build with :ref:`hello_world` and `MCUboot`_, you can use +In a multi-domain build with :zephyr:code-sample:`hello_world` and `MCUboot`_, you can use ``--domain hello_world`` to only build this domain:: west build --sysbuild --domain hello_world @@ -543,7 +543,7 @@ will flash all domains in the order defined by sysbuild. It is possible to flash the image from a single domain in a multi-domain project by using ``--domain``. -For example, in a multi-domain build with :ref:`hello_world` and +For example, in a multi-domain build with :zephyr:code-sample:`hello_world` and `MCUboot`_, you can use the ``--domain hello_world`` domain to only flash only the image from this domain:: diff --git a/doc/develop/west/sign.rst b/doc/develop/west/sign.rst index 355682c032d..7de7bf7de1d 100644 --- a/doc/develop/west/sign.rst +++ b/doc/develop/west/sign.rst @@ -22,7 +22,7 @@ If you use this feature, you don't need to run ``west sign`` yourself; the build system will do it for you. Here is an example workflow, which builds and flashes MCUboot, as well as the -:ref:`hello_world` application for chain-loading by MCUboot. Run these commands +:zephyr:code-sample:`hello_world` application for chain-loading by MCUboot. Run these commands from the :file:`zephyrproject` workspace you created in the :ref:`getting_started`. diff --git a/doc/hardware/peripherals/can/shell.rst b/doc/hardware/peripherals/can/shell.rst index 0457203438d..9c0999b6e74 100644 --- a/doc/hardware/peripherals/can/shell.rst +++ b/doc/hardware/peripherals/can/shell.rst @@ -35,7 +35,7 @@ The following :ref:`Kconfig ` options enable additional subcommands and well. * :kconfig:option:`CONFIG_CAN_MANUAL_RECOVERY_MODE` enables the ``can recover`` subcommand. -For example, building the :ref:`hello_world` sample for the :ref:`frdm_k64f` with the CAN shell and +For example, building the :zephyr:code-sample:`hello_world` sample for the :ref:`frdm_k64f` with the CAN shell and CAN statistics enabled: .. zephyr-app-commands:: diff --git a/doc/hardware/peripherals/eeprom/shell.rst b/doc/hardware/peripherals/eeprom/shell.rst index b1b1535e8e4..2b4d1825732 100644 --- a/doc/hardware/peripherals/eeprom/shell.rst +++ b/doc/hardware/peripherals/eeprom/shell.rst @@ -21,7 +21,7 @@ In order to enable the EEPROM shell, the following :ref:`Kconfig ` opti * :kconfig:option:`CONFIG_EEPROM` * :kconfig:option:`CONFIG_EEPROM_SHELL` -For example, building the :ref:`hello_world` sample for the :ref:`native_sim` with the EEPROM shell: +For example, building the :zephyr:code-sample:`hello_world` sample for the :ref:`native_sim` with the EEPROM shell: .. zephyr-app-commands:: :zephyr-app: samples/hello_world diff --git a/samples/hello_world/README.rst b/samples/hello_world/README.rst index ce5423d6f04..25b346e90f9 100644 --- a/samples/hello_world/README.rst +++ b/samples/hello_world/README.rst @@ -1,4 +1,7 @@ -.. _hello_world: +.. zephyr:code-sample:: hello_world + :name: Hello World + + Print "Hello World" to the console. Hello World ########### diff --git a/samples/subsys/usb/dfu/README.rst b/samples/subsys/usb/dfu/README.rst index 9fe9fd03ea2..44b173184a5 100644 --- a/samples/subsys/usb/dfu/README.rst +++ b/samples/subsys/usb/dfu/README.rst @@ -46,7 +46,7 @@ Build and flash MCUboot bootloader for Zephyr project as it is described in the `Using MCUboot with Zephyr`_ documentation. Then build, sign and flash the USB DFU sample at the offset of SLOT-0. -Build and sign a second application image e.g. :ref:`hello_world`, +Build and sign a second application image e.g. :zephyr:code-sample:`hello_world`, which will be used as an image for the update. Do not forget to enable the required :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT` option (as described in :ref:`mcuboot`). For example: