Skip to content
Permalink
Browse files

doc: Cleanup references to cmake

Clean up some stray references to cmake in doc, boards and
samples that don't make explicit use of the zephyr app extension,
as well as other minor doc fixes.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
  • Loading branch information...
carlescufi authored and andrewboie committed Jun 13, 2019
1 parent 2670cd4 commit b4766436951c0a3c359aafaff2818216c5f17c13
@@ -235,11 +235,12 @@ the `OpenSDA J-Link Generic Firmware for V3.2 Bootloader`_. Note that Segger
does provide an OpenSDA J-Link Board-Specific Firmware for this board, however
it is not compatible with the DAPLink bootloader.

Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``cmake`` or ``west
build`` to override the default runner from pyOCD to J-Link:
Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``west build`` or
``cmake`` to override the default runner from pyOCD to J-Link:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: all
:board: frdm_k64f
:gen-args: -DOPENSDA_FW=jlink
:goals: build
@@ -149,11 +149,12 @@ path.
Follow the instructions in :ref:`opensda-jlink-onboard-debug-probe` to program
the `OpenSDA J-Link FRDM-KL25Z Firmware`_.

Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``cmake`` or ``west
build`` to override the default runner from pyOCD to J-Link:
Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``west build`` or
``cmake`` to override the default runner from pyOCD to J-Link:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: all
:board: frdm_kl25z
:gen-args: -DOPENSDA_FW=jlink
:goals: build
@@ -168,11 +168,12 @@ path.
Follow the instructions in :ref:`opensda-jlink-onboard-debug-probe` to program
the `OpenSDA J-Link FRDM-KW41Z Firmware`_.

Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``cmake`` or ``west
build`` to override the default runner from pyOCD to J-Link:
Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``west build`` or
``cmake`` to override the default runner from pyOCD to J-Link:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: all
:board: frdm_kw41z
:gen-args: -DOPENSDA_FW=jlink
:goals: build
@@ -189,11 +189,12 @@ program the `OpenSDA DAPLink Hexiwear Firmware`_. Check that switches SW1 and
SW2 are **on**, and SW3 and SW4 are **off** to ensure K64F SWD signals are
connected to the OpenSDA microcontroller.

Add the argument ``-DOPENSDA_FW=daplink`` when you invoke ``cmake`` or ``west
build`` to override the default runner from J-Link to pyOCD:
Add the argument ``-DOPENSDA_FW=daplink`` when you invoke ``west build`` or
``cmake`` to override the default runner from J-Link to pyOCD:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: all
:board: hexiwear_k64
:gen-args: -DOPENSDA_FW=daplink
:goals: build
@@ -260,17 +260,11 @@ install `stm32mp1 developer package`_.

2) run gdb in Zephyr environment

.. code-block:: console

# On Linux
cd $ZEPHYR_BASE/samples/hello_world
mkdir -p build && cd build

# Use cmake to configure a Ninja-based build system:
cmake -GNinja -DBOARD=stm32mp157_dk2 ..

# Now run ninja on the generated build system:
ninja debug
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: all
:board: stm32mp157_dk2
:goals: debug

.. _STM32P157C Discovery website:
https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-discovery-kits/stm32mp157c-dk2.html
@@ -291,4 +285,4 @@ install `stm32mp1 developer package`_.
https://wiki.st.com/stm32mpu/index.php/STM32MP1_Developer_Package#Installing_the_SDK

.. _stm32mp157c boot Cortex-M4 firmware:
https://wiki.st.com/stm32mpu/index.php/Linux_remoteproc_framework_overview#How_to_use_the_framework
https://wiki.st.com/stm32mpu/index.php/Linux_remoteproc_framework_overview#How_to_use_the_framework
@@ -155,11 +155,12 @@ path.
Follow the instructions in :ref:`opensda-jlink-onboard-debug-probe` to program
the `OpenSDA J-Link Firmware for TWR-KE18F`_.

Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``cmake`` or ``west
build`` to override the default runner from pyOCD to J-Link:
Add the argument ``-DOPENSDA_FW=jlink`` when you invoke ``west build`` or
``cmake`` to override the default runner from pyOCD to J-Link:

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: all
:board: twr_ke18f
:gen-args: -DOPENSDA_FW=jlink
:goals: build
@@ -160,15 +160,15 @@ Run the zephyr.exe executable as you would any other Linux console application.

