From 397edd1e01c0f2f7b106673d1433f7a9a98963f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Tue, 12 Oct 2021 10:06:44 -0700 Subject: [PATCH] doc: autopts-linux: fix GSG reference MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Commit 3f6737f6886880f4fe4245d7aa8f30a2e11f3f51 ("doc: autopts: Remove duplication of getting started guide") removed duplicated text by linking to the getting started guide. However, the link format is not correct. It is using a link to the latest upstream Zephyr getting started guide. This has two problems: 1. It will link to the wrong document when the autopts guide is part of an official release documentation. For example, the Zephyr 3.0 release documentation HTML page for these docs will be linking to the main branch GSG, not the v3.0 getting started guide. This combination will not be correct in general because dependencies change. 2. It breaks downstream distributions which bundle their own versions of the Zephyr documentation as well, for similar reasons. The two documents are part of the same Sphinx docset, so the right way to do this is with :ref. Fix it. Signed-off-by: Martí Bolívar --- doc/guides/bluetooth/autopts/autopts-linux.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/guides/bluetooth/autopts/autopts-linux.rst b/doc/guides/bluetooth/autopts/autopts-linux.rst index 67b21a8ef8f..8b1abf9813c 100644 --- a/doc/guides/bluetooth/autopts/autopts-linux.rst +++ b/doc/guides/bluetooth/autopts/autopts-linux.rst @@ -9,6 +9,9 @@ Overview This tutorial shows how to setup AutoPTS client on Linux with AutoPTS server running on Windows 10 virtual machine. Tested with Ubuntu 20.4 and Linux Mint 20.4. +You must have a Zephyr development environment set up. See +:ref:`getting_started` for details. + Supported methods to test zephyr bluetooth host: - Testing Zephyr Host Stack on QEMU @@ -23,11 +26,6 @@ For running with QEMU or native posix, please visit: Setup Linux =========================== -Setup Zephyr project ---------------------- - -Do the setup from `Getting Started Guide `_. - Install nrftools (only required in the actual hardware test mode) =================================================================