boards: Use zephyr_file for file links

Replaces normal text with :zephyr_file: blocks Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
1 year ago · a9902ff58e
20 changed files with 29 additions and 38 deletions
--- a/boards/96boards/96b_nitrogen/doc/index.rst
+++ b/boards/96boards/96b_nitrogen/doc/index.rst
@ -75,9 +75,8 @@ Other hardware features have not been enabled yet for this board.
 See `Nordic Semiconductor Infocenter`_ for a complete list of nRF52-based
 board hardware features.
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/96boards/96b_nitrogen/96b_nitrogen_defconfig`
        ``boards/96boards/96b_nitrogen/96b_nitrogen_defconfig``
 Pin Mapping
 ===========
--- a/boards/arm/v2m_musca_b1/doc/index.rst
+++ b/boards/arm/v2m_musca_b1/doc/index.rst
@ -98,7 +98,7 @@ See the `V2M Musca B1 Website`_ for a complete list of V2M Musca board hardware
 features.
 The default configuration can be found in the defconfig file:
-``boards/arm/v2m_musca_b1/v2m_musca_b1_defconfig``.
+:zephyr_file:`boards/arm/v2m_musca_b1/v2m_musca_b1_defconfig`.
 Interrupt Controller
 ====================
--- a/boards/arm/v2m_musca_s1/doc/index.rst
+++ b/boards/arm/v2m_musca_s1/doc/index.rst
@ -95,7 +95,7 @@ See the `V2M Musca-S1 Website`_ for a complete list of V2M Musca-S1 board
 hardware features.
 The default configuration can be found in the defconfig file:
-``boards/arm/v2m_musca_s1/v2m_musca_s1_defconfig``.
+:zephyr_file:`boards/arm/v2m_musca_s1/v2m_musca_s1_defconfig`.
 Interrupt Controller
 ====================
--- a/boards/atmel/sam0/samc21n_xpro/doc/index.rst
+++ b/boards/atmel/sam0/samc21n_xpro/doc/index.rst
@ -78,7 +78,7 @@ features:
 Other hardware features are not currently supported by Zephyr.
 The default configuration can be found in the Kconfig
-``boards/atmel/sam0/samc21n_xpro/samc21n_xpro_defconfig``.
+:zephyr_file:`boards/atmel/sam0/samc21n_xpro/samc21n_xpro_defconfig`.
 Pin Mapping
 ===========
--- a/boards/atmel/sam0/samd21_xpro/doc/index.rst
+++ b/boards/atmel/sam0/samd21_xpro/doc/index.rst
@ -79,7 +79,7 @@ features:
 Other hardware features are not currently supported by Zephyr.
 The default configuration can be found in the Kconfig
-``boards/atmel/sam0/samd21_xpro/samd21_xpro_defconfig``.
+:zephyr_file:`boards/atmel/sam0/samd21_xpro/samd21_xpro_defconfig`.
 Pin Mapping
 ===========
--- a/boards/atmel/sam0/same54_xpro/doc/index.rst
+++ b/boards/atmel/sam0/same54_xpro/doc/index.rst
@ -97,7 +97,7 @@ features:
 Other hardware features are not currently supported by Zephyr.
 The default configuration can be found in the Kconfig
-``boards/atmel/sam0/same54_xpro/same54_xpro_defconfig``.
+:zephyr_file:`boards/atmel/sam0/same54_xpro/same54_xpro_defconfig`.
 Pin Mapping
 ===========
--- a/boards/atmel/sam0/saml21_xpro/doc/index.rst
+++ b/boards/atmel/sam0/saml21_xpro/doc/index.rst
@ -73,7 +73,7 @@ features:
 Other hardware features are not currently supported by Zephyr.
 The default configuration can be found in the Kconfig
-``boards/atmel/sam0/saml21_xpro/saml21_xpro_defconfig``.
+:zephyr_file:`boards/atmel/sam0/saml21_xpro/saml21_xpro_defconfig`.
 Pin Mapping
 ===========
--- a/boards/atmel/sam0/samr21_xpro/doc/index.rst
+++ b/boards/atmel/sam0/samr21_xpro/doc/index.rst
@ -56,7 +56,7 @@ features:
 Other hardware features are not currently supported by Zephyr.
 The default configuration can be found in the Kconfig
-``boards/atmel/sam0/samr21_xpro/samr21_xpro_defconfig``.
+:zephyr_file:`boards/atmel/sam0/samr21_xpro/samr21_xpro_defconfig`.
 Pin Mapping
 ===========
--- a/boards/atmel/sam0/samr34_xpro/doc/index.rst
+++ b/boards/atmel/sam0/samr34_xpro/doc/index.rst
@ -91,7 +91,7 @@ supported by the SOC:
 Other hardware features are not currently supported by Zephyr.
 The default configuration can be found in the Kconfig
-``boards/atmel/sam0/samr34_xpro/samr34_xpro_defconfig``.
+:zephyr_file:`boards/atmel/sam0/samr34_xpro/samr34_xpro_defconfig`.
 Pin Mapping
 ===========
--- a/boards/intel/intel_socfpga/agilex_socdk/doc/index.rst
+++ b/boards/intel/intel_socfpga/agilex_socdk/doc/index.rst
@ -40,9 +40,8 @@ hardware features:
 Other hardware features have not been enabled yet for this board.
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/intel/intel_socfpga/agilex_socdk/intel_socfpga_agilex_socdk_defconfig`
        ``boards/intel/intel_socfpga/agilex_socdk/intel_socfpga_agilex_socdk_defconfig``
 Programming and Debugging
 *************************