.. code-block:: console

$ zephyr/zephyr.exe
$ ./build/zephyr/zephyr.exe
# Press Ctrl+C to exit

This executable accepts several command line options depending on the
compilation configuration.
You can run it with the ``--help`` command line switch to get a list of
available options::

$ zephyr/zephyr.exe --help
$ ./build/zephyr/zephyr.exe --help

Note that the Zephyr kernel does not actually exit once the application is
finished. It simply goes into the idle loop forever.
@@ -202,7 +202,7 @@ Address Sanitizer (ASan)

You can also build Zephyr with `Address Sanitizer`_. To do this, set
:option:`CONFIG_ASAN`, for example, in the application project file, or in the
cmake command line invocation.
``west build`` or ``cmake`` command line invocation.

Note that you will need the ASan library installed in your system.
In Debian/Ubuntu this is ``libasan1``.
@@ -85,7 +85,7 @@ Then you can execute your application using:

.. code-block:: console

$ zephyr/zephyr.exe -nosim
$ ./build/zephyr/zephyr.exe -nosim
# Press Ctrl+C to exit

Note that the executable is a BabbleSim executable. The ``-nosim`` command line
@@ -110,7 +110,7 @@ executable to the simulator bin folder with a sensible name:

.. code-block:: console

$ cp zephyr/zephyr.exe \
$ cp build/zephyr/zephyr.exe \
${BSIM_OUT_PATH}/bin/bs_nrf52_bsim_samples_bluetooth_central_hr

Do the same for the ``peripheral`` sample app:
@@ -124,7 +124,7 @@ Do the same for the ``peripheral`` sample app:

.. code-block:: console

$ cp zephyr/zephyr.exe \
$ cp build/zephyr/zephyr.exe \
${BSIM_OUT_PATH}/bin/bs_nrf52_bsim_samples_bluetooth_peripheral

And then run them together with BabbleSim's 2G4 physical layer simulation:
@@ -555,14 +555,14 @@ Linux and macOS (run this in a terminal from the Zephyr directory)::

# Set up environment and create build directory:
source zephyr-env.sh
cd samples/hello_world
mkdir build && cd build

# Use CMake to generate a Ninja-based build system:
cmake -GNinja -DBOARD=rv32m1_vega_ri5cy -DCMAKE_REQUIRED_FLAGS=-Wl,-dT=/dev/null ..

# Build the sample
ninja
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:tool: cmake
:cd-into:
:board: rv32m1_vega_ri5cy
:gen-args: -DCMAKE_REQUIRED_FLAGS=-Wl,-dT=/dev/null
:goals: build

Windows (run this in a ``cmd`` prompt, from the Zephyr directory)::

@@ -53,11 +53,12 @@ host controller interface (HCI):
#. Attach the FRDM-KW41Z to the Arduino header on your selected main board,
such as :ref:`mimxrt1050_evk` or :ref:`frdm_k64f`.

#. Set ``-DSHIELD=frdm_kw41z`` when you invoke cmake in your Zephyr bluetooth
application. For example,
#. Set ``-DSHIELD=frdm_kw41z`` when you invoke ``west build`` or ``cmake`` in
your Zephyr bluetooth application. For example,

.. zephyr-app-commands::
:zephyr-app: samples/bluetooth/peripheral_hr
:tool: all
:board: frdm_k64f
:shield: frdm_kw41z
:goals: build

0 comments on commit b476643

Please sign in to comment.
You can’t perform that action at this time.