From 8ce4fd1170aaae27e06367c7f0f4e2126e972fa7 Mon Sep 17 00:00:00 2001 From: Kalil Cabral Date: Fri, 10 Jan 2020 15:09:19 -0300 Subject: [PATCH 1/3] fixed docker instructions to prevent issues with permissions --- doc/quick-start/qs-guide.rst | 6 +++--- doc/thing/thing-docker.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/quick-start/qs-guide.rst b/doc/quick-start/qs-guide.rst index 3f6d5a4..b72e961 100644 --- a/doc/quick-start/qs-guide.rst +++ b/doc/quick-start/qs-guide.rst @@ -130,13 +130,13 @@ Compiling project .. code-block:: bash - [user@container] $ knot make --board dk + [user@container] $ sudo -E knot make --board dk - If using the `KNoT Dongle `_: .. code-block:: bash - [user@container] $ knot make --board dongle + [user@container] $ sudo -E knot make --board dongle Flashing board @@ -146,7 +146,7 @@ Flashing board .. code-block:: bash - [user@container] $ knot export output/ + [user@container] $ sudo -E knot export output/ #. Install `nRF Connect `_. diff --git a/doc/thing/thing-docker.rst b/doc/thing/thing-docker.rst index d267f14..4a066aa 100644 --- a/doc/thing/thing-docker.rst +++ b/doc/thing/thing-docker.rst @@ -44,7 +44,7 @@ Compile for your target board .. code-block:: bash - container> $ knot make -b {BOARD} + container> $ sudo -E knot make -b {BOARD} .. note:: Currently, KNoT support ``dk`` (nrf52840_pca10056) or ``dongle`` (nrf52840_pca10059) board. Replace {BOARD} with one of them. @@ -64,7 +64,7 @@ Export the generated files to your project's directory .. code-block:: bash - container> $ knot export /workdir/output + container> $ sudo -E knot export /workdir/output The generated files can now be flashed to your device by using the `nRF Connect for Desktop `_ and its @@ -100,7 +100,7 @@ This will allow you to use the `--flash` flag to flash after building the projec .. code-block:: bash - container> $ knot make -b {BOARD} --mcuboot + container> $ sudo -E knot make -b {BOARD} --mcuboot .. note:: Currently, KNoT support ``dk`` (nrf52840_pca10056) or ``dongle`` (nrf52840_pca10059) board. Replace {BOARD} with one of them. From feefce49736c3bf4e0fc3bb0ea1caf7181d82559 Mon Sep 17 00:00:00 2001 From: Kalil Cabral Date: Fri, 10 Jan 2020 15:10:14 -0300 Subject: [PATCH 2/3] made prompt format consistent with quickstart --- doc/thing/thing-docker.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/thing/thing-docker.rst b/doc/thing/thing-docker.rst index 4a066aa..655fbe7 100644 --- a/doc/thing/thing-docker.rst +++ b/doc/thing/thing-docker.rst @@ -44,7 +44,7 @@ Compile for your target board .. code-block:: bash - container> $ sudo -E knot make -b {BOARD} + [user@container] $ sudo -E knot make -b {BOARD} .. note:: Currently, KNoT support ``dk`` (nrf52840_pca10056) or ``dongle`` (nrf52840_pca10059) board. Replace {BOARD} with one of them. @@ -64,7 +64,7 @@ Export the generated files to your project's directory .. code-block:: bash - container> $ sudo -E knot export /workdir/output + [user@container] $ sudo -E knot export /workdir/output The generated files can now be flashed to your device by using the `nRF Connect for Desktop `_ and its @@ -100,7 +100,7 @@ This will allow you to use the `--flash` flag to flash after building the projec .. code-block:: bash - container> $ sudo -E knot make -b {BOARD} --mcuboot + [user@container] $ sudo -E knot make -b {BOARD} --mcuboot .. note:: Currently, KNoT support ``dk`` (nrf52840_pca10056) or ``dongle`` (nrf52840_pca10059) board. Replace {BOARD} with one of them. @@ -115,6 +115,6 @@ To get a list of all available commands, run: .. code-block:: bash - container> $ knot --help + [user@container] $ knot --help More info is available at the `Thing CLI doc section `_. From 18dfe04ddb569d28b00f179a65167156317f4f1a Mon Sep 17 00:00:00 2001 From: Kalil Cabral Date: Fri, 10 Jan 2020 15:11:14 -0300 Subject: [PATCH 3/3] made section about compiling with docker clearer --- doc/thing/thing-docker.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/thing/thing-docker.rst b/doc/thing/thing-docker.rst index 655fbe7..07299c5 100644 --- a/doc/thing/thing-docker.rst +++ b/doc/thing/thing-docker.rst @@ -42,6 +42,8 @@ by the tag you used. Compile for your target board ----------------------------- +Inside the docker container, use the KNoT script to compile your project. + .. code-block:: bash [user@container] $ sudo -E knot make -b {BOARD}