--- a/boards/intel/intel_socfpga_std/cyclonev_socdk/doc/index.rst
+++ b/boards/intel/intel_socfpga_std/cyclonev_socdk/doc/index.rst
@ -169,7 +169,7 @@ application.
 ``Important!!!`` : Before flashing the board a ``preloader`` is required,
 you can download `cv_soc_devkit_ghrd.tar.gz <https://releases.rocketboards.org/release/2018.05/gsrd/hw/cv_soc_devkit_ghrd.tar.gz>`_,
 extract the file and copy ``cv_soc_devkit_ghrd/software/preloader/uboot-socfpga/spl/u-boot-spl``
-to ``boards/intel/intel_socfpga_std/cyclonev_socdk/support/``
+to :zephyr_file:`boards/intel/intel_socfpga_std/cyclonev_socdk/support/`
 .. zephyr-app-commands::
   :zephyr-app: samples/hello_world
--- a/boards/nxp/frdm_k64f/doc/index.rst
+++ b/boards/nxp/frdm_k64f/doc/index.rst
@ -111,9 +111,8 @@ configuration supports the following hardware features:
 | FTFE      | on-chip    | flash programming                   |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/nxp/frdm_k64f/frdm_k64f_defconfig`
 	``boards/nxp/frdm_k64f/frdm_k64f_defconfig``
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/frdm_k82f/doc/index.rst
+++ b/boards/nxp/frdm_k82f/doc/index.rst
@ -105,9 +105,8 @@ already supported, which can also be re-used on this frdm_k82f board:
 | FTFA      | on-chip    | flash programming                   |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/nxp/frdm_k82f/frdm_k82f_defconfig`
 	``boards/nxp/frdm_k82f/frdm_k82f_defconfig``
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/frdm_kl25z/doc/index.rst
+++ b/boards/nxp/frdm_kl25z/doc/index.rst
@ -63,9 +63,8 @@ The frdm_kl25z board configuration supports the following hardware features:
 | USB       | on-chip    | USB device                          |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/nxp/frdm_kl25z/frdm_kl25z_defconfig`
 	``boards/nxp/frdm_kl25z/frdm_kl25z_defconfig``
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/frdm_kw41z/doc/index.rst
+++ b/boards/nxp/frdm_kw41z/doc/index.rst
@ -88,9 +88,8 @@ The frdm_kw41z board configuration supports the following hardware features:
 | FTFA      | on-chip    | flash programming                   |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/nxp/frdm_kw41z/frdm_kw41z_defconfig`
 	``boards/nxp/frdm_kw41z/frdm_kw41z_defconfig``
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/rddrone_fmuk66/doc/index.rst
+++ b/boards/nxp/rddrone_fmuk66/doc/index.rst
@ -84,9 +84,8 @@ The rddrone-fmuk66 board configuration supports the following hardware features:
 | DMA       | on-chip    | dma                                 |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/nxp/rddrone_fmuk66/rddrone_fmuk66_defconfig`
 	``boards/nxp/rddrone_fmuk66/rddrone_fmuk66_defconfig``
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/twr_ke18f/doc/index.rst
+++ b/boards/nxp/twr_ke18f/doc/index.rst
@ -89,7 +89,7 @@ features:
 +-----------+------------+-------------------------------------+
 The default configuration can be found in the defconfig file:
-``boards/nxp/twr_ke18f/twr_ke18f_defconfig``.
+:zephyr_file:`boards/nxp/twr_ke18f/twr_ke18f_defconfig`.
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/twr_kv58f220m/doc/index.rst
+++ b/boards/nxp/twr_kv58f220m/doc/index.rst
@ -73,7 +73,7 @@ features:
 +-----------+------------+-------------------------------------+
 The default configuration can be found in the defconfig file:
-``boards/nxp/twr_kv58f220m/twr_kv58f220m_defconfig``.
+:zephyr_file:`boards/nxp/twr_kv58f220m/twr_kv58f220m_defconfig`.
 Other hardware features are not currently supported by the port.
--- a/boards/nxp/usb_kw24d512/doc/index.rst
+++ b/boards/nxp/usb_kw24d512/doc/index.rst
@ -68,9 +68,8 @@ The USB-KW24D512 board configuration supports the following hardware features:
 | FTFL      | on-chip    | flash programming                   |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/nxp/usb_kw24d512/usb_kw24d512_defconfig`
 	``boards/nxp/usb_kw24d512/usb_kw24d512_defconfig``
 Other hardware features are not currently supported by the port.
--- a/boards/segger/ip_k66f/doc/index.rst
+++ b/boards/segger/ip_k66f/doc/index.rst
@ -59,9 +59,8 @@ The ip_k66f board configuration supports the following hardware features:
 | RTC       | on-chip    | rtc                                 |
 +-----------+------------+-------------------------------------+
-The default configuration can be found in the defconfig file:
+The default configuration can be found in
-
+:zephyr_file:`boards/segger/ip_k66f/ip_k66f_defconfig`
 	``boards/segger/ip_k66f/ip_k66f_defconfig``
 Micrel/Microchip KSZ8794CNX Ethernet Switch is not currently
 supported.