From 6238459dd77487bcac244ca5360932b9043584c3 Mon Sep 17 00:00:00 2001 From: Anuj Deshpande Date: Mon, 7 May 2018 12:24:20 +0530 Subject: [PATCH] docs: Fix broken link in nvs and jtag example - Closes https://github.com/espressif/esp-idf/issues/1922 --- examples/storage/nvs_rw_blob/README.md | 2 +- examples/storage/nvs_rw_value/README.md | 2 +- examples/system/app_trace_to_host/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/storage/nvs_rw_blob/README.md b/examples/storage/nvs_rw_blob/README.md index b39c28903..8fe7f30d8 100644 --- a/examples/storage/nvs_rw_blob/README.md +++ b/examples/storage/nvs_rw_blob/README.md @@ -9,6 +9,6 @@ Example also shows how to implement diagnostics if read / write operation was su If not done already, consider checking simpler example *storage/nvs_rw_value*, that has been used as a starting point for preparing this one. -Detailed functional description of NVS and API is provided in [documentation](https://esp-idf.readthedocs.io/en/latest/api-reference/nvs_flash.html). +Detailed functional description of NVS and API is provided in [documentation](https://esp-idf.readthedocs.io/en/latest/api-reference/storage/nvs_flash.html). See the README.md file in the upper level 'examples' directory for more information about examples. diff --git a/examples/storage/nvs_rw_value/README.md b/examples/storage/nvs_rw_value/README.md index eec9f3163..4cdee4a40 100644 --- a/examples/storage/nvs_rw_value/README.md +++ b/examples/storage/nvs_rw_value/README.md @@ -8,6 +8,6 @@ Example also shows how to check if read / write operation was successful, or cer Check another example *storage/nvs_rw_blob*, that shows how to read and write variable length binary data (blob). -Detailed functional description of NVS and API is provided in [documentation](https://esp-idf.readthedocs.io/en/latest/api-reference/nvs_flash.html). +Detailed functional description of NVS and API is provided in [documentation](https://esp-idf.readthedocs.io/en/latest/api-reference/storage/nvs_flash.html). See the README.md file in the upper level 'examples' directory for more information about examples. diff --git a/examples/system/app_trace_to_host/README.md b/examples/system/app_trace_to_host/README.md index d88371af8..c7955ceb8 100644 --- a/examples/system/app_trace_to_host/README.md +++ b/examples/system/app_trace_to_host/README.md @@ -87,7 +87,7 @@ To run the example and retrieve the log from the host, do the following: 1. Connect JTAG interface to ESP32 board, power up both JTAG and ESP32. For details how to setup JTAG interface see [JTAG Debugging](https://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html). -2. [Run OpenOCD](https://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html#run-openocd). If you are using the [binary distribution of OpenOCD](https://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html#jtag-debugging-setup-openocd) and one of versions of [ESP-WROVER-KIT](https://esp-idf.readthedocs.io/en/latest/hw-reference/modules-and-boards.html#esp32-wrover-kit-v1-esp32-devkitj-v1), respective command line will look as follows: +2. [Run OpenOCD](https://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html#run-openocd). If you are using the [binary distribution of OpenOCD](https://esp-idf.readthedocs.io/en/latest/api-guides/jtag-debugging/index.html#jtag-debugging-setup-openocd) and one of versions of [ESP-WROVER-KIT](https://esp-idf.readthedocs.io/en/latest/hw-reference/modules-and-boards.html#esp-wrover-kit-v3), respective command line will look as follows: ``` cd ~/esp/openocd-esp32